一类节点--数据传输服务dts-查询标签
接口功能介绍
查询DTS实例绑定的标签,或者查询标签所绑定的DTS实例。
接口约束
无
URI
POST /dts/v1/open-api/tag/query
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
resourceType | 是 | String | 资源类型(INSTANCE) | INSTANCE | |
resourceIdList | 否 | Array of Strings | 资源id列表,和tagKeyList不可同时为空 | [1,2] | |
tagKeyList | 否 | Array of Strings | 标签键列表,列表序号与tagValueList保持一致,和resourceIdList不可同时为空 | ['env','version'] | |
tagValueList | 否 | Array of Strings | 标签值列表,列表序号与tagKeyList保持一致 | ['prod','2.0'] |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
---|---|---|---|---|---|
statusCode | Integer | 返回码 | 0 | ||
error | String | 错误码,格式为:DTS_{statusCode} | DTS_0000 | ||
message | String | 返回消息 | 成功 | ||
returnObj | Array of Objects | 返回数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
---|---|---|---|---|---|
resourceType | String | 资源类型 | INSTANCE | ||
resourceId | String | 资源id | 1 | ||
tagKey | String | 标签键 | env | ||
tagValue | String | 标签值 | prod |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"resourceType":"INSTANCE",
"resourceIdList":[
],
"tagKeyList":[
"env"
],
"tagValueList":[
"prod"
]
}
响应示例
{
"statusCode":0,
"message":"成功",
"returnObj":[
{
"resourceType":"INSTANCE",
"resourceId":"1",
"tagKey":"env",
"tagValue":"prod"
},
{
"resourceType":"INSTANCE",
"resourceId":"2",
"tagKey":"env",
"tagValue":"prod"
}
],
"error":""
}