All Products
Search
Document Center

Security Center:GetSwitchRegionDetail

Last Updated:Feb 20, 2024

Queries the status and progress of the task that is run to migrate a server from a region inside the Chinese mainland to the Singapore region.

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
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
en

Response parameters

ParameterTypeDescriptionExample
object

PlainResult

Dataobject

The response parameters.

IsAgreestring

Indicates whether the migration is approved.

true
GmtIsAgreeModifiedlong

The time when the permissions were modified.

1692858597000
IsNoticedstring

Indicates whether the notification is sent.

YES
GmtNoticedlong

The notification time.

1692858597000
RegionStatusobject []

The status of the switching to the region.

EcsCountinteger

The number of ECS instances.

27
RegionIdstring

The region in which the server resides.

us-east-1
Statusinteger

The migration status. Valid values:

  • 0: pending
  • 1: successful
0
GmtPlanSwitchTimelong

The time when the migration is scheduled.

1692858597000
RequestIdstring

The request ID.

30CBF632-109F-596F-97F2-451C8B2A****

Examples

Sample success responses

JSONformat

{
  "Data": {
    "IsAgree": "true",
    "GmtIsAgreeModified": 1692858597000,
    "IsNoticed": "YES",
    "GmtNoticed": 1692858597000,
    "RegionStatus": [
      {
        "EcsCount": 27,
        "RegionId": "us-east-1",
        "Status": 0,
        "GmtPlanSwitchTime": 1692858597000
      }
    ]
  },
  "RequestId": "30CBF632-109F-596F-97F2-451C8B2A****"
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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