Updating the Migration Status of a Source Server
Function
This API is used to update the migration status of a source server.
The request parameters are not verified and the update does not take effect if the source server is in the unavailable, stopping, stopped, deleting, finished, clearing, or clearfailed state.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
sms:server:updateState
Write
server *
-
sms:server:migrationServer
-
-
g:EnterpriseProjectId
URI
PUT /v3/sources/{source_id}/changestate
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
source_id |
Yes |
String |
The ID of the source server in SMS. Minimum: 1 Maximum: 36 |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
copystate |
Yes |
String |
Status of the source server. unavailable: The environment verification fails. waiting init: Initializing. replicate: Replicating. syncing stopping stopped skipping deleting clearing: Clearing snapshot resources. cleared: Snapshot resources cleared. clearfailed: Failed to clear snapshot resources. premigready: Ready for migration drill. premiging: Performing migration drill. premiged: Migration drill completed. premigfailed: Migration drill failed. cloning cutovering: Starting the target server. finished: Target server started. error Enumeration values: |
|
migrationcycle |
Yes |
String |
Migration period. no_ready: not ready. ready_for_test testing tested cutovering: starting the target server. cutovered: target server started. checking setting replicating syncing Enumeration values: |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
- |
String |
The migration task status of a source server was updated. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. Minimum: 0 Maximum: 255 |
|
error_msg |
String |
The error message. Minimum: 0 Maximum: 255 |
|
encoded_authorization_message |
String |
The encrypted authorization information. Minimum: 0 Maximum: 65535 |
|
error_param |
Array of strings |
Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20 |
|
details |
Array of details objects |
The error details. Array Length: 1 - 20 |
Example Requests
This example updates the replication status to WAITING and the migration stage to cutovered for source server dcdbe339-b02d-4578-95a1-9c9c547dxxxx.
PUT https://{endpoint}/v3/sources/dcdbe339-b02d-4578-95a1-9c9c547dxxxx/changestate
{
"copystate" : "WAITING",
"migrationcycle" : "cutovered"
}
Example Responses
Status code: 200
The migration task status of a source server was updated.
{ }
Status code: 403
Authentication failed.
{
"error_code" : "SMS.9004",
"error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.",
"encoded_authorization_message" : "XXXXXX",
"error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
"details" : [ {
"error_code" : "SMS.9004",
"error_msg" : "You do not have permission to perform action XXX on resource XXX."
} ]
}
SDK Sample Code
The SDK sample code is as follows.
This example updates the replication status to WAITING and the migration stage to cutovered for source server dcdbe339-b02d-4578-95a1-9c9c547dxxxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.sms.v3.region.SmsRegion; import com.huaweicloud.sdk.sms.v3.*; import com.huaweicloud.sdk.sms.v3.model.*; public class UpdateCopyStateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); SmsClient client = SmsClient.newBuilder() .withCredential(auth) .withRegion(SmsRegion.valueOf("<YOUR REGION>")) .build(); UpdateCopyStateRequest request = new UpdateCopyStateRequest(); request.withSourceId("{source_id}"); PutCopyStateReq body = new PutCopyStateReq(); body.withMigrationcycle(PutCopyStateReq.MigrationcycleEnum.fromValue("cutovered")); body.withCopystate(PutCopyStateReq.CopystateEnum.fromValue("WAITING")); request.withBody(body); try { UpdateCopyStateResponse response = client.updateCopyState(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
This example updates the replication status to WAITING and the migration stage to cutovered for source server dcdbe339-b02d-4578-95a1-9c9c547dxxxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdksms.v3.region.sms_region import SmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksms.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = SmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(SmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateCopyStateRequest() request.source_id = "{source_id}" request.body = PutCopyStateReq( migrationcycle="cutovered", copystate="WAITING" ) response = client.update_copy_state(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
This example updates the replication status to WAITING and the migration stage to cutovered for source server dcdbe339-b02d-4578-95a1-9c9c547dxxxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := sms.NewSmsClient( sms.SmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateCopyStateRequest{} request.SourceId = "{source_id}" migrationcyclePutCopyStateReq:= model.GetPutCopyStateReqMigrationcycleEnum().CUTOVERED copystatePutCopyStateReq:= model.GetPutCopyStateReqCopystateEnum().WAITING request.Body = &model.PutCopyStateReq{ Migrationcycle: &migrationcyclePutCopyStateReq, Copystate: ©statePutCopyStateReq, } response, err := client.UpdateCopyState(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The migration task status of a source server was updated. |
|
403 |
Authentication failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot