All Products
Search
Document Center

Server Migration Center:ListAccessTokens

Last Updated:Oct 29, 2024

Queries activation codes and the usage details of the activation codes.

Operation description

You can call this operation to query activation codes and the usage details of the activation codes. An activation code can be in the activated, unactivated, or expired state.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
smc:ListAccessTokensget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AccessTokenIdarrayNo

The information about activation codes.

stringNo

The information about the activation code.

at-bp1akz2zp67r0k6r****
NamestringNo

The name of the activation code.

test_name
StatusstringNo

The status of the activation code. Valid values:

  • activated
  • unactivated
  • expired
activated

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

E2DA3097-79B9-53AE-B0DF-281DC54F****
AccessTokensarray<object>

The activation codes returned.

AccessTokenobject

The activation codes returned.

AccessTokenIdstring

The ID of the activation code.

at-bp1akz2zp67r0k6r****
TimeToLiveInDaysstring

The validity period of the activation code. Unit: day. Valid values: 1 to 90. Default value: 30.

30
Countstring

The maximum number of times that the activation code can be used. Valid values: 1 to 1000.

Default value: 100.

100
RegisteredCountstring

The number of migration sources whose information has been imported to Server Migration Center (SMC) by using the activation code.

5
CreationTimestring

The time when the activation code was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2022-09-09T02:35:44Z
Statusstring

The status of the activation code. Valid values:

  • activated
  • unactivated
  • expired
activated
Namestring

The name of the activation code.

test_name
Descriptionstring

The description of the activation code.

This is an activation code
TotalCountinteger

The total number of migration sources returned.

2
PageSizeinteger

The page number.

1
PageNumberinteger

The number of entries per page. Valid values:

  • 10
  • 20
  • 50

Default value: 20.

20

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
500InternalErrorAn 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.

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

Change history

Change timeSummary of changesOperation
No change history