调用DescribeTags查询满足筛选条件的标签列表_专有网络VPC(VPC)-阿里云帮助中心

调用DescribeTags接口查询满足筛选条件的标签列表。

接口说明

请求中至少指定参数ResourceId.N或Tag.N（Tag.N.Key与Tag.N.Value），以确定检索对象。
Tag.N是资源的标签，由一个键值对组成。仅指定Tag.N.Key时，则返回该标签键关联的所有标签值。仅指定Tag.N.Value会报错。
如果您同时指定Tag.N和ResourceId.N筛选标签，则ResourceId.N须满足任意输入的标签键值对。
如果您同时指定多个标签键值对，返回结果为所有满足任意标签值对的标签。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeTags	get	全部资源 ``	vpc:tag	无

请求参数

名称	类型	必填	描述	示例值
ResourceType	string	否	资源类型。取值： VPC：表示资源类型为专有网络实例。 VSWITCH：表示资源类型为交换机实例。 ROUTETABLE：表示资源类型为路由表实例。 EIP：表示资源类型为弹性公网 IP 实例。 VPNGATEWAY：表示资源类型为 VPN 网关实例。 NATGATEWAY：表示资源类型为 NAT 网关实例。 COMMONBANDWIDTHPACKAGE：表示资源类型为共享带宽实例。 PREFIXLIST：表示资源类型为前缀列表实例。 PUBLICIPADDRESSPOOL：表示资源类型为 IP 地址池实例。 IPV4GATEWAY：表示资源类型为 IPv4 网关实例。 IPV6GATEWAY：表示资源类型为 IPv6 网关实例。 NETWORKACL：表示资源类型为网络 ACL 实例。 TRAFFICMIRRORFILTER：表示资源类型为流量镜像筛选条件实例。 TRAFFICMIRRORSESSION：表示资源类型为流量镜像会话实例。 FLOWLOG：表示资源类型为流日志实例。 HAVIP：表示资源类型为高可用虚拟 IP 实例。 DHCPOPTIONSSET：表示资源类型为 DHCP 选项集实例。 GATEWAYENDPOINT：表示资源类型为网关终端节点实例。说明输入的资源类型取值不区分大小写。	VPC
RegionId	string	是	资源所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResult	integer	否	分页大小，取值范围：1~50，默认值：50。	50
ResourceId	array	否	资源 ID。最多支持输入 50 个资源 ID。
	string	否	资源 ID。最多支持输入 50 个资源 ID。说明当输入此参数时，必须输入 ResourceType 参数。	vpc-bp16qjewdsunr41m1****
Tag	array<object>	否	资源的标签集合。
	object	否	资源的标签集合。
Key	string	否	资源的标签键。最多支持输入 20 个标签键。一个标签键最多支持 128 个字符，不能是空字符串，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	资源的标签值。最多支持输入 20 个标签值。一个标签值最多支持 128 个字符，可以是空字符串，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua

返回参数

名称	类型	描述	示例值
	object	object
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	请求 ID。	C46FF5A8-C5F0-4024-8262-B16B639225A0
TagResources	array<object>	所有满足筛选条件的标签列表。
TagResource	object	标签列表。
TagValue	string	标签值。	FinanceJoshua
TagKey	string	标签键。	FinanceDept

示例

正常返回示例

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "FinanceJoshua",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

错误码

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

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