全部产品
Search
文档中心

资源管理:ListTagKeys - 查询标签键列表

更新时间:Jun 20, 2024

查询标签键列表。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

关于地域 ID 的详情,请参见服务接入点

cn-hangzhou
NextTokenstring

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a****
PageSizeinteger

分页时每页显示的标签键个数。

最大值:1000。默认值:50。

50
Categorystring

资源标签类型,用于查询的过滤条件。取值:

  • all(默认值):全部标签。
  • custom:自定义标签。
  • system:系统标签。
说明 取值不区分大小写。
all
ResourceTypestring

资源类型,用于查询的过滤条件。

格式:ALIYUN::${ProductCode}::${ResourceType},全部大写。

ALIYUN::ECS::INSTANCE
QueryTypestring

标签类型,用于查询的过滤条件。取值:

  • ResourceTag(默认值):资源标签。包括自定义标签和系统标签。
  • MetaTag:预置标签。
说明 取值不区分大小写。
ResourceTag
FuzzyTypestring

模糊查询类型。取值:

  • EQUAL(默认值):精确查询。
  • PREFIX:根据前缀进行模糊查询。
说明 该参数仅支持华南 1(深圳)和中国(香港)地域。
EQUAL
TagFilter.Keystring

模糊查询的标签键。

该参数与FuzzyType配合使用。

说明 该参数仅支持华南 1(深圳)和中国(香港)地域。
team

返回参数

名称类型描述示例值
object

返回结果。

NextTokenstring

根据NextToken判断是否具备下一个查询开始的 Token。取值:

  • 如果NextToken为空,即"NextToken": "",表示没有下一个。
  • 如果NextToken有值,则该值就是下一个查询开始的 Token。
caeba0bbb2be03f84eb48b699f0a****
RequestIdstring

请求 ID。

DC09A6AA-2713-4E10-A2E9-E6C5C43A8842
Keysobject []

标签键信息。

Keystring

标签键。

team
Categorystring

资源标签类型。取值:

  • custom:自定义标签。
  • system:系统标签。
custom
Descriptionstring

标签键描述。

业务团队

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "DC09A6AA-2713-4E10-A2E9-E6C5C43A8842",
  "Keys": {
    "Key": [
      {
        "Key": "team",
        "Category": "custom",
        "Description": "业务团队"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400FuzzyQuery.NotSupportThe fuzzy query is not supported.-
403Invalid.NextTokenThe parameter NextToken is invalid.NextToken参数非法。
403NoPermission.OperatorThe user is not authorized to operate on the specified resource.该用户没有权限操作。
403InvalidParameter.CategoryThe specified Category is invalid. Valid values are Custom and System.标签类型非法,合法值为Custom,System。
403InvalidParameter.ResourceTypeThe ResourceType parameter is invalid.资源类型参数非法。

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