All Products
Search
Document Center

Resource Orchestration Service:ListTagKeys

Last Updated:Apr 10, 2024

Queries the tag keys that are added to resources in a template or stack in an Alibaba Cloud region.

Operation description

In this example, the tag keys that are added to a stack in the China (Hangzhou) region are queried.

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
ros:ListTagKeysLIST
  • tag
    acs:ros:{#regionId}:{#accountId}:tag/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the tag key. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ResourceTypestringYes

The type of the resource. Valid values:

  • stack: stack
  • stackgroup: stack group
  • template: template
  • templatescratch: scenario
stack
NextTokenstringNo

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

caeba0bbb2be03f84eb48b699f0*****

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

caeba0bbb2be03f84eb48b699f0*****
RequestIdstring

The ID of the request.

C429473A-5C66-4661-B5F8-4F900CD4330A
Keysarray

The tag keys.

string

The tag key. Multiple tag keys are separated by commas (,).

["TagKey1","TagKey2"]

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0*****",
  "RequestId": "C429473A-5C66-4661-B5F8-4F900CD4330A",
  "Keys": [
    "[\"TagKey1\",\"TagKey2\"]"
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history