All Products
Search
Document Center

AnalyticDB for PostgreSQL:ListTagResources

Last Updated:Mar 03, 2024

Queries a list of tags that are added to AnalyticDB for PostgreSQL instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
gpdb:ListTagResourcesRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ResourceTypestringYes

The storage mode of the instance. Valid values:

  • instance: reserved storage mode
  • ALIYUN::GPDB::INSTANCE: elastic storage mode
instance
NextTokenstringNo

The token used to perform the next query.

caeba0bbb2be03f84eb48b699f0a4883
ResourceIdarrayNo

The ID of instance N. Valid values of N: 1 to 50.

stringNo
gp-2zev51nt17074****
Tagobject []No

The queried tags.

KeystringNo

The key of tag N. The key must be 1 to 128 characters in length.

You can use Tag.N to query instances that have specific tags added. Tag.N consists of Tag.N.Key and Tag.N.Value.

Valid values of N: 1 to 20.

  • If you specify only Tag.N.Key, all instances that have the tag key added are returned.
  • If you specify only Tag.N.Value, the InvalidParameter.TagValue error is returned.
  • If you specify multiple tag key-value pairs at a time, the instances that match all the specified tag key-value pairs are returned.
TestKey
ValuestringNo

The value of tag N. The value must be 1 to 128 characters in length.

Valid values of N: 1 to 20.

TestValue

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The token used to perform the next query.

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

The ID of the request.

5414A4E5-4C36-4461-95FC-23757A20B5F8
TagResourcesobject []

Details about the instances and tags, including the instance IDs, instance modes, and tag key-value pairs.

ResourceTypestring

The storage mode of the instance.

instance
TagValuestring

The tag value.

TestValue
ResourceIdstring

The ID of the instance.

gp-xxxxxxxxxx
TagKeystring

The tag key.

TestKey

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "5414A4E5-4C36-4461-95FC-23757A20B5F8",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "instance",
        "TagValue": "TestValue",
        "ResourceId": "gp-xxxxxxxxxx",
        "TagKey": "TestKey"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history