文档

ListTagResources - 查询标签和资源列表

更新时间:

该接口用于查询一个或多个RDS实例已经绑定的标签列表。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:ListTagResourcesRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID,可以通过接口 DescribeRegions 查看可用的地域 ID。

cn-hangzhou
ResourceTypestring

资源类型定义。唯一取值:INSTANCE

INSTANCE
NextTokenstring

用来返回更多结果。第一次查询不需要提供这个参数,如果一次查询没有返回全部结果,则可在后续查询中传入前一次返回的 token 继续查询。

212db86sca4384811e0b5e8707ec21345
ResourceIdarray

实例 ID 列表。可以同时查询多个实例的标签,数量范围:1~50

说明 ResourceId 参数和Tag.Key参数至少传入一个。
string

实例 ID。

rm-uf6wjk****
Tagobject []

标签列表。

Keystring

标签键。可以同时查询 N 个标签键,N 的取值范围:1~20。不允许传入空字符串。

说明 ResourceId 参数和Tag.Key参数至少传入一个。
testkey1
Valuestring

标签键对应的标签值。可以同时查询 N 个标签值,N 的取值范围:1~20。允许传入空字符串。

testvalue1

返回参数

名称类型描述示例值
object

返回参数详情。

NextTokenstring

如果一次查询没有返回全部结果,则可在后续查询中传入前一次返回的 token 继续查询。

212db86sca4384811e0b5e8707ec21345
RequestIdstring

请求 ID。

47A514A1-4B77-4E30-B4C5-2A880650B3FD
TagResourcesobject []

查询到的实例和标签列表。

TagValuestring

标签键对应的标签值。

testvalue1
ResourceTypestring

资源类型,ALIYUN::RDS::INSTANCE即云数据库 RDS 实例。

ALIYUN::RDS::INSTANCE
ResourceIdstring

实例 ID。

rm-uf6wjk5****
TagKeystring

标签键。

testkey1

示例

正常返回示例

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错误码错误信息描述
400BothEmpty.TagsAndResourcesThe specified Tags and ResourcesIds are not allow to both empty.操作失败,标签和资源ID不允许同时为空。
400NumberExceed.TagsThe number of Tags parameter is exceed, Valid : 20-
400NumberExceed.ResourceIdsThe number of ResourceIds parameter is exceed , Valid : 50-
400InvalidParameter.ResourceTypeThe parameter ResourceType is invalid.操作失败,请检查资源类型参数正确性。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou 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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-09-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