查询标签
更新时间 2026-06-16 17:08:34
最近更新时间: 2026-06-16 17:08:34
接口功能介绍
查询标签。
接口约束
无
URI
POST /dts/v2/open-api/tag/query
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| tagKeyList | 否 | Array of Strings | 列表序号与tagValueList保持一致（多次传入相同key值时，覆盖写入） | ["env","biz"] | |
| tagValueList | 否 | Array of Strings | 列表序号与tagKeyList保持一致 | ["prod","order"] | |
| resourceIdList | 否 | Array of Strings | 资源id列表 | ["dts-job-07001","dts-job-07002"] | |
| resourceType | 是 | String | 资源类型 | INSTANCE | |
| all | 否 | Boolean | 是否全量操作 | false |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| httpStatusCode | Integer | 状态码 | ||
| errCode | String | 错误码 | ||
| errMessage | String | 提示信息 | ||
| success | Boolean | 请求是否成功 | ||
| requestId | String | 请求id | ||
| data | Array of Objects | 响应数据 | TagObjectRel |
表 TagObjectRel
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Integer | 主键ID | ||
| resourceId | String | 资源ID | ||
| tenantId | Integer | 租户ID | ||
| tagId | Integer | 标签ID | ||
| tagKey | String | 标签键 | ||
| tagValue | String | 标签值 | ||
| resourceType | String | 资源类型 | ||
| region | String | 所属区域 | ||
| gmtCreate | String | 创建时间 | ||
| gmtModified | String | 修改时间 | ||
| isDeleted | Boolean | 删除标识 |
枚举参数
无
请求示例
请求url
https://{host}/dts/v2/open-api/tag/query
请求头header
无
请求体body
{
"tagKeyList": ["env", "biz"]
}
响应示例
{
"httpStatusCode": 200,
"errCode": "",
"errMessage": "",
"success": true,
"requestId": "req-20260612-001",
"data": [
{
"id": 10001,
"resourceId": "dts-job-1001",
"tenantId": 8866,
"tagId": 5001,
"tagKey": "env",
"tagValue": "prod",
"resourceType": "INSTANCE",
"region": "cn-shenzhen",
"gmtCreate": "2026-06-12 10:00:00",
"gmtModified": "2026-06-12 10:30:00",
"isDeleted": false
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
