Use ListTagKeys to query tag keys - Server Load Balancer - Alibaba Cloud - Server Load Balancer

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

alb:ListTagKeys

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
ResourceType	string	Yes	The type of the resource. Valid values: acl: an access control list (ACL) loadbalancer: an Application Load Balancer (ALB) instance securitypolicy: a security policy servergroup: a server group	loadbalancer
Category	string	No	The type of the tag. Valid values: Custom, System, and All. Default value: All.	System
Keyword	string	No	The tag key used to filter results. The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.	test

Response elements

Element	Type	Description	Example
	object	The tag key.
MaxResults	integer	The number of entries per page.	20
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that determines the start point of the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3
TagKeys	array<object>	The tag keys.
	object	The tag key.
Category	string	The type of the tag. Valid values: Custom, System, and All. Default value: All.	System
TagKey	string	The tag key that matches all filter conditions.	test
TotalCount	integer	The total number of entries returned.	10

Examples

Success response

JSON format

{
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3",
  "TagKeys": [
    {
      "Category": "System",
      "TagKey": "test"
    }
  ],
  "TotalCount": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.