接口功能介绍
调用listTagResources查询一个或多个RDS实例已经绑定的标签列表,返回的标签列表将满足实例和标签约束,及
- 如果输入实例列表不为空,则返回的标签所属实例一定在输入的实例列表中。
- 如果输入的标签列表不为空,则返回的标签一定在输入的标签列表中且返回的标签所属实例一定具有所有标签列表中的标签键和值。
- 若某输入标签仅输入键,则会匹配所有包含该键的标签。
- 将返回满足以上三条条件的所有标签。
接口约束
实例、标签存在,不允许实例列表和标签列表同时为空。
URI
GET /v1/open-api/tag/list-tag-resources
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstIdList | 是 | String | 实例id列表(多组实例id用逗号分隔),长度不超过10 | testOuterProd1,testOuterProd2 | |
tagVOList | 是 | String | 键值列表(多组键值用逗号分隔,键值用冒号分隔),允许值为空,长度不超过10 | testKey1:testValue1,testKey2:testValue2 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 2001 | |
message | 是 | String | 返回消息 | success | |
returnObj | 是 | Array of Objects | 返回对象 | RdsTag |
表RdsTag
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例id | testOuterProd1 | |
tags | 是 | Array of Objects | 该实例下满足条件的标签列表 | TagVO |
表TagVO
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
key | 是 | String | 标签键 | testKey1 | |
value | 是 | String | 标签值 | testValue1 |
请求示例
ip:port/baseUrl/v1/open-api/tag/list-tag-resources?outerProdInstIdList=testProdInst1,testProdInst2&tagVOList=testKey1:testValue1,testKey2:testValue2
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": [
{
"outerProdInstId": "testOuterProd1",
"tags": [
{
"value": "testValue1",
"key": "testKey1"
},
{
"value": "testValue2",
"key": "testKey2"
},
]
}
]
}
状态码
状态码 | 描述 |
---|---|
0 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |