Modifying the Private IP Address for Cross-VPC Access

Function

This API is used to modify the private IP address for cross-VPC access.

URI

POST /v2/{project_id}/instances/{instance_id}/crossvpc/modify

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

Request Parameters

Table 2 Request body parameters
Parameter	Mandatory	Type	Description
advertised_ip_contents	Yes	Map<String,String>	User-defined advertised_ip_contents key-value pair. The key is the listeners IP address. The value is the advertised.listeners IP address or domain name. NOTE: Fill in the items that are not modified during IP address change.

Response Parameters

Status code: 200

Table 3 Response body parameters
Parameter	Type	Description
success	Boolean	Result of the cross-VPC access modification.
results	Array of results objects	Details of the result of the cross-VPC access modification.

Table 4 results
Parameter	Type	Description
advertised_ip	String	advertised.listeners IP address or domain name.
success	Boolean	Status of the cross-VPC access modification.
ip	String	Listeners IP address.

Example Requests

Modifying the private IP address for cross-VPC access.

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/crossvpc/modify

{
  "advertised_ip_contents" : {
    "192.168.245.246" : "192.168.245.247",
    "192.168.197.36" : "192.168.197.38",
    "192.168.190.11" : "192.168.190.11"
  }
}

Example Responses

Status code: 200

The private IP address for cross-VPC access is modified successfully.

{
  "success" : true,
  "results" : [ {
    "advertised_ip" : "192.168.197.36",
    "success" : true,
    "ip" : "192.168.197.36"
  }, {
    "advertised_ip" : "192.168.190.11",
    "success" : true,
    "ip" : "192.168.190.11"
  }, {
    "advertised_ip" : "192.168.245.255",
    "success" : true,
    "ip" : "192.168.245.246"
  } ]
}

Status Codes

Status Code	Description
200	The private IP address for cross-VPC access is modified successfully.

Error Codes

See Error Codes.

Parent topic: Instance Management

Предыдущая статья

Configuring Automatic Topic Creation

Следующая статья

Querying Kafka Cluster Metadata

Была ли эта статья полезна?

Поддержка Юридические документы