绑定弹性公网IP
功能介绍
绑定弹性公网IP
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID 最大长度:32 |
publicip_id |
是 |
String |
弹性公网IP的ID 最小长度:0 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
publicip |
是 |
AssociatePublicipsOption object |
弹性公网IP对象 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
associate_instance_type |
是 |
String |
最小长度:0 最大长度:36 枚举值:
|
associate_instance_id |
是 |
String |
最小长度:0 最大长度:36 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
本次请求的编号 最小长度:0 最大长度:36 |
publicip |
PublicipInstanceResp object |
绑定弹性公网IP的返回对象 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
最小长度:0 最大长度:36 |
project_id |
String |
最小长度:0 最大长度:32 |
ip_version |
Integer |
枚举值:
|
public_ip_address |
String |
最小长度:0 最大长度:36 |
public_ipv6_address |
String |
最小长度:0 最大长度:64 |
status |
String |
枚举值:
|
description |
String |
最小长度:1 最大长度:255 |
public_border_group |
String |
最小长度:1 最大长度:64 |
created_at |
String |
|
updated_at |
String |
|
type |
String |
最小长度:1 最大长度:36 枚举值:
|
vnic |
VnicInfo object |
|
bandwidth |
PublicipBandwidthInfo object |
|
enterprise_project_id |
String |
最小长度:0 最大长度:36 |
billing_info |
String |
最小长度:0 最大长度:256 |
lock_status |
String |
最小长度:0 最大长度:64 |
associate_instance_type |
String |
最小长度:0 最大长度:64 枚举值:
|
associate_instance_id |
String |
最小长度:0 最大长度:64 |
publicip_pool_id |
String |
最小长度:0 最大长度:36 |
publicip_pool_name |
String |
最小长度:0 最大长度:64 |
alias |
String |
最小长度:0 最大长度:64 |
参数 |
参数类型 |
描述 |
---|---|---|
private_ip_address |
String |
最小长度:0 最大长度:36 |
device_id |
String |
最小长度:0 最大长度:36 |
device_owner |
String |
最小长度:0 最大长度:64 |
vpc_id |
String |
最小长度:0 最大长度:36 |
port_id |
String |
最小长度:0 最大长度:36 |
port_profile |
String |
最小长度:0 最大长度:256 |
mac |
String |
最小长度:0 最大长度:64 |
vtep |
String |
最小长度:0 最大长度:36 |
vni |
String |
最小长度:0 最大长度:36 |
instance_id |
String |
最小长度:0 最大长度:36 |
instance_type |
String |
最小长度:0 最大长度:36 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
最小长度:0 最大长度:36 |
size |
Integer |
最小值:0 最大值:99999 |
share_type |
String |
最小长度:0 最大长度:36 |
charge_mode |
String |
最小长度:0 最大长度:36 |
name |
String |
最小长度:0 最大长度:64 |
billing_info |
String |
最小长度:0 最大长度:256 |
请求示例
弹性公网IP绑定实例,传入实例ip和实例类型。
POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance { "publicip" : { "associate_instance_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", "associate_instance_type" : "PORT" } }
响应示例
状态码: 200
POST操作正常返回
{ "publicip" : { "alias" : "abcd", "associate_instance_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", "associate_instance_type" : "PORT", "bandwidth" : { "billing_info" : "xxxx:xxxx:xxxx:xxxx", "charge_mode" : "bandwidth", "id" : "80549ae1-cf7a-4f39-a45f-bdb8e194a1f4", "name" : "bandwidth-bd25-test", "share_type" : "WHOLE", "size" : 7 }, "billing_info" : null, "created_at" : "2020-06-18T14:05:32Z", "description" : "test!!!!", "enterprise_project_id" : "0", "public_border_group" : "center", "id" : "b0c42aa6-3d1d-4b39-9188-35ee6aa8d6f7", "ip_version" : 4, "lock_status" : null, "project_id" : "060576782980d5762f9ec014dd2f1148", "public_ip_address" : "xx.xx.xx.xx", "public_ipv6_address" : null, "publicip_pool_id" : "160576782980d5762f9ec014dd2f1148", "publicip_pool_name" : "5_mobile", "status" : "ACTIVE", "type" : "弹性公网IP", "updated_at" : "2020-06-18T14:05:32Z", "vnic" : { "device_id" : "78aa6d7f-7111-434e-9a93-0dc6fdacff63", "device_owner" : "network:nat_gateway", "instance_id" : "", "instance_type" : "", "mac" : "fa:16:3e:83:6b:0a", "port_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", "port_profile" : null, "private_ip_address" : "xx.xx.xx.xx", "vni" : null, "vpc_id" : "a26c231a-cf6f-48d3-83db-1e261d0e235a", "vtep" : null } }, "request_id" : "ead9f912bd1191e3d5f0037141098d91" }
SDK代码示例
SDK代码示例如下。
弹性公网IP绑定实例,传入实例ip和实例类型。
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 |
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.eip.v3.region.EipRegion; import com.huaweicloud.sdk.eip.v3.*; import com.huaweicloud.sdk.eip.v3.model.*; public class AssociatePublicipsSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("<YOUR REGION>")) .build(); AssociatePublicipsRequest request = new AssociatePublicipsRequest(); AssociatePublicipsRequestBody body = new AssociatePublicipsRequestBody(); AssociatePublicipsOption publicipbody = new AssociatePublicipsOption(); publicipbody.withAssociateInstanceType(AssociatePublicipsOption.AssociateInstanceTypeEnum.fromValue("PORT")) .withAssociateInstanceId("921b9dc7-8151-41e1-b83c-d50fe959592a"); body.withPublicip(publicipbody); request.withBody(body); try { AssociatePublicipsResponse response = client.associatePublicips(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()); } } } |
弹性公网IP绑定实例,传入实例ip和实例类型。
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 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkeip.v3.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.v3 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("<YOUR REGION>")) \ .build() try: request = AssociatePublicipsRequest() publicipbody = AssociatePublicipsOption( associate_instance_type="PORT", associate_instance_id="921b9dc7-8151-41e1-b83c-d50fe959592a" ) request.body = AssociatePublicipsRequestBody( publicip=publicipbody ) response = client.associate_publicips(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
弹性公网IP绑定实例,传入实例ip和实例类型。
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := eip.NewEipClient( eip.EipClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.AssociatePublicipsRequest{} publicipbody := &model.AssociatePublicipsOption{ AssociateInstanceType: model.GetAssociatePublicipsOptionAssociateInstanceTypeEnum().PORT, AssociateInstanceId: "921b9dc7-8151-41e1-b83c-d50fe959592a", } request.Body = &model.AssociatePublicipsRequestBody{ Publicip: publicipbody, } response, err := client.AssociatePublicips(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
POST操作正常返回 |
错误码
请参见错误码。