连接类型 API

• RegisterConnectionType 操作（Python：register_connection_type）

• DeleteConnectionType 操作（Python：delete_connection_type）

• DescribeConnectionType 操作（Python：describe_connection_type）

• ListConnectionTypes 操作（Python：list_connection_types）

• ConnectionTypeBrief 结构

• ConnectionTypeVariant 结构

请求

• ConnectionType – 必填：UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 Single-line string pattern 匹配。

  连接类型的名称。必须介于 1 到 255 个字符之间，并且必须以“REST-”为前缀，以表示它是基于 REST 的 connector。

• IntegrationType – 必填：UTF-8 字符串（有效值：REST）。

  连接的集成类型。目前仅支持“REST”协议。

• Description – UTF-8 字符串，长度不超过 1024 个字节。

  连接类型的描述。最多可包含 2048 个字符，并提供有关连接类型的目的和功能的详细信息。

• ConnectionProperties – 必填：一个 ConnectionPropertiesConfiguration 对象。

  定义在此连接类型的连接创建期间所需的基本 URL 和其他请求参数。

• ConnectorAuthenticationConfiguration – 必填：一个 ConnectorAuthenticationConfiguration 对象。

  定义此连接类型支持的身份验证类型和必需属性，包括基本身份验证、OAuth2 和自定义身份验证方法。

• RestConfiguration – 必填：一个 RestConfiguration 对象。

  定义 REST API 交互的 HTTP 请求和响应配置、验证端点和实体配置。

• Tags – 键值对的映射数组，不超过 50 对。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值是一个 UTF-8 字符串，不超过 256 个字节。

  您分配给连接类型的标签。

响应

包含新注册的连接类型的 Amazon 资源名称（ARN）。

• ConnectionTypeArn – UTF-8 字符串，长度不少于 1 个字节或超过 10240 个字节，与 Custom string pattern #47 匹配。

  已注册连接类型的 Amazon 资源名称（ARN）。此唯一标识符可用于在其他 AWS Glue 操作中引用该连接类型。

错误

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• InternalServiceException

请求

• ConnectionType – 必填：UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 Single-line string pattern 匹配。

  要删除的连接类型的名称。必须引用现有的已注册连接类型。

响应

• 无响应参数。

错误

• EntityNotFoundException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• AccessDeniedException

请求

• ConnectionType – 必填：UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 Single-line string pattern 匹配。

  要描述的连接类型的名称。

响应

• ConnectionType – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 Single-line string pattern 匹配。

  连接类型的名称。

• Description – UTF-8 字符串，长度不超过 1024 个字节。

  连接类型的描述。

• Capabilities – 一个 功能 对象。

  connector 支持的身份验证类型、数据接口类型（计算环境）以及数据操作。

• ConnectionProperties – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 属性 对象。

  跨计算环境的通用连接属性。

• ConnectionOptions – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 属性 对象。

  返回在 ConnectionInput.ConnectionProperties 中创建连接时可以设置的属性。ConnectionOptions 定义可以在传递给 DataFrame 的连接选项映射中的 Spark ETL 脚本中设置的参数。

• AuthenticationConfiguration – 一个 AuthConfiguration 对象。

  用于连接的身份验证类型。

• ComputeEnvironmentConfigurations – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 ComputeEnvironmentConfiguration 对象。

  连接支持的计算环境。

• PhysicalConnectionRequirements – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 属性 对象。

  连接的物理要求，如 VPC、子网和安全组规范。

• AthenaConnectionProperties – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 属性 对象。

  特定于 Athena 计算环境的连接属性。

• PythonConnectionProperties – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 属性 对象。

  特定于 Python 计算环境的连接属性。

• SparkConnectionProperties – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 属性 对象。

  特定于 Spark 计算环境的连接属性。

• RestConfiguration – 一个 RestConfiguration 对象。

  基于 REST 的数据来源的 HTTP 请求和响应配置、验证端点和实体配置。

错误

• ValidationException

• InvalidInputException

• InternalServiceException

请求

• MaxResults – 数字（整数），不小于 1 或大于 1000。

  要返回的最大结果数量。

• NextToken – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 Custom string pattern #11 匹配。

  延续标记 (如果这是延续调用)。

响应

• ConnectionTypes – ConnectionTypeBrief 对象的数组。

  ConnectionTypeBrief 对象列表，包含有关支持的连接类型的简要信息。

• NextToken – UTF-8 字符串，不少于 1 个字节或超过 2048 个字节，与 Custom string pattern #11 匹配。

  延续令牌（如果当前列表片段不是最后一个片段）。

错误

• InternalServiceException

字段

• ConnectionType – UTF-8 字符串（有效值：JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA | GOOGLEADS | GOOGLESHEETS | GOOGLEANALYTICS4 | SERVICENOW | MARKETO | SAPODATA | ZENDESK | JIRACLOUD | NETSUITEERP | HUBSPOT | FACEBOOKADS | INSTAGRAMADS | ZOHOCRM | SALESFORCEPARDOT | SALESFORCEMARKETINGCLOUD | ADOBEANALYTICS | SLACK | LINKEDIN | MIXPANEL | ASANA | STRIPE | SMARTSHEET | DATADOG | WOOCOMMERCE | INTERCOM | SNAPCHATADS | PAYPAL | QUICKBOOKS | FACEBOOKPAGEINSIGHTS | FRESHDESK | TWILIO | DOCUSIGNMONITOR | FRESHSALES | ZOOM | GOOGLESEARCHCONSOLE | SALESFORCECOMMERCECLOUD | SAPCONCUR | DYNATRACE | MICROSOFTDYNAMIC365FINANCEANDOPS | MICROSOFTTEAMS | BLACKBAUDRAISEREDGENXT | MAILCHIMP | GITLAB | PENDO | PRODUCTBOARD | CIRCLECI | PIPEDIVE | SENDGRID | AZURECOSMOS | AZURESQL | BIGQUERY | BLACKBAUD | CLOUDERAHIVE | CLOUDERAIMPALA | CLOUDWATCH | CLOUDWATCHMETRICS | CMDB | DATALAKEGEN2 | DB2 | DB2AS400 | DOCUMENTDB | DOMO | DYNAMODB | GOOGLECLOUDSTORAGE | HBASE | KUSTOMER | MICROSOFTDYNAMICS365CRM | MONDAY | MYSQL | OKTA | OPENSEARCH | ORACLE | PIPEDRIVE | POSTGRESQL | SAPHANA | SQLSERVER | SYNAPSE | TERADATA | TERADATANOS | TIMESTREAM | TPCDS | VERTICA）。

  连接类型的名称。

• DisplayName – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  AWS Glue 控制台中显示的连接类型的人类可读名称。

• Vendor – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  创建或维护此连接类型的供应商或者提供商的名称。

• Description – UTF-8 字符串，长度不超过 1024 个字节。

  连接类型的描述。

• Categories – UTF-8 字符串数组。

  此连接类型所属的类别列表。类别可帮助用户根据其用例筛选并找到合适的连接类型。

• Capabilities – 一个 功能 对象。

  connector 支持的身份验证类型、数据接口类型（计算环境）以及数据操作。

• LogoUrl – UTF-8 字符串。

  与连接类型相关联的徽标的 URL。

• ConnectionTypeVariants – ConnectionTypeVariant 对象的数组。

  此连接类型可用的变体列表。不同的变体可能会为特定用例或相同通用连接类型的实现提供专门的配置。

字段

• ConnectionTypeVariantName – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  连接类型变体的唯一标识符。此名称在内部用于标识连接类型的特定变体。

• DisplayName – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  AWS Glue 控制台中显示的连接类型变体的人类可读名称。

• Description – UTF-8 字符串，长度不超过 1024 个字节。

  连接类型变体的详细描述，包括其用途、用例和任何特定的配置要求。

• LogoUrl – UTF-8 字符串。

  与连接类型变体关联的徽标的 URL。

• 验证结构

• AuthConfiguration 结构

• 功能结构

