更新时间:2024-10-15 GMT+08:00
分享

绑定弹性公网IP

功能介绍

绑定弹性公网IP

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取项目ID请参见获取项目ID

最大长度:32

publicip_id

String

弹性公网IP的ID

最小长度:0

最大长度:36

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

publicip

AssociatePublicipsOption object

弹性公网IP对象

表3 AssociatePublicipsOption

参数

是否必选

参数类型

描述

associate_instance_type

String

  • 功能说明:端口所属实例类型
  • 取值范围:PORT、NATGW、VPN、ELB
  • 约束:
    • associate_instance_type和associate_instance_id都不为空时表示绑定实例
    • associate_instance_type字段不允许为空
    • 双栈公网IP不允许修改绑定的实例

最小长度:0

最大长度:36

枚举值:

  • PORT
  • NATGW
  • VPN
  • ELB

associate_instance_id

String

  • 功能说明:绑定的实例ID,例如ELB的实例ID,ECS的网卡ID
  • 约束:
    • associate_instance_type和associate_instance_id都不为空时表示绑定实例
    • associate_instance_id不允许为空
    • 双栈公网IP不允许修改绑定的实例

最小长度:0

最大长度:36

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

本次请求的编号

最小长度:0

最大长度:36

publicip

PublicipInstanceResp object

绑定弹性公网IP的返回对象

表5 PublicipInstanceResp

参数

参数类型

描述

id

String

  • 功能说明:弹性公网IP唯一标识

最小长度:0

最大长度:36

project_id

String

  • 功能说明:项目ID

最小长度:0

最大长度:32

ip_version

Integer

  • 功能说明:IP版本信息
  • 取值范围:
    • 4:表示公网IP地址为public_ip_address地址
    • 6:表示公网IP地址为public_ipv6_address地址

枚举值:

  • 4
  • 6

public_ip_address

String

  • 功能说明:弹性公网IP或者IPv6端口的地址

最小长度:0

最大长度:36

public_ipv6_address

String

  • 功能说明:IPv4时无此字段,IPv6时为申请到的弹性公网IP地址

最小长度:0

最大长度:64

status

String

  • 功能说明:弹性公网IP的状态
  • 取值范围:
    • FREEZED:冻结
    • BIND_ERROR:绑定失败
    • BINDING:绑定中
    • PENDING_DELETE:释放中
    • PENDING_CREATE:创建中
    • NOTIFYING:创建中
    • NOTIFY_DELETE:释放中
    • PENDING_UPDATE:更新中
    • DOWN:未绑定
    • ACTIVE:绑定
    • ELB:绑定ELB
    • VPN:绑定VPN
    • ERROR:失败

枚举值:

  • FREEZED
  • BIND_ERROR
  • BINDING
  • PENDING_DELETE
  • PENDING_CREATE
  • NOTIFYING
  • NOTIFY_DELETE
  • PENDING_UPDATE
  • DOWN
  • ACTIVE
  • ELB
  • ERROR
  • VPN

description

String

  • 功能说明:弹性公网IP描述信息
  • 约束:用户以自定义方式标识资源,系统不感知

最小长度:1

最大长度:255

public_border_group

String

  • 功能说明:表示中心站点资源或者边缘站点资源
  • 取值范围: center、边缘站点名称
  • 约束:publicip只能绑定该字段相同的资源

最小长度:1

最大长度:64

created_at

String

  • 功能说明:资源创建UTC时间
  • 格式:yyyy-MM-ddTHH:mm:ssZ

updated_at

String

  • 功能说明:资源更新UTC时间
  • 格式:yyyy-MM-ddTHH:mm:ssZ

type

String

  • 功能说明:弹性公网IP类型

最小长度:1

最大长度:36

枚举值:

  • 弹性公网IP
  • DUALSTACK

vnic

VnicInfo object

  • 功能说明:公网IP绑定实例有PORT时,PORT的相关信息
  • 约束:如果绑定的实例不依赖PORT,该对象为null

bandwidth

PublicipBandwidthInfo object

  • 功能说明:公网IP绑定带宽信息

enterprise_project_id

String

  • 功能说明:企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。创建弹性公网IP时,给弹性公网IP绑定企业项目ID。

最小长度:0

最大长度:36

billing_info

