该接口用于查询一个或多个RDS实例已经绑定的标签列表。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ListTagResources | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID,可以通过接口 DescribeRegions 查看可用的地域 ID。 | cn-hangzhou |
ResourceType | string | 是 | 资源类型定义。唯一取值:INSTANCE。 | INSTANCE |
NextToken | string | 否 | 用来返回更多结果。第一次查询不需要提供这个参数,如果一次查询没有返回全部结果,则可在后续查询中传入前一次返回的 token 继续查询。 | 212db86sca4384811e0b5e8707ec21345 |
ResourceId | array | 否 | 实例 ID 列表。可以同时查询多个实例的标签,数量范围:1~50。 说明
ResourceId 参数和Tag.Key参数至少传入一个。
| |
string | 否 | 实例 ID。 | rm-uf6wjk**** | |
Tag | object [] | 否 | 标签列表。 | |
Key | string | 否 | 标签键。可以同时查询 N 个标签键,N 的取值范围:1~20。不允许传入空字符串。 说明
ResourceId 参数和Tag.Key参数至少传入一个。
| testkey1 |
Value | string | 否 | 标签键对应的标签值。可以同时查询 N 个标签值,N 的取值范围:1~20。允许传入空字符串。 | testvalue1 |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "212db86sca4384811e0b5e8707ec21345",
"RequestId": "47A514A1-4B77-4E30-B4C5-2A880650B3FD",
"TagResources": {
"TagResource": [
{
"TagValue": "testvalue1",
"ResourceType": "ALIYUN::RDS::INSTANCE",
"ResourceId": "rm-uf6wjk5****",
"TagKey": "testkey1"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | BothEmpty.TagsAndResources | The specified Tags and ResourcesIds are not allow to both empty. | 操作失败,标签和资源ID不允许同时为空。 |
400 | NumberExceed.Tags | The number of Tags parameter is exceed, Valid : 20 | - |
400 | NumberExceed.ResourceIds | The number of ResourceIds parameter is exceed , Valid : 50 | - |
400 | InvalidParameter.ResourceType | The parameter ResourceType is invalid. | 操作失败,请检查资源类型参数正确性。 |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐实例不允许单独操作。 |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定价计划价格结果没有找到。 |
400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | 您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。 |
400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的账户可用额度小于0,请先充值后再尝试购买。 |
400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 调用商品服务返回失败。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2022-09-01 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|