数据复制服务 DRS-批量测试连接-集群模式:请求参数

时间:2024-05-13 09:09:57

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

指定类型为application/json。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

X-Language

String

请求语言类型。

缺省值:en-us

取值:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

jobs

Array of objects

集群批量测试连接任务请求列表。

详情请参见表4

表4 jobs字段数据结构说明

参数

是否必选

参数类型

描述

action

String

需要执行的特定操作。

job_id

String

任务ID(集群模式取父任务的任务ID)。

property

String

操作对应的参数。

说明:

按照表5中的参数拼成json后转义。

表5 property字段数据结构说明

名称

是否必选

参数类型

说明

dbtype

String

数据库类型。

dbport

Integer

数据库端口,mongodb时取值0。

ssllink

boolean

是否是SSL安全连接,取值:

  • true
  • false

nettype

String

网络类型,取值:

  • vpn
  • vpc
  • eip

endpointtype

String

endpoint类型,取值:

  • so:源库。
  • ta:目标库。
  • ls : 分片数据库。 当源库是集群时,数据库ip对应的endpointtype是so, 分片数据库对应的endpointtype是ls。

ip

String

数据库IP。

dbName

String

数据库名称。

instid

String

数据库实例ID,云上实例需要填写。

dbuser

String

数据库用户名。

dbpassword

String

数据库密码。

sslcertkey

String

SSL证书内容,SSL连接时需要。

sslcertname

String

SSL证书名字,SSL连接时需要。

sslcertchecksum

String

SSL证书内容checksum值,SSL连接时需要。

kafkaSecurityConfig

Object

Kafka认证方式为安全认证时填写。

详情请参见表6

表6 kafkaSecurityConfig字段数据结构说明

参数

是否必选

参数类型

描述

type

String

安全协议,安全认证时必填,对应Kafka字段:security.protocol。

  • PLAINTEXT:无安全认证方式,仅需输入IP和端口进行连接。
  • SASL_PLAINTEXT:使用SASL机制连接Kafka,需要设置SASL相关配置。
  • SSL:使用SSL加密方式连接Kafka,需要设置SSL相关配置。
  • SASL_SSL:使用SASL及SSL加密认证方式,需要设置SSL及SASL相关参数配置信息。

枚举值:

  • PLAINTEXT
  • SASL_PLAINTEXT
  • SASL_SSL
  • SSL

trust_store_key_name

String

证书名称,安全协议为SSL、SASL_SSL时必填。

trust_store_key

String

安全证书base64转码后的值,安全协议为SSL、SASL_SSL时必填。

trust_store_password

String

证书密码,安全协议为SSL、SASL_SSL时必填。

endpoint_algorithm

String

主机名端点识别算法,对应Kafka字段:ssl.endpoint.identification.algorithm,指定通过服务端证书验证服务端主机名的端点识别算法,不填表示禁用主机名验证。

sasl_mechanism

String

SASL机制,用于客户端连接的SASL机制,对应Kafka字段:sasl.mechanism,支持以下四项,取值:

  • GSSAPI
  • PLAIN
  • SCRAM-SHA-256
  • SCRAM-SHA-512

delegation_tokens

Boolean

是否为委托令牌鉴权,安全协议为SASL_SSL和SASL_PLAINTEXT时,SASL机制选择“SCRAM-SHA-256”或者“SCRAM-SHA-512”时生效。

enable_key_store

Boolean

是否开启SSL双向认证。

key_store_key

String

Keystore证书,开启SSL双向认证时需要。

key_store_key_name

String

Keystore证书名称,开启SSL双向认证时需要。

key_store_password

String

Keystore证书密码,开启SSL双向认证时需要。对应Kafka字段:ssl.keystore.password

set_private_key_password

Boolean

是否设置Keystore私钥密码,默认为false。

key_password

String

Keystore私钥密码,开启SSL双向认证时,set_private_key_password为true时必填。对应Kafka字段:ssl.key.password。

support.huaweicloud.com/api-drs/drs_03_0106.html