ListTagResources API Overview for Lindorm Tag Queries - Lindorm - Alibaba Cloud - Lindorm

Retrieves the associations between Lindorm instances and tags.

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

lindorm:ListTagResources

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the instance resides. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
ResourceId	array	No	The list of resource IDs.
	string	No	The instance ID. You can query the associations between multiple instances and tags by specifying multiple instance IDs. You can call the GetLindormInstanceList operation to obtain the instance IDs.	ld-bp17j28j2y7pm****
NextToken	string	No	The token that is used to start the next query to return more results. Note You do not need to specify this parameter for the first query. If a query does not return all results, you can pass the NextToken value returned in the previous query to continue the query.	212db86****
ResourceType	string	Yes	The resource type. Set the value to INSTANCE.	INSTANCE
Tag	array<object>	No	The list of tags.
	object	No
Key	string	No	The tag key. Note You can specify multiple tag keys. For example, the Key in the first pair specifies the first tag key, and the Key in the second pair specifies the second tag key.	test
Value	string	No	The tag value. Note You can specify multiple tag values. For example, the Value in the first pair specifies the first tag value, and the Value in the second pair specifies the second tag value.	2.2.8

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	05CB115C-91CB-529F-9098-50C1F6CB3BD3
TagResources	array<object>	The list of resources.
	object
ResourceType	string	The resource type. The value is fixed as ALIYUN::HITSDB::INSTANCE.	ALIYUN::HITSDB::INSTANCE
TagValue	string	The tag value.	2.2.8
ResourceId	string	The resource ID, which is the instance ID.	ld-bp17j28j2y7pm****
TagKey	string	The tag key.	test
NextToken	string	The token that is used to start the next query. Note This parameter is returned if a query does not return all results. You can pass the value of this parameter in a subsequent query to continue the query.	212db86****

Examples

Success response

JSON format

{
  "RequestId": "05CB115C-91CB-529F-9098-50C1F6CB3BD3",
  "TagResources": [
    {
      "ResourceType": "ALIYUN::HITSDB::INSTANCE",
      "TagValue": "2.2.8",
      "ResourceId": "ld-bp17j28j2y7pm****",
      "TagKey": "test"
    }
  ],
  "NextToken": "212db86****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Lindorm.Errorcode.MissingParameter	You must specify ResourceId.N or Tags	Specify an instance ID or a tag.
400	Lindorm.Errorcode.NumberExceed.Tags	The maximum number of Tags is exceeded.	The number of tags exceeds the limit. A maximum of 20 tags are allowed.
400	Lindorm.Errorcode.NumberExceed.ResourceIds	The maximum number of ResourceIds is exceeded.	The number of instances exceeds the limit. A maximum of 50 instances are allowed.
403	API.Forbidden	The API operation is forbidden in this environment.	This operation is not supported in the current environment.
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.	You are not authorized to manage the specified resource.
403	Lindorm.Errorcode.ServiceLinkedRoleNoPermission	No permission to create service linked role.	You are not authorized to create the service-linked role.
404	Lindorm.Errorcode.InstanceNotFound	The instance is not found.	The specified instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.