All Products
Search
Document Center

:ListTagKeys

Last Updated:Jun 21, 2024

Queries the tag keys of resources within the current account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
tag:ListTagKeysRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MaxResultsintegerNo

The maximum number of entries to return on each page.

Valid values: 1 to 100.

Default value: 20.

10
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results.

If the total number of entries returned for the current request exceeds the value of the MaxResults parameter, the entries are truncated. In this case, you can use the token to initiate another request and obtain the remaining entries.

AAAAAUYb00R0gHZBE8FVDeoh2ME93VeeEPUHs****
TagKeystringNo

The tag key.

test_key
MatchTypestringNo

The matching mode. Valid values:

  • Equals: equal match
  • Prefix: match by prefix
Equals

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

NextTokenstring

The pagination token that is used in the next request to retrieve a new page of results.

AAAAAUDnubHKJbVTCdlIGYUPtsu3EoN3bfdgjDA****
TagKeysarray

The tag keys.

string

A tag key.

test_key
RequestIdstring

The ID of the request.

44C8A952-D6B0-5BC8-82D5-93BA02E26F2E

Examples

Sample success responses

JSONformat

{
  "NextToken": "AAAAAUDnubHKJbVTCdlIGYUPtsu3EoN3bfdgjDA****",
  "TagKeys": [
    "test_key"
  ],
  "RequestId": "44C8A952-D6B0-5BC8-82D5-93BA02E26F2E"
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform the operation.
400InvalidParameter.MaxResultsThe specified parameter MaxResults is not valid.The MaxResults parameter is invalid.
409InvalidParameter.MatchTypeThe specified parameter MatchType is not valid.The MatchType parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history