ListTagResources

Updated at: 2025-02-21 07:41

Queries tags that are added to Virtual Private Cloud (VPC) peering connections.

Operation description

  • Set ResourceId.N or Tag.N that consists of Tag.N.Key and Tag.N.Value in the request to specify the object to be queried.
  • Tag.N is a resource tag that consists of a key-value pair. If you set only Tag.N.Key, all tag values that are associated with the specified key are returned. If you set only Tag.N.Value, an error message is returned.
  • If you set Tag.N and ResourceId.N to filter tags, ResourceId.N must match all specified key-value pairs.
  • If you specify multiple key-value pairs, resources that contain these key-value pairs are returned.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
vpc:ListTagResourceslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
ResourceTypestringYes

The type of the resource. Set the value to PeerConnection, which specifies a VPC peering connection.

PeerConnection
ResourceIddeprecatedarrayNo

The resource ID.

stringNo

The ID of the resource. You can specify up to 20 resource IDs.

Note
Specify at least one of the ResourceId.N and Tag.N parameters (Tag.N.Key and Tag.N.Value).
pcc-bp16qjewdsunr41m1****
Tagdeprecatedarray<object>No

The tags.

objectNo
KeystringNo

The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string.

The tag key can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

Note
You must specify ResourceId.N or Tag.N that consists of Tag.N.Key and Tag.N.Value.
FinanceDept
ValuestringNo

The tag value. You can specify at most 20 tag values. The tag value can be an empty string.

The tag value can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

Note
You must specify ResourceId.N or Tag.N that consists of Tag.N.Key and Tag.N.Value.
FinanceJoshua
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 1 to 50. Default value: 50.

50
NextTokenstringNo

The token that is used for the next query. Valid values:

  • If this is your first query or no subsequent query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned in the last call.
FFmyTO70tTpLG6I3FmYAXGKPd****
RegionIdstringYes

The region ID of the resource.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
CategorystringNo

Tag Type:

  • All(Default)
  • Custom
  • System
All

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

DE65F6B7-7566-4802-9007-96F2494AC512
TagResourcesarray<object>

The resources to which the tags are added.

TagResultModelListobject
ResourceIdstring

The ID of the resource.

pcc-bp16qjewdsunr41m1****
ResourceTypestring

The type of the resource. The value is set to PeerConnection, which indicates a VPC peering connection.

PeerConnection
RegionNostring

The region of the requester VPC.

cn-hangzhou
TagKeystring

The tag key.

FinanceDept
TagValuestring

The tag value.

FinanceJoshua
NextTokenstring

The token that is used for the next query. Valid values:

  • If NextToken is empty, it indicates that no next query is to be sent.
  • If NextToken is returned, the value indicates the token that is used for the next query.
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

The number of entries returned per page.

50

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
HTTP status codeError codeError messageDescription
400InvalidTagKeyThe tag keys are not valid.The tag index is invalid.
400NumberExceed.TagsThe maximum number of tags is exceeded.The number of tags has reached the upper limit.
400NumberExceed.ResourceIdsThe maximum number of resource IDs is exceeded.The number of resource group IDs exceeds the upper limit.
400Forbidden.TagKeysThe tag key cannot be operated by the request.You cannot manage the tag key by calling the operation.
400Forbidden.TagKey.DuplicatedThe specified tag key already exists.The tag resources are duplicate.
400InvalidInstanceIds.NotFoundThe instance IDs are not found.The instance ID is invalid.
400InvalidInstanceType.NotFoundThe instance type is not found.The instance type is invalid.
400BothEmpty.TagsAndResourcesThe specified Tags and ResourcesIds are not allow to both empty.The tag and resource information cannot be empty at the same time.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2025-02-20The Error code has changed. The request parameters of the API has changedView Change Details
2025-02-10The Error code has changedView Change Details
2023-12-08API Description Update. The Error code has changedView Change Details
2023-07-25The Error code has changedView Change Details
  • On this page (1)
  • Operation description
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback