ListTagResources_专有网络 VPC-阿里云帮助中心

使用说明

请求中至少指定参数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代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListTagResources	系统规定参数。取值：ListTagResources。
ResourceType	String	是	PeerConnection	资源类型。取值：PeerConnection，VPC对等连接。
ResourceId.N	String	否	pcc-bp16qjewdsunr41m1****	资源ID。最多支持输入20个资源ID。说明参数ResourceId.N或Tag.N（Tag.N.Key与Tag.N.Value）至少输入一个。
Tag.N.Key	String	否	FinanceDept	资源的标签键。最多支持20个标签键。一旦传入该值，则不允许为空字符串。最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。说明参数ResourceId.N或Tag.N（Tag.N.Key与Tag.N.Value）至少输入一个。
Tag.N.Value	String	否	FinanceJoshua	资源的标签值。最多支持20个标签值。一旦传入该值，可以为空字符串。最多支持128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。说明参数ResourceId.N或Tag.N（Tag.N.Key与Tag.N.Value）至少输入一个。
MaxResults	Integer	否	50	分批次查询时每次显示的条目数。取值范围：1~50，默认值：50。
NextToken	String	否	FFmyTO70tTpLG6I3FmYAXGKPd****	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。
RegionId	String	是	cn-hangzhou	资源所属的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

返回数据


名称	类型	示例值	描述
RequestId	String	DE65F6B7-7566-4802-9007-96F2494AC512	请求ID。
TagResources	Array of TagResultModelList		绑定标签的资源信息。
ResourceId	String	pcc-bp16qjewdsunr41m1****	资源ID。
ResourceType	String	PeerConnection	资源类型。取值：PeerConnection，VPC对等连接。
RegionNo	String	cn-hangzhou	VPC对等连接发起方的地域。
TagKey	String	FinanceDept	标签键。
TagValue	String	FinanceJoshua	标签值。
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。如果NextToken有返回值，该取值表示下一次查询开始的令牌。
MaxResults	Integer	50	分批次查询时每次显示的条目数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTagResources
&ResourceType=PeerConnection
&ResourceId=["pcc-bp16qjewdsunr41m1****"]
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&MaxResults=50
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTagResourcesResponse>
    <RequestId>DE65F6B7-7566-4802-9007-96F2494AC512</RequestId>
    <TagResources>
        <ResourceId>pcc-bp16qjewdsunr41m1****</ResourceId>
        <ResourceType>PeerConnection</ResourceType>
        <RegionNo>cn-hangzhou</RegionNo>
        <TagKey>FinanceDept</TagKey>
        <TagValue>FinanceJoshua</TagValue>
    </TagResources>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <MaxResults>50</MaxResults>
</ListTagResourcesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "DE65F6B7-7566-4802-9007-96F2494AC512",
  "TagResources" : [ {
    "ResourceId" : "pcc-bp16qjewdsunr41m1****",
    "ResourceType" : "PeerConnection",
    "RegionNo" : "cn-hangzhou",
    "TagKey" : "FinanceDept",
    "TagValue" : "FinanceJoshua"
  } ],
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults" : 50
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidTagKey	The tag keys are not valid.	无效的标签索引
400	NumberExceed.Tags	The maximum number of tags is exceeded.	标签数量超限
400	NumberExceed.ResourceIds	The maximum number of resource IDs is exceeded.	资源组ID数目超限
400	Forbidden.TagKeys	The tag key cannot be operated by the request.	该请求不允许操作此 tagkey
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	标签资源重复
400	InvalidInstanceIds.NotFound	The instance IDs are not found.	实例ID没有找到
400	InvalidInstanceType.NotFound	The instance type is not found.	实例类型没有找到

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