首页 云数据库 RDS API参考 API目录 标签 DescribeTags - 查询标签列表

DescribeTags - 查询标签列表

该接口用于查询RDS实例的标签信息。

接口说明

调用本接口时限制条件如下:

  • 如果传入指定实例ID,则查询该实例下所有标签,其他过滤条件失效;
  • 若查询标签时仅传入标签键(TagKey),未传入标签值(TagValue),则返回所有符合标签键条件的结果。若同时传入标签键和标签值,则返回两个条件都符合的结果。

调试

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

调试

授权信息

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

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

请求参数

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

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

ETnLKlblzczshOTUbOC****
proxyIdstring

代理模式ID。

API
RegionIdstring

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

cn-hangzhou
DBInstanceIdstring

实例ID。可通过DescribeDBInstances 接口查询获取。

说明如果传入该参数,则查询该实例下所有标签,其他过滤条件失效。
rm-uf6wjk5****
Tagsstring

需要查询的标签,包括TagKey和TagValue。 参数格式:{“TagKey”:”TagValue”}

{“key1”:”value1”}
ResourceTypestring

资源类型。固定取值。

枚举值:
  • INSTANCEINSTANCE
INSTANCE

返回参数

名称类型描述示例值
object

返回值结果集。

RequestIdstring

请求ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Itemsarray

标签列表。

object

标签对象。

TagValuestring

标签值。

value1
TagKeystring

标签键。

key1
DBInstanceIdsarray

该标签所绑定的实例ID列表。

string

该标签所绑定的实例ID。

rm-uf6wjk5****

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items": {
    "TagInfos": [
      {
        "TagValue": "value1",
        "TagKey": "key1",
        "DBInstanceIds": {
          "DBInstanceIds": [
            "rm-uf6wjk5****"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Tag.NoRegionIdExistthe region Id can not be blank.地域ID不能为空,请设置RegionId参数值。
400Tag.NoTagInfoExistall the tags and tagN parameters is null.参数信息Tag无效或错误,请检查。
400Tag.TagKeyCanNotBeAlltag key can not be all.操作失败,请设置合理的TagKey值。
400Tag.TagKeyDuplextag key must be sole in one operation.实例已关联此标签,请定义新的标签。
400Tag.NoDBInstanceIdExistthe dbinstance Id can not be blank.数据库实例ID不能为空,请检查是否正确。
400Tag.TooManyDBInstanceIdsthe dbinstance Ids is more than 30.数据库实例ID超过30个。
400Tag.TooManyTagsForOneInstancetotal 10 tags can be added to one resource.已超过资源Tag数量的上限(上限:10个)。请您不要超量添加。
400Tag.Allow5TagInfosonly 5 tags allowed in one operation.操作失败。一次最多可以使用5个标记。
400Tag.TagKeyIsBlanktag key can not be blank.标签设置不正确。标签键不能为空。
400Tag.TagKeyStartWith.aliyuntag key and value can not be started with aliyun.标签设置不正确。标签键不能以aliyun为开头。
400Tag.TagKeyTooLongthe max length of tag key is 64.-
400Tag.TagValueTooLongthe max length of tag value is 128.-
400Tag.MalformedThe specified parameter Tag is not valid.当前指定的标签无效,请检查标签参数正确性。
400Tag.MalformedThe specified parameter Value is not valid.当前指定的标签值无效,请检查标签值正确性。
400Tag.SetTagInfoAtTwoParameteronly tags or tagN parameter could be setted.标签设置不正确。
400Tag.InvalidTagsParametertags parameter is invalid.当前标签键和标签值无效,请重新设置。
404InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in our records.指定的实例不存在,请检查该实例是否存在,未被删除。

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

变更历史

变更时间变更内容概要操作
2022-11-14OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
2022-09-01OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
阿里云首页 关系型数据库 相关技术圈