ListTagOptions - Service Catalog - Alibaba Cloud Documentation Center

Lists tag options.

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

servicecatalog:ListTagOptions

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Page number. Start value: 1. Default value: 1.	1
PageSize	integer	No	Number of data rows displayed per page during paging. Value range: 1 to 100. Start value: 1. Default value: 10.	10
Filters	object	No	Filter condition.
Key	string	No	Tag option key.	k1
Value	string	No	Tag option value.	v1
Active	boolean	No	Enable or disable. Values: true (default): Enable. false: Disable.	true
FullTextSearch	string	No	Full text search.	k1
SortBy	string	No	Sorting field. Set to CreateTime to indicate the tag option creation time.	CreateTime
SortOrder	string	No	Sorting order. Values: Asc: Ascending order. Desc (default): Descending order.	Desc
NextToken	string	No
MaxResults	integer	No

Response elements

Element	Type	Description	Example
	object	Return parameters.
RequestId	string	Request ID.	37C9C1DF-EFFC-5D8A-80D0-8657B1F3****
TotalCount	integer	Total records.	10
PageNumber	integer	Page number.	1
PageSize	integer	Number of data rows displayed per page during paging. Value range: 1 to 100. Start value: 1. Default value: 10.	10
TagOptionDetails	array<object>	List of tag option details.
	object
Active	boolean	Enable or disable. Values: true: Enable. false: Disable.	true
TagOptionId	string	Tag option ID.	tag-bp1r3mxq3t****
Key	string	Tag option key.	k1
Value	string	Tag option value.	v1
Owner	string	Alibaba Cloud account ID of the tag option owner.	133413081827****
NextToken	string

Examples

Success response

JSON format

{
  "RequestId": "37C9C1DF-EFFC-5D8A-80D0-8657B1F3****",
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 10,
  "TagOptionDetails": [
    {
      "Active": true,
      "TagOptionId": "tag-bp1r3mxq3t****",
      "Key": "k1",
      "Value": "v1",
      "Owner": "133413081827****\n"
    }
  ],
  "NextToken": ""
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	A system error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.