文档

DescribeTagKeys - 查询标签键

更新时间:

调用DescribeTagKeys接口返回标签键。

调试

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

授权信息

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

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

请求参数

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

资源类型。取值:

  • VPC:专有网络实例。
  • VSWITCH:交换机实例。
  • ROUTETABLE:路由表实例。
  • EIP:弹性公网 IP 实例。
  • VpnGateWay:VPN 网关实例。
  • NATGATEWAY:NAT 网关实例。
  • COMMONBANDWIDTHPACKAGE:共享带宽实例。
VPC
Keywordstring

标签键。

keyword
RegionIdstring

资源所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultinteger

分页大小,取值范围:1~50,默认值:50。

50
ResourceIdarray

资源 ID。最多支持输入 50 个资源 ID。

string

资源 ID。最多支持输入 50 个资源 ID。

说明 当输入该参数时,必须输入 ResourceType 参数。
vpc-bp16qjewdsunr41m1****

返回参数

名称类型描述示例值
object

object

NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

请求 ID。

DE65F6B7-7566-4802-9007-96F2494AC512
TagKeysobject []

标签键集合。

Typestring

标签键的类型。取值:

  • Custom:用户自定义类型。
  • System:系统类型。
Custom
TagKeystring

标签键。

FinanceDept

示例

正常返回示例

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "DE65F6B7-7566-4802-9007-96F2494AC512",
  "TagKeys": {
    "TagKey": [
      {
        "Type": "Custom",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400BothEmpty.TagsAndResourcesThe specified Tags and ResourcesIds are not allow to both empty.标签和资源组不能同时为空
400MissingParameter.TagKeyThe input parameter TagKey that is mandatory for processing this request is not supplied.缺少参数TagKey
400MissingParameter.TagValueThe input parameter TagValue that is mandatory for processing this request is not supplied.缺少参数TagValue
400InvalidTagKeyThe tag keys are not valid.无效的标签索引
400InvalidTagValueThe tag values are not valid.无效的标签值
400MissingParam%s-
400InvalidInstanceType.NotFoundThe instance type is not found实例类型没有找到
400InvalidInstanceIds.NotFoundThe instanceIds are not found实例ID没有找到
400Forbidden.TagKeysThe request do not allow to operate the tag keys没有权限操作TagKeys
400QuotaExceeded.TagNumCustom Tags quota exceededquota超限
400Forbidden.NotAllowedCategaryThe System tag is not valid系统tag无效
400Forbidden.TagKeysThe request does not allow operate this tagkeys该请求不允许操作此 tagkey
400Forbidden.TagKey.DuplicatedThe specified tag key already exists.标签资源重复
400SizeLimitExceeded.TagNumThe maximum number of tags is exceeded.标签数量超限
400SizeLimitExceeded.ResourceIdThe maximum number of resource IDs is exceeded.资源组ID数目超限
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。

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

  • 本页导读 (1)
文档反馈