ListTagResources - PolarDB - Alibaba Cloud Documentation Center

Queries the labels bound to resources by calling ListTagResources.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

drds:ListTagResources

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ResourceType	string	Yes	The resource type. Set this parameter to INSTANCE.	INSTANCE
NextToken	string	No	The pagination token.	6ab4640a-479b-41d0-ad3c-c6e888bc3d8f
Tag	array<object>	No	The list of labels.
	object	No
Key	string	No	The key of the label.	color
Value	string	No	The value of the label.	red
ResourceId	array	No	The list of resources.
	string	No	The resource ID.	dm-hbgau1zp****

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token.	6ab4640a-479b-41d0-ad3c-c6e888bc3d8f
RequestId	string	The request ID.	58CE1CB0-F0F4-4BA3-B876-135DC47DF52F
Success	boolean	Indicates whether the request was successful.	true
TagResources	object
TagResource	array<object>	The list of label resources.
	object
ResourceType	string	The resource type. The value of this parameter is fixed to INSTANCE.	INSTANCE
TagValue	string	The value of the tag.	1
ResourceId	string	The ID of the resource.	drdshzsd11****
TagKey	string	The key of the tag.	test

Examples

Success response

JSON format

{
  "NextToken": "6ab4640a-479b-41d0-ad3c-c6e888bc3d8f",
  "RequestId": "58CE1CB0-F0F4-4BA3-B876-135DC47DF52F",
  "Success": true,
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "INSTANCE",
        "TagValue": "1",
        "ResourceId": "drdshzsd11****",
        "TagKey": "test"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.tagKey	Check the parameter tagKey %s
400	InvalidParameter.tagValue	Check the parameter tagValue %s
400	InvalidParameter.tags.exceed	Tags num exceed 10
400	InvalidParameter.instanceId.and.tags	you must have one of Tags and InstanceId
400	InvalidParameter.tags.json.error	The parameter tags is not a JsonArray
400	TagService.%s	TagService return errorMsg: %s
400	TagApi.InvalidParameter.resourceId.exceed	ResourceId num exceed 50
400	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.