DescribeTags - 查询标签列表_云数据库 RDS(RDS)-阿里云帮助中心

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

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

注意事项

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeTags	Read	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/* DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。	ETnLKlblzczshOTUbOC****
proxyId	string	否	代理模式 ID。	API
RegionId	string	是	地域 ID，可以通过接口 DescribeRegions 查看可用的地域 ID。	cn-hangzhou
DBInstanceId	string	否	实例 ID。可通过 DescribeDBInstances 接口查询获取。说明如果传入该参数，则查询该实例下所有标签，其他过滤条件失效。	rm-uf6wjk5****
Tags	string	否	需要查询的标签，包括 TagKey 和 TagValue。参数格式：`{“TagKey”:”TagValue”}`。	{“key1”:”value1”}
ResourceType	string	否	资源类型。固定取值。枚举值： INSTANCE：INSTANCE。	INSTANCE

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
RequestId	string	请求 ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Items	object []	标签列表。
TagValue	string	标签值。	value1
TagKey	string	标签键。	key1
DBInstanceIds	array	该标签所绑定的实例 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	错误码	错误信息	描述
400	Tag.NoRegionIdExist	the region Id can not be blank.	地域ID不能为空，请设置RegionId参数值。
400	Tag.NoTagInfoExist	all the tags and tagN parameters is null.	参数信息Tag无效或错误，请检查。
400	Tag.TagKeyCanNotBeAll	tag key can not be all.	操作失败，请设置合理的TagKey值。
400	Tag.TagKeyDuplex	tag key must be sole in one operation.	实例已关联此标签，请定义新的标签。
400	Tag.NoDBInstanceIdExist	the dbinstance Id can not be blank.	数据库实例ID不能为空，请检查是否正确。
400	Tag.TooManyDBInstanceIds	the dbinstance Ids is more than 30.	数据库实例ID超过30个。
400	Tag.TooManyTagsForOneInstance	total 10 tags can be added to one resource.	已超过资源Tag数量的上限（上限：10个）。请您不要超量添加。
400	Tag.Allow5TagInfos	only 5 tags allowed in one operation.	操作失败。一次最多可以使用5个标记。
400	Tag.TagKeyIsBlank	tag key can not be blank.	标签设置不正确。标签键不能为空。
400	Tag.TagKeyStartWith.aliyun	tag key and value can not be started with aliyun.	标签设置不正确。标签键不能以aliyun为开头。
400	Tag.TagKeyTooLong	the max length of tag key is 64.	-
400	Tag.TagValueTooLong	the max length of tag value is 128.	-
400	Tag.Malformed	The specified parameter Tag is not valid.	当前指定的标签无效，请检查标签参数正确性。
400	Tag.Malformed	The specified parameter Value is not valid.	当前指定的标签值无效，请检查标签值正确性。
400	Tag.SetTagInfoAtTwoParameter	only tags or tagN parameter could be setted.	标签设置不正确。
400	Tag.InvalidTagsParameter	tags parameter 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.	调用商品服务返回失败。
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您购买的模块不合法，请重新购买。
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400	Price.CommoditySys	Commodity system call exception.	商品系统调用异常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	您选购的周期有问题，请重新选购。
400	pay.noCreditCard	Account not bound to credit card.	账户未绑定信用卡。
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	您选购的服务存在未支付订单，请支付或作废后再下单。
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	您的基本信息未完善，请在操作前先完善您的基本信息。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的账户出现异常，详情请联系客服。
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	您的信息不完整，请在操作前填写您的信息。
400	System.SaleValidateFailed	Sales expression validation system error.	销售表达式校验系统错误。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	实例当前存在未支付订单，请支付后重试。
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	指定的实例不存在，请检查该实例是否存在，未被删除。

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

变更历史

变更时间

变更内容概要

操作

2022-11-14

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 400 变更
	删除错误码：404

2022-09-01

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 400 变更
	删除错误码：404