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

时间：2024-10-18 19:41:51

数据复制服务 DRS

请求参数

表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字段数据结构说明
参数	是否必选	参数类型	描述
id	是	String	DRS任务ID，可以从任务列表或者任务详情页面获取。
net_type	是	String	网络类型。取值： vpn vpc eip
db_type	是	String	数据库类型。取值： mysql：MySQL mongodb：MongoDB gaussdbv5： GaussDB 分布式版 taurus：GaussDB(for MySQL) gaussdbv5ha：GaussDB主备版 kafka：Kafka postgresql：PostgreSQL
ip	是	String	数据库IP。
db_port	否	Integer	数据库端口，Mongo、DDS必填为0。
inst_id	否	String	数据库实例ID。数据库为云上实例时，比如RDS实例时必填。
db_user	是	String	数据库账号。
db_password	是	String	数据库密码。
ssl_link	否	Boolean	是否SSL安全连接，该参数为true时，需填写SSL证书相关信息参数。
ssl_cert_key	否	String	SSL证书内容，获取SSL证书后将内容通过BASE64加密后所得的字符串，ssl_link为true时必填。
ssl_cert_name	否	String	SSL证书名字，ssl_link为true时必填。
ssl_cert_check_sum	否	String	SSL证书内容checksum值，获取SSL证书后将内容经过SHA256加密后的值，后端校验，ssl_link为true时必填。
ssl_cert_password	否	String	SSL证书密码，证书文件后缀为.p12，需要密码。
vpc_id	否	String	实例所在虚拟私有云ID，数据库为云上实例时，比如RDS实例时必填。
subnet_id	否	String	实例所在子网ID，数据库为云上实例时，比如RDS实例时必填。
end_point_type	是	String	源库：so，目标库：ta。缺省值：so 取值： so ta
region	否	String	数据库实例所在Region，数据库为云上实例时，比如RDS实例时必填。
project_id	否	String	用户所处Region的Project ID。
db_name	否	String	数据库用户名，DDS的账号认证数据库，Oracle的serviceName。
kafka_security_config	否	Object	Kafka安全认证相关，非安全认证不需要此参数。详情请参见表5。

表5 kafka_security_config字段数据结构说明
参数	是否必选	参数类型	描述
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	证书密码，使用安全认证时必填。
endpoint_algorithm	否	String	主机名端点识别算法，指定通过服务端证书验证服务端主机名的端点识别算法，不填表示禁用主机名验证。对应Kafka字段：ssl.endpoint.identification.algorithm
sasl_mechanism	否	String	SASL机制，用于客户端连接的SASL机制，认证类型为SASL_PLAINTEXT、SASL_SSL时必填。对应Kafka字段：sasl.mechanism，支持以下四项，取值： GSSAPI PLAIN SC RAM -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证书密码，证书设置了密码时需要。对应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。