Creating Shard or Config IP Addresses of a Cluster Instance

API Description

Restrictions

• 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 is available for cluster instances of Community Edition 3.4 or later.
• This function cannot be disabled after being enabled.

URI

• URI format

  POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/create-ip

• URI example

  POST https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/create-ip

Requests

• Parameter description

  Table 2 Parameter description

  Name	Type	Mandatory	Description
  type	String	Yes	Cluster instance type. When applying for a shard IP address, set the value to shard. A read-only user sharduser is automatically created for the shard group. (Each shard group has a read-only user with the same name.) When applying for a config IP address, set the value to config. A read-only user csuser is automatically created for the config group.
  target_id	String	No	Shard group ID. CAUTION: If you apply for a shard or config IP address for the first time and do not specify this parameter, IP addresses for all shard groups are applied for using the same password and a read-only user sharduser is created. In node scale-out scenarios, the system does not automatically apply for an IP address and read-only user sharduser for the new shard group because there is no sharduser user and password of other shard groups. If you need to apply for an IP address for the new shard group, call this API and specify target_id (group ID). If this API is called for multiple times for the same DB instance, the values for the password field can be different. (Each shard group has a read-only user with the same name.)
  password	String	Yes	The password for enabling this function for a cluster. 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 ~!@#%^*-_=+?()$ Enter a strong password to improve security, preventing security risks such as brute force cracking. CAUTION: The password can be changed by calling the API for changing a database user password. After the API for changing a database user password is called, the passwords of the read-only user sharduser of all shard groups are the same when target_id is specified.

• Request example

  config:

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

  shard:

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

  shard:

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

Responses

• Parameter description

  None

• Response example

  {}
  
  
  

Status Code

Error Code