• 属性结构

• AllowedValue 结构

• ComputeEnvironmentConfiguration 结构

字段

• ValidationType – 必填：UTF-8 字符串（有效值：REGEX | RANGE）。

  要执行的验证类型，例如 REGEX。

• Patterns – UTF-8 字符串数组。

  适用于验证的模式列表。

• Description – 必填项：UTF-8 字符串，长度不少于 1 个字节，不超过 1024 个字节。

  验证的描述。

• MaxLength – 数字（整数）。

  字符串连接属性的最大长度。

• Maximum – 数字（整数）。

  指定 RANGE 类型验证时的最大值。

• Minimum – 数字（整数）。

  指定 RANGE 类型验证时的最小值。

字段

• AuthenticationType – 必填：一个 属性 对象。

  连接的身份验证类型。

• SecretArn – 一个 属性 对象。

  Secrets Manager 的 Amazon 资源名称 (ARN)。

• OAuth2Properties – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 属性 对象。

  OAuth2 属性的键值对映射。每个值都是一个 Property 对象。

• BasicAuthenticationProperties – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 属性 对象。

  OAuth2 属性的键值对映射。每个值都是一个 Property 对象。

• CustomAuthenticationProperties – 键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 属性 对象。

  自定义身份验证属性的键值对映射。每个值都是一个 Property 对象。

字段

• SupportedAuthenticationTypes – 必填：UTF-8 字符串数组。

  支持的身份验证类型列表。

• SupportedDataOperations – 必填：UTF-8 字符串数组。

  支持的数据操作列表。

• SupportedComputeEnvironments – 必填：UTF-8 字符串数组。

  支持的计算环境列表。

字段

• Name：必需：UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  属性的名称。

• Description：必需：UTF-8 字符串，长度不超过 1024 个字节。

  属性的描述。

• Required – 必填：布尔值。

  指示属性是否为必需属性。

• DefaultValue – UTF-8 字符串。

  属性的默认值。

• PropertyTypes – 必填：UTF-8 字符串数组。

  描述属性的类型。

• AllowedValues – AllowedValue 对象的数组。

  表示属性允许的值的 AllowedValue 对象列表。

• DataOperationScopes – UTF-8 字符串数组。

  指示哪些数据操作适用于该属性。

• KeyOverride – UTF-8 字符串。

  在 API 请求中发送此属性时使用的键名称（如果与显示名称不同）。

• PropertyLocation – UTF-8 字符串（有效值：HEADER |BODY |QUERY_PARAM |PATH ）。

  指定 REST 请求中应该包含此属性的位置，例如标头、查询参数或请求正文。

字段

• Description – UTF-8 字符串，长度不超过 1024 个字节。

  允许的值的描述。

• Value：必需：UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  属性允许的值。

字段

• Name：必需：UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  计算环境配置的名称。

• Description：必需：UTF-8 字符串，长度不超过 1024 个字节。

  计算环境的描述。

• ComputeEnvironment – 必填： UTF-8 字符串（有效值：SPARK | ATHENA | PYTHON）。

  计算环境的类型。

• SupportedAuthenticationTypes – 必填：UTF-8 字符串数组。

  计算环境支持的身份验证类型。

• ConnectionOptions – 必填：键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 属性 对象。

  用作计算环境的连接选项的参数。

• ConnectionPropertyNameOverrides – 必填：键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  计算环境的连接属性名称覆盖。

• ConnectionOptionNameOverrides – 必填：键值对的映射数组。

  每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  每个值都是一个 UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  计算环境的连接选项名称覆盖。

• ConnectionPropertiesRequiredOverrides – 必填：UTF-8 字符串数组。

  计算环境需要覆盖的连接属性。

• PhysicalConnectionPropertiesRequired – 布尔值。

  指示计算环境是否需要 PhysicalConnectionProperties。

• ConnectionPropertiesConfiguration 结构

• ConnectorAuthenticationConfiguration 结构

• ConnectorProperty 结构

• RestConfiguration 结构

• SourceConfiguration 结构

• EntityConfiguration 结构

• ResponseConfiguration 结构

• ResponseExtractionMapping 结构

• PaginationConfiguration 结构

• CursorConfiguration 结构

• OffsetConfiguration 结构

• ExtractedParameter 结构

• FieldDefinition 结构

• ConnectorOAuth2Properties 结构

• ClientCredentialsProperties 结构

• JWTBearerProperties 结构

• ConnectorAuthorizationCodeProperties 结构

• BasicAuthenticationProperties 结构

• CustomAuthenticationProperties 结构

• FilterConfiguration 结构

• FilterOverrides 结构

• BetweenConfiguration 结构

• FilterStringConfiguration 结构

字段

• Url – 一个 ConnectorProperty 对象。

  此连接类型将要连接的端点的基本实例 URL。

• AdditionalRequestParameters – ConnectorProperty 对象的数组。

  创建连接期间可能需要的其他请求参数的键值对，例如 API 版本或特定于服务的配置选项。

字段

• AuthenticationTypes – 必填：UTF-8 字符串数组。

  此连接类型支持的身份验证类型列表，例如基本身份验证、OAuth2 或自定义身份验证方法。

字段

• Name：必需：UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  属性的名称。

• KeyOverride – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 Custom string pattern #15 匹配。

  在 API 请求中发送此属性时使用的键名称（如果与显示名称不同）。

• Required – 必填：布尔值。

  指示属性是否为必需属性。

• DefaultValue – UTF-8 字符串。

  属性的默认值。

• AllowedValues – UTF-8 字符串数组。

  表示属性允许的值的 AllowedValue 对象列表。

• PropertyLocation – UTF-8 字符串（有效值：HEADER |BODY |QUERY_PARAM |PATH ）。

  指定 REST 请求中应该包含此属性的位置，例如标头、查询参数或请求正文。

• PropertyType – 必填：UTF-8 字符串（有效值：USER_INPUT | SECRET | READ_ONLY | UNUSED | SECRET_OR_USER_INPUT）。

  此属性的数据类型

• Format – UTF-8 字符串。

  属性值的格式模板，用于定义在 API 请求中发送值之前应该如何格式化该值。使用 {value} 作为实际属性值的占位符（例如，SSWS {value}）。

字段

• GlobalSourceConfiguration – 一个 SourceConfiguration 对象。

  适用于该连接类型的所有 REST API 请求的全局配置设置，包括常用请求方法、路径和参数。

• ValidationEndpointConfiguration – 一个 SourceConfiguration 对象。

  端点的配置，用于在创建连接期间验证连接凭证和测试连接性。

• EntityConfigurations – 键值对的映射数组。

  每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 128 个字节，与 Custom string pattern #12 匹配。

  每个值都是一个 EntityConfiguration 对象。

  实体配置的映射，用于定义如何与通过 REST API 提供的不同数据实体进行交互，包括其架构和访问模式。

字段

• RequestMethod – UTF-8 字符串（有效值：GET |POST ）。

  用于向此端点发出请求的 HTTP 方法，例如 GET、POST。

• RequestPath – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 Custom string pattern #14 匹配。

  REST 端点的 URL 路径，其中可能包含参数占位符，这些占位符将在请求期间被替换为实际值。

• RequestParameters – ConnectorProperty 对象的数组。

  应包含在 API 调用中的请求参数的配置，例如查询参数、标头或正文内容。

• ResponseConfiguration – 一个 ResponseConfiguration 对象。

  用于定义如何从 API 响应中解析和提取数据的配置，包括成功处理和错误处理。

• PaginationConfiguration – 一个 PaginationConfiguration 对象。

  用于处理来自 REST API 的分页响应的配置，同时支持基于游标和基于偏移量的分页策略。

• FilterConfiguration – 一个 FilterConfiguration 对象。

  用于对 REST API 请求应用筛选条件下推的配置，定义如何将筛选条件谓词转换为查询参数或筛选字符串。

字段

• SourceConfiguration – 一个 SourceConfiguration 对象。

  定义如何通过 REST API 发出访问此实体数据的请求的源配置。

