Updated on 2025-08-05 GMT+08:00

Changing AZs

Function

This API is used to migrate the AZs of a DCS instance to complete the cross-AZ reconstruction of a single-AZ instance.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/instances/{instance_id}/available-zones

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

instance_id

Yes

String

Definition:

Instance ID. It can be viewed on the instance details page on the DCS console.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

new_available_zones

No

Array of strings

Definition:

New AZ.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

execute_immediately

No

Boolean

Definition:

Whether to execute the change immediately.

Constraints:

N/A

Range:

true: Yes

false: No

Default Value:

true

Response Parameters

Status code: 204

The request for changing AZs is submitted successfully.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Example Requests

Changing a single-AZ instance to a multi-AZ one

PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/available-zones

{
  "new_available_zones" : [ "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef", "2eaaff66-fbb0-47ad-b6cb-fb87f5b12fbe" ],
  "execute_immediately" : true
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Changing a single-AZ instance to a multi-AZ one

 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
51
52
53
54
55
56
57
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
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.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class MigrateAzSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        MigrateAzRequest request = new MigrateAzRequest();
        request.withInstanceId("{instance_id}");
        MigrateAZRequestBody body = new MigrateAZRequestBody();
        List<String> listbodyNewAvailableZones = new ArrayList<>();
        listbodyNewAvailableZones.add("2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef");
        listbodyNewAvailableZones.add("2eaaff66-fbb0-47ad-b6cb-fb87f5b12fbe");
        body.withExecuteImmediately(true);
        body.withNewAvailableZones(listbodyNewAvailableZones);
        request.withBody(body);
        try {
            MigrateAzResponse response = client.migrateAz(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());
        }
    }
}

Changing a single-AZ instance to a multi-AZ one

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.v2 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = MigrateAzRequest()
        request.instance_id = "{instance_id}"
        listNewAvailableZonesbody = [
            "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef",
            "2eaaff66-fbb0-47ad-b6cb-fb87f5b12fbe"
        ]
        request.body = MigrateAZRequestBody(
            execute_immediately=True,
            new_available_zones=listNewAvailableZonesbody
        )
        response = client.migrate_az(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Changing a single-AZ instance to a multi-AZ one

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.MigrateAzRequest{}
	request.InstanceId = "{instance_id}"
	var listNewAvailableZonesbody = []string{
        "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef",
	    "2eaaff66-fbb0-47ad-b6cb-fb87f5b12fbe",
    }
	executeImmediatelyMigrateAzRequestBody:= true
	request.Body = &model.MigrateAzRequestBody{
		ExecuteImmediately: &executeImmediatelyMigrateAzRequestBody,
		NewAvailableZones: &listNewAvailableZonesbody,
	}
	response, err := client.MigrateAz(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

204

The request for changing AZs is submitted successfully.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.