获取DTS实例列表
更新时间 2026-06-16 17:29:14
最近更新时间: 2026-06-16 17:29:14
接口功能介绍
查询 DTS 实例列表。
接口约束
无
URI
POST /dts/v2/open-api/instance/describeDtsInstances
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageSize | 否 | Integer | 条数 | 20 | |
| pageNumber | 否 | Integer | 当前页码 | 1 | |
| prodInstId | 否 | String | 实例id | dts-prod-00101 | |
| prodInstName | 否 | String | 实例名称 | 生产同步实例01 | |
| statusList | 否 | Array of Strings | 实例状态：DEPLOYING (开通中),RUNNING (可使用),FROZEN (已冻结),RENEWING (续订中),REFUNDING (退订中),CANCELING (注销中),RELEASED (已注销) | ["RUNNING","FROZEN"] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| httpStatusCode | Integer | 状态码 | ||
| errCode | String | 错误码 | ||
| errMessage | String | 提示信息 | ||
| success | Boolean | 请求是否成功 | ||
| requestId | String | 请求id | ||
| data | Array of Objects | 响应数据 | DtsInstanceVo | |
| pageNumber | Integer | 页码 | ||
| pageRecordCount | Integer | 当前页可展示的最大记录数 | ||
| totalRecordCount | Integer | 记录总数 |
表 DtsInstanceVo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| region | String | dts实例所属区域 | ||
| projectId | String | dts实例所属的企业项目ID | ||
| projectName | String | dts实例所属的企业项目名称 | ||
| userId | Integer | dts实例所属的用户id | ||
| userName | String | dts实例所属的用户名称 | ||
| tenantId | Integer | dts实例所属的租户id | ||
| tenantName | String | dts实例所属的租户名称 | ||
| prodInstId | String | dts实例ID | ||
| prodInstName | String | 实例名称 | ||
| status | String | 实例状态，枚举值：DEPLOYING (开通中),RUNNING (可使用),FROZEN (已冻结),RENEWING (续订中),REFUNDING (退订中),CANCELING (注销中),RELEASED (已注销) | RUNNING | |
| billMode | String | 计费模式，枚举值：PRE_PAY, POST_PAY | ||
| netType | String | 网络类型 | ||
| vpcId | String | dts实例所属的虚拟私有云ID | ||
| vpcName | String | dts实例所属的虚拟私有云名称 | ||
| subnetid | String | dts实例所属的子网ID | ||
| subnetName | String | dts实例所属的子网名称 | ||
| securityGroupId | String | dts实例所属的安全组ID | ||
| securityGroupName | String | dts实例所属的安全组名称 | ||
| nodeCount | Integer | dts实例的节点数量 | ||
| gmtCreate | String | dts实例创建时间 | ||
| expireTime | String | dts实例的过期时间 |
枚举参数
无
请求示例
请求url
https://{host}/dts/v2/open-api/instance/describeDtsInstances
请求头header
无
请求体body
{
"statusList": ["RUNNING"],
"pageSize": 2,
"pageNum": 1
}
响应示例
{
"httpStatusCode": 200,
"success": true,
"requestId": "00-6a2a9445487200256a6a2803be0d4958-64b6f0adf3dd18c7-00",
"data": [
{
"region": "200000002368",
"projectId": "0",
"projectName": "",
"userId": 42654,
"accountId": "1cf6348cca064039896c9de74aaae09e",
"userName": "teledb_mysql_autotest@chinatelecom.cn",
"tenantId": 8955,
"tenantName": "c29407t5ao",
"prodInstId": "71a3f3b10f0d41a0809006ba8bed3938",
"prodInstName": "autotest-dts20260610192217",
"status": "RUNNING",
"billMode": "POST_PAY",
"netType": "vpc",
"ip": "33.2.7.79",
"vpcId": "vpc-7y3gibha9l",
"vpcName": "vpc-xianlan-dds",
"subnetid": "subnet-qi6u6apivg",
"subnetName": "subnet-b9d8",
"securityGroupId": "sg-igskpinsyg",
"securityGroupName": "Default-Security-Group",
"nodeCount": 1,
"zk": "default",
"gmtCreate": "2026-06-10 20:01:09",
"expireTime": "2126-06-10 20:01:50"
},
{
"region": "200000002368",
"projectId": "0",
"projectName": "",
"userId": 46685,
"accountId": "1cf6348cca064039896c9de74aaae09e",
"userName": "teledb_yfnc_test_dts",
"tenantId": 8955,
"tenantName": "c29407t5ao",
"prodInstId": "d2cc674254dc451c82aa9b21e16e0c5b",
"prodInstName": "dts-34",
"status": "RUNNING",
"billMode": "PRE_PAY",
"netType": "vpc",
"ip": "33.2.7.58",
"vpcId": "vpc-p2gsvcllcp",
"vpcName": "vpc-dts-ipv6",
"subnetid": "subnet-cnxprsljhh",
"subnetName": "subnet-5743",
"securityGroupId": "sg-0167055ixl",
"securityGroupName": "Default-Security-Group",
"nodeCount": 1,
"zk": "default",
"gmtCreate": "2026-06-10 14:43:01",
"expireTime": "2026-07-10 14:43:43"
}
],
"pageNumber": 1,
"pageRecordCount": 2,
"totalRecordCount": 9
}
状态码
请参考 状态码
错误码
请参考 错误码
