Changing the VPC A CBH Instance Belongs To_Network Management_API Description_API Reference

Function

This API is used to change the VPC a CBH instance belongs to.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/cbs/instance/vpc

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which uniquely identifies a project. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details, see Obtaining a User Token. Constraints N/A Range String type. The value can contain 1 to 28,000 characters. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
server_id	Yes	String	ID of the instance for which you want to change the VPC it belongs to.
network	Yes	NetworkInfoCreate object	The network information required for changing the VPC the CBH instance belongs to.

**Table 4** NetworkInfoCreate
Parameter	Mandatory	Type	Description
vpc_id	Yes	String	ID of the VPC to which the ECS belongs. The value is in UUID format. You can obtain the VPC ID from the management console or by following the instructions provided in "Querying VPCs" in Virtual Private Cloud API Reference. Example: 03211ecf-xxxx-4306-xxxx-6e939bfxxxxx
subnet_id	Yes	String	Subnet ID, which consists of letters, digits, and underscores (_).
public_ip	Yes	PublicIp object	EIP bound to the CBH instance. The value can be null.
security_groups	Yes	Array of SecurityGroup objects	Security group information.
private_ip	No	PrivateIp object	EIP bound to the CBH instance.

**Table 5** PublicIp
Parameter	Mandatory	Type	Description
id	No	String	ID of the EIP.
public_eip	No	String	Elastic IP address.

**Table 6** SecurityGroup
Parameter	Mandatory	Type	Description
id	Yes	String	ID of the security group that the CBH instance belongs to. The value consists of letters, digits, and underscores (_).

**Table 7** PrivateIp
Parameter	Mandatory	Type	Description
ip	Yes	String	Private IP address.
slave_ip	No	String	Private IP address of standby instance.
floating_ip	No	String	Floating IP address.

Response Parameters

Status code: 200

None

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Incorrect request parameters.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Token verification failed.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Permissions required.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Not CBH instances found.

Example Requests

{
  "server_id" : "0f2c69d1-e420-4ae1-9b43-ab8699883678",
  "network" : {
    "vpc_id" : "760071b3-34a3-4359-bf18-3af24e77c1cf",
    "subnet_id" : "90b6be71-e72a-4d5a-8838-5924bce3c583",
    "private_ip" : {
      "ip" : "192.168.0.3",
      "slave_ip" : null,
      "floating_ip" : null
    },
    "public_ip" : null,
    "security_groups" : [ {
      "id" : "21321412321321321"
    } ]
  }
}

Example Responses

None

Status Codes

Status Code	Description
200	Switch Cbh Instance Vpc Success
400	Bad Request
401	Unauthorized
403	Access denied.
404	Not Found

Error Codes

See Error Codes.

Changing the VPC A CBH Instance Belongs To