Changing AZs for a Cluster Instance

Function

An availability zone (AZ) is a physical region where resources use independent power supplies and networks. AZs in the same region can communicate with each other through internal networks but are physically isolated.

Multi-AZ deployment is a high-availability solution provided by CSS. You can deploy a cluster across two or three AZs in the same region. This helps prevent data loss and lower the risk of downtime.

This API is used to change AZs by specifying node types.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/azmigrate

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A
cluster_id	Yes	String	Definition: ID of the cluster whose AZs are to be changed. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A
inst_type	Yes	String	Definition: Types of nodes whose AZ is to be changed. Constraints: N/A Value range: all: all node types ess: data node ess-cold: cold data node ess-client: client node ess-master: master node Default value: N/A NOTE: All mission-critical data has been backed up before an AZ switchover. This is to prevent data loss.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
source_az	Yes	String	Definition: AZ where the node is located. Constraints: N/A Value range: N/A Default value: N/A
target_az	Yes	String	Definition: AZ where the node is expected to be distributed. Constraints: N/A Value range: N/A Default value: N/A
migrate_type	Yes	String	Definition: AZ migration method. Constraints: N/A Value range: multi_az_change: HA reconstruction az_migrate: AZ migration Default value: N/A
agency	Yes	String	Definition: Agency name. You can create an agency to allow CSS to call other cloud services. Constraints: The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters. Value range: N/A Default value: N/A
indices_backup_check	No	Boolean	Definition: Whether to check full index snapshots. Constraints: N/A Value range: true: Check for full index snapshots. false: Do not check for full index snapshots. Default value: true

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Change AZs for the current cluster.

POST https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/inst-type/all/azmigrate

{
  "source_az" : "cn-north-4c",
  "target_az" : "cn-north-4a",
  "migrate_type" : "az_migrate",
  "agency" : "css-test-agency"
}

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. The client should not repeat the request without modifications.
403	The request is rejected. The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

Status Code

Description

200

Request succeeded.

400

Invalid request.

The client should not repeat the request without modifications.

403

The request is rejected. The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.