DescribeTags - 查询已有标签列表

查询目标地域中所有的标签信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeTagsget
*全部资源
*

请求参数

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

地域 ID。

cn-hangzhou
ResourceTypestring

资源类型,取值为 INSTANCEinstance

INSTANCE
NextTokenstring

下一个查询开始 Token,用来返回更多结果。

说明 第一次查询不需要提供本参数,如果一次查询没有返回全部结果,则可在后续查询中传入前一次返回的 NextToken 值以继续查询。
212db86sca4384811e0b5e8707ec2****

返回参数

名称类型描述示例值
object
NextTokenstring

下一个查询开始 Token。

说明 如果一次查询没有返回全部结果,则会返回本参数,您可以后续查询中传入本参数的值以继续查询。
212db86sca4384811e0b5e8707ec2****
RequestIdstring

请求 ID。

F3F44BE3-5419-4B61-9BAC-E66E295A****
Tagsarray<object>

标签信息。

Tagobject

标签信息。

TagKeystring

标签的键。

size
TagValuesarray

标签的值。

TagValuestring

标签的值。

['test_value_2']

示例

正常返回示例

JSON格式

{
  "NextToken": "212db86sca4384811e0b5e8707ec2****",
  "RequestId": "F3F44BE3-5419-4B61-9BAC-E66E295A****",
  "Tags": [
    {
      "TagKey": "size",
      "TagValues": [
        "['test_value_2']"
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidTagKey.MalformedThe specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid.-
400InvalidTagValue.MalformedThe specified parameter 'Tag.n.Value' is not valid.-
400InvalidParameter.ResourceIdThe specified parameter 'ResourceId.n' is not valid.-
400MissParameter.TagOrResourceIdThe parameter 'Tag.n'' or 'ResourceId.n' is needed.-
400InvalidParameter.ScopeThe specified parameter 'Scope' is not valid.-
400NumberExceed.ResourceIdsThe ResourceIds parameter's number is exceed.-
400NumberExceed.TagsThe Tags parameter's number is exceed.-
400Duplicate.TagKeyThe specified parameter 'Tag.n.Key' is duplicated.-
400InvalidParameter.ResourceTypeThe specified parameter 'ResourceType' is not valid.-
404InvalidDbInstanceId.NotFoundSpecified instance does not exist.指定的实例不存在

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