ListTagResources - Server Load Balancer - Alibaba Cloud Documentation Center

Lists the tags that are attached to specified resources.

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

gwlb:ListTagResources

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type. Valid values: loadbalancer: a Gateway Load Balancer (GWLB) instance. listener: a listener. servergroup: a server group.	loadbalancer
ResourceId	array	No	A list of resource IDs. You can specify up to 50 resource IDs in each call.
	string	No	The resource ID.	gwlb-nrnrxwd15en27r****
Tag	array<object>	No	A list of tags. You can specify up to 20 tags in each call.
	object	No	The tag.
Key	string	No	The tag key.	testKey
Value	string	No	The tag value.	testValue
NextToken	string	No	The token that is used to retrieve the next page of results. Valid values: If the NextToken parameter is empty, it indicates that no subsequent query is required. If a value is returned for NextToken, the value is the token that is used to retrieve the next page of results.	WyI2NDQ3MWUxM2EzOWNhMmY0Y2M2YTRiNzZhOWQwNmU1Y2RlNTYzMGEzIiwibiIsIm4iLDEsLTEsMTY5ODcxMzI2NjU0MywiNjU0MDRlYjI2MmI3MDhjY2JiMjM0ZmU0ODNkNTVmMGRhZDllOTBi****
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 1000. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object	The response that is returned.
NextToken	string	The token that is used to retrieve the next page of results. Valid values: If the NextToken parameter is empty, it indicates that no subsequent query is required. If a value is returned for NextToken, the value is the token that is used to retrieve the next page of results.	d209f4e63ec942c967c50c888a13****
RequestId	string	The request ID.	A95325A2-E421-58A6-88AD-7A26CE610F45
TagResources	array<object>	The list of tag resources.
	object	The information about the tags that are attached to the resource.
ResourceId	string	The resource ID.	gwlb-nrnrxwd15en27r****
ResourceType	string	The resource type. Valid values: loadbalancer: a Gateway Load Balancer instance. listener: a listener. servergroup: a server group.	loadbalancer
TagKey	string	The tag key.	testKey
TagValue	string	The tag value.	testValue

Examples

Success response

JSON format

{
  "NextToken": "d209f4e63ec942c967c50c888a13****",
  "RequestId": "A95325A2-E421-58A6-88AD-7A26CE610F45",
  "TagResources": [
    {
      "ResourceId": "gwlb-nrnrxwd15en27r****\n",
      "ResourceType": "loadbalancer",
      "TagKey": "testKey",
      "TagValue": "testValue"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParam.TagsOrResourceIds	The param of TagsOrResourceIds is missing.	The param of TagsOrResourceIds is missing.
400	MissingParam.TagKey	The param of TagKey is missing.	The parameter of tag key is missing.
400	DuplicatedParam.ResourceId	The param of %s is duplicated.	The param of %s is duplicated.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.