ListAccessTokens - Server Migration Center - Alibaba Cloud Documentation Center

Call the ListAccessTokens operation to query for created activation codes and their statuses.

Operation description

An activation code can have one of the following statuses: activated, unactivated, or expired.

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

smc:ListAccessTokens

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AccessTokenId	array	No	The IDs of the activation codes.
	string	No	An activation code ID.	at-bp1akz2zp67r0k6r****
Name	string	No	The name of the activation code.	test_name
Status	string	No	The status of the activation code. Valid values: activated: The activation code is activated. unactivated: The activation code is not activated. expired: The activation code has expired.	activated

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	E2DA3097-79B9-53AE-B0DF-281DC54F****
AccessTokens	object
AccessToken	array<object>	The details of the activation codes.
	object	The details of an activation code.
AccessTokenId	string	The ID of the activation code.	at-bp1akz2zp67r0k6r****
TimeToLiveInDays	string	The validity period of the activation code in days. The value can be an integer from 1 to 90. Default value: 30.	30
Count	string	The maximum number of times that the activation code can be used. The value can be an integer from 1 to 1,000. Default value: 100.	100
RegisteredCount	string	The number of migration sources registered using the activation code.	5
CreationTime	string	The time when the activation code was created. The time is displayed in the `yyyy-MM-ddTHH:mm:ssZ` format, is in UTC, and follows the ISO 8601 standard.	2022-09-09T02:35:44Z
Status	string	The status of the activation code. Valid values: activated: The activation code is activated. unactivated: The activation code is not activated. expired: The activation code has expired.	activated
Name	string	The name of the activation code.	test_name
Description	string	The description of the activation code.	This is an activation code
TotalCount	integer	The total number of activation codes.	2
PageSize	integer	The number of entries to return on each page. Valid values:	1
PageNumber	integer	The number of entries per page. Valid values: 10 20 50 Default value: 20.	20

Examples

Success response

JSON format

{
  "RequestId": "E2DA3097-79B9-53AE-B0DF-281DC54F****",
  "AccessTokens": {
    "AccessToken": [
      {
        "AccessTokenId": "at-bp1akz2zp67r0k6r****",
        "TimeToLiveInDays": "30",
        "Count": "100",
        "RegisteredCount": "5",
        "CreationTime": "2022-09-09T02:35:44Z",
        "Status": "activated",
        "Name": "test_name",
        "Description": "This is an activation code"
      }
    ]
  },
  "TotalCount": 2,
  "PageSize": 1,
  "PageNumber": 20
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.