Queries the tag keys of an Application Load Balancer (ALB) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListTagKeys

The operation that you want to perform.

Set the value to ListTagKeys.

NextToken String No FFmyTO70tTpLG6I3FmYAXGKPd****

The start position of the query. If this parameter is left empty, the query starts from the beginning.

MaxResults Integer No 10

The maximum number of entries to return.

ResourceType String Yes loadbalancer

The type of resource. Valid values:

  • acl: an access control list (ACL)
  • loadbalancer: an ALB instance
  • securitypolicy: a security policy
  • servergroup: a server group
Category String No System

The type of tag.

Valid values: Custom, System, and All.

Default value: All.

Keyword String No test

The key of the resource tag.

Response parameters

Parameter Type Example Description
MaxResults Integer 10

The maximum number of entries returned.

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

The token for the next query.

RequestId String 593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3

The ID of the request.

TagKeys Array of TagKey

The tag keys.

Category String System

The type of tag.

Valid values: Custom, System, and All.

Default value: All.

TagKey String test

The tags that match all the filter conditions.

TotalCount Integer 10

The maximum number of entries returned.

Valid values: 1 to 100.

Default value: 20. This value indicates that this parameter is not set.

Note This parameter is optional.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListTagKeys
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=10
&ResourceType=loadbalancer
&Category=System
&Keyword=test
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTagKeysResponse>
    <MaxResults>10</MaxResults>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3</RequestId>
    <TagKeys>
        <Category>System</Category>
        <TagKey>test</TagKey>
    </TagKeys>
    <TotalCount>10</TotalCount>
</ListTagKeysResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.