Use GetSwitchRegionDetail to query migration operation status - Security Center - Alibaba Cloud - Security Center

Queries the progress of a service switchover. For example, when a server connection is being migrated from China to Singapore, this operation retrieves the migration progress and status.

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

yundun-sas:GetSwitchRegionDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type for the request and response messages. Default value: zh. Valid values: zh: Chinese en: English.	en
Type	string	No	The service switchover type. Valid values: sg_switch: The server connection is migrated from China to Singapore. sls_meta_version_switch_stage_1: The log analysis delivery field upgrade switchover.	sg_switch

Response elements

Element	Type	Description	Example
	object	PlainResult
Data	object	The response data.
IsAgree	string	Indicates whether the migration is agreed to.	true
GmtIsAgreeModified	integer	The time when the authorization operation was modified.	1692858597000
IsNoticed	string	Indicates whether the notification has been sent.	YES
GmtNoticed	integer	The notification time.	1692858597000
RegionStatus	array<object>	The switchover status of the region.
	object	The data.
EcsCount	integer	The number of ECS instances.	27
RegionId	string	The region in which the server resides.	us-east-1
Status	integer	The migration status. Valid values: 0: pending 1: successful	0
GmtPlanSwitchTime	integer	The time when the migration is scheduled.	1692858597000
NeedSwitch	boolean	Indicates whether a switchover to the new console is required. true: A switchover to the new console is required. false: The legacy console is still in use.	true
NeedNotice	boolean	Indicates whether a pop-up notification needs to be displayed to the user. true: A pop-up notification needs to be displayed. false: No pop-up notification needs to be displayed.	false
RequestId	string	The ID of the request. The China Chinese mainland generates a unique identifier for each request, which can be used for troubleshooting and diagnostics.	30CBF632-109F-596F-97F2-451C8B2A****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.