更新时间:2025-08-05 GMT+08:00

变更可用区

功能介绍

迁移缓存实例可用区,完成单可用区实例跨可用区改造。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

new_available_zones

Array of strings

参数解释

新可用区。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

execute_immediately

Boolean

参数解释

是否立即执行变更。

约束限制

不涉及。

取值范围

true:立即执行变更。

false:暂不执行变更。

默认取值

true

响应参数

状态码:204

变更可用区请求提交成功。

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:500

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

请求示例

变更单可用区实例为多可用区。

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
}

响应示例

SDK代码示例

SDK代码示例如下。

变更单可用区实例为多可用区。

 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());
        }
    }
}

变更单可用区实例为多可用区。

 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)

变更单可用区实例为多可用区。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

204

变更可用区请求提交成功。

400

非法请求。

500

内部服务错误。

错误码

请参见错误码