• Schema – 键值对的映射数组。

  每个键都是 UTF-8 字符串，长度至少 1 个字节。

  每个值都是一个 FieldDefinition 对象。

  此实体的架构定义，包括字段名称、类型以及描述数据结构的其他元数据。

字段

• ResultPath – 必填：UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 Custom string pattern #10 匹配。

  用于标识实际结果数据在 API 响应中所处位置的 JSON 路径表达式。

• ErrorPath – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 Custom string pattern #10 匹配。

  JSON 路径表达式，用于标识请求失败时错误信息在 API 响应中的位置。

字段

• ContentPath – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 Custom string pattern #10 匹配。

  一个 JSON 路径表达式，用于指定如何从响应正文内容中提取值。

• HeaderKey – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 Custom string pattern #15 匹配。

  要从中提取值的 HTTP 响应标头的名称。

字段

• CursorConfiguration – 一个 CursorConfiguration 对象。

  基于游标分页的配置，该配置下 API 会提供游标或令牌以检索下一页结果。

• OffsetConfiguration – 一个 OffsetConfiguration 对象。

  基于偏移量分页的配置，该配置下 API 使用数字偏移量和限制来控制返回哪些结果。

字段

• NextPage – 必填：一个 ExtractedParameter 对象。

  包含用于检索下一页结果的游标或令牌的参数名称或 JSON 路径。

• LimitParameter – 一个 ExtractedParameter 对象。

  用于指定每页返回的最大结果数量的参数名称。

字段

• OffsetParameter – 必填：一个 ExtractedParameter 对象。

  用于指定检索结果的起始位置或偏移量的参数名称。

• LimitParameter – 必填：一个 ExtractedParameter 对象。

  用于指定每页返回的最大结果数量的参数名称。

字段

• Key – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 Custom string pattern #15 匹配。

  将在后续请求中使用的参数键名称。

• DefaultValue – UTF-8 字符串，不少于 1 个字节或超过 1024 个字节，与 Custom string pattern #16 匹配。

  无法从响应中提取参数时所使用的默认值。

• PropertyLocation – UTF-8 字符串（有效值：HEADER |BODY |QUERY_PARAM |PATH ）。

  指定在后续请求中应将此提取的参数放置在何处，例如标头、查询参数或请求正文中。

• Value – 一个 ResponseExtractionMapping 对象。

  定义如何从 API 响应中提取参数值的 JSON 路径或提取映射。

字段

• Name – 必填：UTF-8 字符串。

  实体架构中字段的名称。

• FieldDataType：必填：UTF-8 字符串（有效值：INT | SMALLINT | BIGINT | FLOAT | LONG | DATE | BOOLEAN | MAP | ARRAY | STRING | TIMESTAMP | DECIMAL | BYTE | SHORT | DOUBLE | STRUCT | BINARY | UNION）。

  字段的数据类型。

• ResponseDateFormat – UTF-8 字符串。

  用于解析 API 响应中的日期值的格式模式。当 API 使用非 ISO-8601 格式时为必填项。接受 Java DateTimeFormatter 模式（例如 EEE, d MMM yyyy HH:mm:ss Z）、EPOCH_SECONDS 表示 Unix epoch 秒数，或 EPOCH_MILLIS 标识 Unix epoch 毫秒数。

• IsPartitionable – 布尔值。

  指示此字段是否可用于对数据来源的分区查询。

• IsNullable – 布尔值。

  指示此字段是否可以包含 null 值。

• IsQueryable – 布尔值。

  指示此字段是否可以在查询数据时用于筛选条件谓词。

• IsOrderable – 布尔值。

  指示此字段是否可用于对结果进行排序。

• FilterOverrides – 一个 FilterOverrides 对象。

  每个字段的筛选行为覆盖设置，允许自定义将筛选条件应用于此特定字段的方式。

字段

• OAuth2GrantType – 必填： UTF-8 字符串（有效值：CLIENT_CREDENTIALS | JWT_BEARER | AUTHORIZATION_CODE）。

  用于身份验证的 OAuth2 授权类型，例如 CLIENT_CREDENTIALS、JWT_BEARER 或 AUTHORIZATION_CODE。

• ClientCredentialsProperties – 一个 ClientCredentialsProperties 对象。

  特定于 OAuth2 客户端凭证授权类型流的配置属性。

• JWTBearerProperties – 一个 JWTBearerProperties 对象。

  特定于 OAuth2 JWT Bearer 授权类型流的配置属性。

• AuthorizationCodeProperties – 一个 ConnectorAuthorizationCodeProperties 对象。

  特定于 OAuth2 授权码授权类型流的配置属性。

字段

• TokenUrl – 一个 ConnectorProperty 对象。

  令牌端点 URL，客户端将在其中使用客户端凭证请求访问令牌。

• RequestMethod – UTF-8 字符串（有效值：GET |POST ）。

  发出令牌请求时使用的 HTTP 方法，通常为 POST。

• ContentType – UTF-8 字符串（有效值：APPLICATION_JSON |URL_ENCODED ）。

  用于令牌请求的内容类型，例如 application/x-www-form-urlencoded 或 application/json。

• ClientId – 一个 ConnectorProperty 对象。

  授权服务器提供的 OAuth2 客户端标识符。

• ClientSecret – 一个 ConnectorProperty 对象。

  授权服务器提供的 OAuth2 客户端密钥。

• Scope – 一个 ConnectorProperty 对象。

  OAuth2 范围，用于定义客户端凭证流所请求的访问级别。

• TokenUrlParameters – ConnectorProperty 对象的数组。

  以键值对的形式在令牌 URL 请求中包含的其他参数。

字段

• TokenUrl – 一个 ConnectorProperty 对象。

  将 JWT bearer 令牌交换为访问令牌所在的令牌端点 URL。

• RequestMethod – UTF-8 字符串（有效值：GET |POST ）。

  发出 JWT bearer 令牌请求时使用的 HTTP 方法，通常为 POST。

• ContentType – UTF-8 字符串（有效值：APPLICATION_JSON |URL_ENCODED ）。

  用于 JWT bearer 令牌请求的内容类型，例如 application/x-www-form-urlencoded 或 application/json。

• JwtToken – 一个 ConnectorProperty 对象。

  在 bearer 令牌授权流中用于身份验证的 JWT 令牌。

• TokenUrlParameters – ConnectorProperty 对象的数组。

  以键值对的形式在令牌 URL 请求中包含的其他参数。

字段

• AuthorizationCodeUrl – 一个 ConnectorProperty 对象。

  授权端点 URL，用户将被重定向至此处以授予授权。

• AuthorizationCode – 一个 ConnectorProperty 对象。

  用户同意后从授权服务器收到的授权码。

• RedirectUri – 一个 ConnectorProperty 对象。

  必须与授权服务器上注册的 URI 相匹配的重定向 URI。

• TokenUrl – 一个 ConnectorProperty 对象。

  将授权码交换为访问令牌所在的令牌端点 URL。

• RequestMethod – UTF-8 字符串（有效值：GET |POST ）。

  发出令牌交换请求时使用的 HTTP 方法，通常为 POST。

• ContentType – UTF-8 字符串（有效值：APPLICATION_JSON |URL_ENCODED ）。

  用于令牌交换请求的内容类型，例如 application/x-www-form-urlencoded 或 application/json。

• ClientId – 一个 ConnectorProperty 对象。

  授权服务器提供的 OAuth2 客户端标识符。

• ClientSecret – 一个 ConnectorProperty 对象。

  授权服务器提供的 OAuth2 客户端密钥。

• Scope – 一个 ConnectorProperty 对象。

  OAuth2 范围，用于定义授权码流所请求的访问级别。

• Prompt – 一个 ConnectorProperty 对象。

  OAuth2 提示参数，用于控制授权服务器在用户身份验证期间的行为。

• TokenUrlParameters – ConnectorProperty 对象的数组。

  以键值对的形式在令牌 URL 请求中包含的其他参数。

