Modifying the Private IP Address for Cross-VPC Access
Function
This API is used to modify the private IP address for cross-VPC access.
Calling Method
For details, see Calling APIs.
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.
URI
POST /v2/{project_id}/instances/{instance_id}/crossvpc/modify
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| instance_id | Yes | String | Definition Instance ID. To obtain it, call the API for querying all instances. Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| advertised_ip_contents | Yes | Map<String,String> | Definition Custom key-value pair for advertised_ip_contents. The key is the listeners IP address. The value is advertised.listeners IP address or a domain name. A port number can be added. If the port number is not specified, the default port number 9011 will be used. Constraints Fill in the items that are not modified during IP address change. Range If a port number is specified, the port number ranges from 1 to 65535. Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | Definition Result of the cross-VPC access modification. Range |
| results | Array of results objects | Definition Result of the broker's cross-VPC access modification. |
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
{
"success" : true,
"results" : [ {
"advertised_ip" : "192.168.197.38",
"success" : true,
"ip" : "192.168.197.36",
"advertised_port" : 9011
}, {
"advertised_ip" : "192.168.190.11",
"success" : true,
"ip" : "192.168.190.11",
"advertised_port" : 9011
}, {
"advertised_ip" : "192.168.245.247",
"success" : true,
"ip" : "192.168.245.246",
"advertised_port" : 9011
} ]
} SDK Sample Code
The SDK sample code is as follows.
Modifying the private IP address for cross-VPC access.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion; import com.huaweicloud.sdk.kafka.v2.*; import com.huaweicloud.sdk.kafka.v2.model.*; import java.util.Map; import java.util.HashMap; public class UpdateInstanceCrossVpcIpSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); KafkaClient client = KafkaClient.newBuilder() .withCredential(auth) .withRegion(KafkaRegion.valueOf("<YOUR REGION>")) .build(); UpdateInstanceCrossVpcIpRequest request = new UpdateInstanceCrossVpcIpRequest(); request.withInstanceId("{instance_id}"); UpdateInstanceCrossVpcIpReq body = new UpdateInstanceCrossVpcIpReq(); Map<String, String> listbodyAdvertisedIpContents = new HashMap<>(); listbodyAdvertisedIpContents.put("192.168.245.246", "192.168.245.247"); listbodyAdvertisedIpContents.put("192.168.197.36", "192.168.197.38"); listbodyAdvertisedIpContents.put("192.168.190.11", "192.168.190.11"); body.withAdvertisedIpContents(listbodyAdvertisedIpContents); request.withBody(body); try { UpdateInstanceCrossVpcIpResponse response = client.updateInstanceCrossVpcIp(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Modifying the private IP address for cross-VPC access.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkafka.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = KafkaClient.new_builder() \ .with_credentials(credentials) \ .with_region(KafkaRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateInstanceCrossVpcIpRequest() request.instance_id = "{instance_id}" listAdvertisedIpContentsbody = { "192.168.245.246": "192.168.245.247", "192.168.197.36": "192.168.197.38", "192.168.190.11": "192.168.190.11" } request.body = UpdateInstanceCrossVpcIpReq( advertised_ip_contents=listAdvertisedIpContentsbody ) response = client.update_instance_cross_vpc_ip(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Modifying the private IP address for cross-VPC access.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kafka.NewKafkaClient(hcClient) request := &model.UpdateInstanceCrossVpcIpRequest{} request.InstanceId = "{instance_id}" var listAdvertisedIpContentsbody = map[string]string{ "192.168.245.246": "192.168.245.247", "192.168.197.36": "192.168.197.38", "192.168.190.11": "192.168.190.11", } request.Body = &model.UpdateInstanceCrossVpcIpReq{ AdvertisedIpContents: listAdvertisedIpContentsbody, } response, err := client.UpdateInstanceCrossVpcIp(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | The private IP address for cross-VPC access is modified successfully. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot