All Products
Search
Document Center

Server Migration Center:ListAccessTokens

Last Updated:Mar 03, 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

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

Authorization information

There is currently no authorization information disclosed in the API.

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****
AccessTokensobject []

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