Creating Shard or Config IP Addresses of a Cluster Instance

API Description

This API is used to create the IP addresses of shard or config nodes.

Constraints

Frozen instances do not support this operation.
DB instances associated with the IPv6 subnet do not support this operation.
If the IP address is enabled, restart the nodes for the setting to take effect.
This function cannot be disabled after being enabled.

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
dds:instance:createIp	write	-	-	-	-

URI

URI format
POST /v3/{project_id}/instances/{instance_id}/create-ip
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/create-ip

**Table 1** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	string	path	Definition Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Parameter description
Name	Type	Mandatory	Description
type	String	Yes	Definition Cluster instance type. Constraints When adding a shard group, set the value to shard. When adding a config group, set the value to config. Range N/A Default Value N/A
target_id	String	No	Definition Shard group ID. Constraints CAUTION: If the shard or config IP address is added for the first time, leave this parameter empty. If a shard IP address has been added to a DB instance, you need to specify this parameter to add an IP address to the new shard group. Range N/A Default Value N/A
password	String	Yes	Definition The password for enabling this function for a cluster. Constraints Enter a strong password to improve security, preventing security risks such as brute force cracking. CAUTION: This password cannot be changed. Exercise caution when performing this operation. Range The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ~!@#%^-_=+? Default Value* N/A

Example Request

Creating the config IP address of a cluster instance

POST https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/create-ip

{
"type" : "config",
"password" : "******"
}

Creating the shard IP address of a cluster instance for the first time

POST https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/create-ip

{
"type" : "shard",
"password" : "******"
}

Creating the IP address for a newly-added shard group

POST https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/create-ip

{
"type" : "shard",
"target_id" : "91bac9f23ead42e19013333e05f44829gr02",
"password" : "******"
}

Response

Parameter description
None
Example Response
None

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.