批量测试连接-集群模式
功能介绍
- 批量测试连接(集群模式)。
- 主备任务测试连接
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
接口约束
- 任务创建成功之后,任务状态为CONFIGURATION才能进行测试连接。
- 为保证接口调用性能,建议批量调用数量不超过10个。
URI
POST /v3/{project_id}/jobs/cluster/batch-connection
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
指定类型为application/json。 缺省值:application/json |
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
X-Language |
否 |
String |
请求语言类型。 缺省值:en-us 取值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
jobs |
是 |
Array of objects |
集群批量测试连接任务请求列表。 详情请参见表4。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
是 |
String |
需要执行的特定操作。 |
job_id |
是 |
String |
任务ID(集群模式取父任务的任务ID)。 |
property |
是 |
String |
操作对应的参数。 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
dbtype |
是 |
String |
数据库类型。 |
dbport |
是 |
Integer |
数据库端口,mongodb时取值0。 |
ssllink |
是 |
boolean |
是否是SSL安全连接,取值:
|
nettype |
是 |
String |
网络类型,取值:
|
endpointtype |
是 |
String |
endpoint类型,取值:
|
ip |
是 |
String |
数据库IP。 |
dbName |
是 |
String |
数据库名称。 |
dbuser |
是 |
String |
数据库用户名。 |
dbpassword |
是 |
String |
数据库密码。 |
sslcertkey |
否 |
String |
SSL证书内容,SSL连接时需要。 |
sslcertname |
否 |
String |
SSL证书名字,SSL连接时需要。 |
sslcertchecksum |
否 |
String |
SSL证书内容checksum值,SSL连接时需要。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
results |
Array of objects |
批量测试连接响应体集合。 详情请参见表7。 |
count |
Integer |
总记录数。 |
请求示例
- MySQL主备任务测试连接
https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/cluster/batch-connection { "jobs": [{ "action": "testConnection", "job_id": "0ac45233-8de7-4f02-9de1-d71cab7jb201", "property": "[{\"ip\":\"192.168.2.232:3306\",\"dbtype\":\"mysql\",\"dbuser\":\"root\",\"dbpassword\":\"******\",\"ssllink\":false,\"projectId\":\"054ba152d480d55b2f5dc0069e7ddef0\",\"region\":\"cn-xianhz-1\",\"nettype\":\"eip\",\"endpointtype\":\"so\"}]" }] }
- 源库为DDS集群测试连接
https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/cluster/batch-connection { "jobs" : [ { "action" : "testConnection", "job_id" : "35d0d60b-4605-4686-b35d-3a3d059fjb15", "property" : "[{\"dbtype\":\"mongodb\",\"dbport\":0,\"ssllink\":false,\"nettype\":\"eip\",\"endpointtype\":\"so\",\"encrypt\":{\"elementId\":\"encrypt_switch\",\"offLabel\":\"OFF\",\"onLabel\":\"ON\",\"disable\":false,\"ip\":\"192.168.7.217:8635\",\"dbName\":\"admin\",\"dbuser\":\"rwuser\",\"dbpassword\":\"******\"},{\"dbtype\":\"mongodb\",\"dbport\":0,\"ssllink\":false,\"nettype\":\"eip\",\"endpointtype\":\"so\",\"encrypt\":{\"elementId\":\"encrypt_switch\",\"offLabel\":\"OFF\",\"onLabel\":\"ON\",\"disable\":false,\"ip\":\"192.168.7.72:8635\",\"dbName\":\"admin\",\"dbuser\":\"rwuser\",\"dbpassword\":\"******\"},{\"ip\":\"192.168.7.37:8635\",\"nettype\":\"eip\",\"dbtype\":\"mongodb\",\"dbport\":0,\"dbuser\":\"rwuser\",\"dbpassword\":\"******\",\"ssllink\":false,\"sslcertkey\":\"\",\"sslcertname\":\"\",\"sslcertchecksum\":\"\",\"endpointtype\":\"ls\",\"dbName\":\"admin\"}]" } ] }
响应示例
状态码: 200
OK
{ "results" : [ { "id" : "0eb704d0-5a1c-4cbd-b675-91152f06jb11", "status" : "true" } ], "count" : 1 }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。