调用ListTagKeys查询标签键列表。

本文将提供一个示例，在cn-hangzhou地域，查询标签键列表。返回结果显示：存在3个自定义标签键team、k1和k2。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListTagKeys

要执行的操作。取值：ListTagKeys。
RegionId String 是 cn-hangzhou

地域ID。

关于地域ID的详情，请参见接入地址。

NextToken String 否 caeba0bbb2be03f84eb48b699f0a****

下一个查询开始的Token。
PageSize Integer 否 50

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

最大值：1000。默认值：50。
Category String 否 Custom

资源标签类型。取值：

  • All（默认值）：全部标签。
  • Custom：自定义标签。
  • System：系统标签。
ResourceType String 否 ALIYUN::ECS::INSTANCE

资源类型。详情请参见支持标签API的资源类型。

QueryType String 否 ResourceTag

标签类型。取值：

  • ResourceTag（默认值）：资源标签。包括自定义标签和系统标签。
  • MetaTag：预置标签。

关于公共请求参数的详情，请参见公共参数。

返回数据

名称 类型 示例值 描述
Keys Array of Key

标签键信息。
Key
Category String Custom

资源标签类型。取值：

  • Custom：自定义标签。
  • System：系统标签。
Description String 业务团队

标签键描述。
Key String team

标签键。
NextToken String caeba0bbb2be03f84eb48b699f0a****

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

  • 如果NextToken为空，即"NextToken": ""，表示没有下一个。
  • 如果NextToken有值，则该值就是下一个查询开始的Token。
RequestId String DC09A6AA-2713-4E10-A2E9-E6C5C43A8842

请求ID。

示例

请求示例

https://tag.aliyuncs.com/?Action=ListTagKeys
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

<ListTagKeysResponse>
	  <NextToken></NextToken>
	  <RequestId>DC09A6AA-2713-4E10-A2E9-E6C5C43A8842</RequestId>
	  <Keys>
		    <Key>
			      <Category>custom</Category>
			      <Key>team</Key>
		    </Key>
		    <Key>
			      <Category>custom</Category>
			      <Key>k1</Key>
		    </Key>
		    <Key>
			      <Category>custom</Category>
			      <Key>k2</Key>
		    </Key>
	  </Keys>
</ListTagKeysResponse>

JSON格式 

{
	"NextToken": "",
	"RequestId": "DC09A6AA-2713-4E10-A2E9-E6C5C43A8842",
	"Keys": {
		"Key": [
			{
				"Category": "custom",
				"Key": "team"
			},
			{
				"Category": "custom",
				"Key": "k1"
			},
			{
				"Category": "custom",
				"Key": "k2"
			}
		]
	}
}

错误码

HttpCode 错误码 错误信息 描述
403 Invalid.NextToken The parameter NextToken is invalid. NextToken参数非法。
403 NoPermission.Operator The user is not authorized to operate on the specified resource. 该用户没有权限操作。
403 InvalidParameter.Category The specified Category is invalid. Valid values are Custom and System. 标签类型非法，合法值为Custom，System。
403 InvalidParameter.ResourceType The ResourceType parameter is invalid. 资源类型参数非法。

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