String

  • 功能说明:公网IP的订单信息
  • 约束:包周期才会有订单信息,按需资源此字段为空

最小长度:0

最大长度:256

lock_status

String

  • 功能说明:记录公网IP当前的冻结状态
  • 约束:metadata类型,标识欠费冻结、公安冻结
  • 取值范围:police,locked

最小长度:0

最大长度:64

associate_instance_type

String

  • 功能说明:公网IP绑定的实例类型
  • 取值范围:PORT、NATGW、ELB、ELBV1、VPN
  • 约束:ELBV1资源中国站已下线,目前仅存在国际站与和营云局点

最小长度:0

最大长度:64

枚举值:

  • PORT
  • NATGW
  • ELB
  • ELBV1
  • VPN

associate_instance_id

String

  • 功能说明:公网IP绑定的实例ID

最小长度:0

最大长度:64

publicip_pool_id

String

  • 功能说明:公网IP所属网络的ID。publicip_pool_name对应的网络ID

最小长度:0

最大长度:36

publicip_pool_name

String

  • 功能说明:弹性公网IP的网络类型, 包括公共池类型,如5_bgp/5_sbgp...,和用户购买的专属池。
  • 专属池见publcip_pool相关接口

最小长度:0

最大长度:64

alias

String

  • 功能说明:弹性公网IP名称

最小长度:0

最大长度:64

表6 VnicInfo

参数

参数类型

描述

private_ip_address

String

  • 功能说明:私网IP地址

最小长度:0

最大长度:36

device_id

String

  • 功能说明:端口所属设备ID
  • 约束:不支持设置和更新,由系统自动维护

最小长度:0

最大长度:36

device_owner

String

  • 功能说明:设备所属
  • 取值范围:合法设备所属
    • network:dhcp
    • network:VIP_PORT
    • network:router_interface_distributed
    • network:router_centralized_snat
  • 约束:不支持设置和更新,由系统自动维护

最小长度:0

最大长度:64

vpc_id

String

  • 功能说明:虚拟私有云ID

最小长度:0

最大长度:36

port_id

String

  • 功能说明:端口ID

最小长度:0

最大长度:36

port_profile

String

  • 功能说明:端口profile信息

最小长度:0

最大长度:256

mac

String

  • 功能说明:端口MAC地址
  • 约束:由系统分配,不支持指定

最小长度:0

最大长度:64

vtep

String

  • 功能说明:VTEP IP

最小长度:0

最大长度:36

vni

String

  • 功能说明:VXLAN ID

最小长度:0

最大长度:36

instance_id

String

  • 功能说明:端口所属实例ID,例如RDS实例ID
  • 约束:不支持设置和更新,由系统自动维护

最小长度:0

最大长度:36

instance_type

String

  • 功能说明:端口所属实例类型,例如“RDS”
  • 约束:不支持设置和更新,由系统自动维护

最小长度:0

最大长度:36

port_vif_details

String

  • 功能说明:网卡虚拟接口的详细信息

最小长度:0

最大长度:255

表7 PublicipBandwidthInfo

参数

参数类型

描述

id

String

  • 功能描述:带宽ID

最小长度:0

最大长度:36

size

Integer

  • 功能描述:带宽大小
  • 取值范围:默认5Mbit/s~2000Mbit/s

最小值:0

最大值:99999

share_type

String

  • 功能说明:带宽类型,标识是否是共享带宽
  • 取值范围:
    • PER:独享带宽
    • WHOLE:共享带宽
  • 约束:其中IPv6暂不支持WHOLE类型带宽。

最小长度:0

最大长度:36

charge_mode

String

  • 功能说明:按流量计费还是按带宽计费
  • 取值范围:
    • bandwidth:按带宽计费
    • traffic:按流量计费
    • 95peak_plus:按增强型95计费

最小长度:0

最大长度:36

name

String

  • 功能说明:带宽名称
  • 取值范围:1-64个字符,支持数字、字母、中文字符、_(下划线)、-(中划线)、.(点)

最小长度:0

最大长度:64

billing_info

String

  • 功能说明:账单信息。如果billinginfo不为空,说明是包周期的带宽

最小长度: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,
          "port_vif_details" : "{\"primary_interface\": true}"
        }
      },
      "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
37
# coding: utf-8

import os
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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["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操作正常返回

错误码

请参见错误码

相关文档