字段

• Username – 一个 ConnectorProperty 对象。

  用于基本身份验证凭证的用户名属性名称。

• Password – 一个 ConnectorProperty 对象。

  用于基本身份验证凭证的密码属性名称。

字段

• AuthenticationParameters – 必填：ConnectorProperty 对象的数组。

  定义特定身份验证机制和所需属性的自定义身份验证参数的映射。

字段

• FilterMode – 必填：UTF-8 字符串（有效值：QUERY_PARAMS | FILTER_STRING）。

  对请求应用筛选条件的策略。使用 QUERY_PARAMS 将筛选条件作为单独的查询参数传递，或使用 FILTER_STRING 构造单个筛选表达式字符串。

• OperatorMappings – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  逻辑筛选运算符与其特定于 API 的字符串表示形式之间的映射。支持的运算符键包括：EQUAL_TO、NOT_EQUAL_TO、LESS_THAN、GREATER_THAN、LESS_THAN_OR_EQUAL_TO、GREATER_THAN_OR_EQUAL_TO、CONTAINS、BETWEEN、AND 和 OR。

• DateTimeFormat – UTF-8 字符串。

  筛选表达式的全局日期和时间格式。接受 Java DateTimeFormatter 模式（例如 EEE, d MMM yyyy HH:mm:ss Z）、EPOCH_SECONDS 表示 Unix epoch 秒数，或 EPOCH_MILLIS 标识 Unix epoch 毫秒数。如果未指定，则以 ISO-8601 格式按原样传递值。

• StripQuotes – 布尔值。

  指示在处理之前是否应该从筛选条件值中去掉周围的双引号。

• BetweenConfiguration – 一个 BetweenConfiguration 对象。

  用于处理 BETWEEN 范围筛选条件操作的配置。

• FilterStringConfiguration – 一个 FilterStringConfiguration 对象。

  将 FilterMode 设置为 FILTER_STRING 时，用于构造筛选条件表达式的配置。

字段

• FieldName – UTF-8 字符串。

  若字段名称与架构字段名称不同，则为筛选条件表达式中所用字段名称的覆盖。

• OperatorMappings – 键值对的映射数组。

  每个键是一个 UTF-8 字符串。

  每个值是一个 UTF-8 字符串。

  逻辑筛选运算符与其特定于字段的 API 表示形式之间的映射，用于覆盖全局运算符映射。支持的运算符键包括：EQUAL_TO、NOT_EQUAL_TO、LESS_THAN、GREATER_THAN、LESS_THAN_OR_EQUAL_TO、GREATER_THAN_OR_EQUAL_TO、CONTAINS、BETWEEN、AND 和 OR。

• BetweenConfiguration – 一个 BetweenConfiguration 对象。

  特定于字段的配置，用于处理 BETWEEN 范围筛选条件操作。

• DateTimeFormat – UTF-8 字符串。

  此字段上的筛选条件表达式的日期和时间格式，用于覆盖全局 DateTimeFormat。接受 Java DateTimeFormatter 模式（例如 EEE, d MMM yyyy HH:mm:ss Z）、EPOCH_SECONDS 表示 Unix epoch 秒数，或 EPOCH_MILLIS 标识 Unix epoch 毫秒数。

字段

• LowBoundKey – UTF-8 字符串。

  BETWEEN 筛选操作中用于下限值的参数名称。

• HighBoundKey – UTF-8 字符串。

  BETWEEN 筛选操作中用于上限值的参数名称。

• Template – UTF-8 字符串。

  用于构造 BETWEEN 筛选表达式的模板字符串。

字段

• QueryParameterName – 必填：UTF-8 字符串。

  用于在 API 请求中发送所构造的筛选表达式字符串的查询参数名称。

• QuoteStringValues – 布尔值。

  指示字符串值和日期值是否应该在筛选表达式中用引号字符括起来。

• QuoteCharacter – UTF-8 字符串。

  当 QuoteStringValues 为 true 时，用于给值加引号的字符。如果未指定，则默认为双引号。