文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 弹性公网IP/ 共享带宽加入弹性公网IP
更新时间:2024-08-15 GMT+08:00
分享

共享带宽加入弹性公网IP

功能介绍

共享带宽加入弹性公网IP

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/eip/publicips/{publicip_id}/attach-share-bandwidth

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:32

最大长度:32

publicip_id

String

弹性公网ID

最小长度:36

最大长度:36

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

publicip

AttachSharebwDict object

弹性公网IP对象

表3 AttachSharebwDict

参数

是否必选

参数类型

描述

bandwidth_id

String

  • 带宽id

最小长度:36

最大长度:36

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

publicip

PublicipResp object

弹性公网IP对象

request_id

String

本次请求编号

表5 PublicipResp

参数

参数类型

描述

id

String

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

最小长度:36

最大长度:36

project_id

String

  • 功能说明:项目ID

最小长度:32

最大长度:32

ip_version

Integer

  • 功能说明: 弹性公网IP版本号

  • 取值范围: 4、6,6为开启NAT64能力

    • 4表示公网IP地址为public_ip_address地址

    • 6表示公网IP地址为public_ipv6_address地址

最小值:4

最大值:6

枚举值:

  • 4

  • 6

public_ip_address

String

  • 功能说明: 弹性公网IPv4地址

最小长度:0

最大长度:64

public_ipv6_address

String

  • 功能说明: 弹性公网IPv6地址

最小长度:0

最大长度:64

status

String

  • 功能说明:弹性公网IP的状态

  • 取值范围:FREEZED,DOWN,ACTIVE,ERROR。

    • FREEZED表示弹性公网IP处于冻结状态

    • DOWN表示弹性公网IP未绑定实例

    • ACTIVE表示弹性公网IP绑定实例,正在使用中

    • ERROR表示弹性公网IP状态异常

最小长度:0

最大长度:16

枚举值:

  • FREEZED

  • DOWN

  • ACTIVE

  • ERROR

description

String

  • 功能说明:弹性公网IP的描述信息

  • 约束:用户以自定义方式标识资源,系统不感知

最小长度:0

最大长度:1024

created_at

String

  • 功能说明:弹性公网IP的创建时间

  • 约束:UTC时间格式(2018-12-25T10:07:24Z)

最小长度:0

最大长度:64

updated_at

String

  • 功能说明:弹性公网IP最近的更新时间

  • 约束:UTC时间格式(2018-12-25T10:09:20Z)

最小长度:0

最大长度:64

type

String

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

  • 取值范围:弹性公网IP,DUALSTACK

最小长度:0

最大长度:36

枚举值:

  • 弹性公网IP

  • DUALSTACK

vnic

VnicResp object

  • 功能说明:弹性公网IP绑定实例有PORT时,PORT的相关信息

  • 约束:如果绑定的实例不依赖PORT,该对象为null

bandwidth

BandwidthResp object

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

enterprise_project_id

String

  • 功能说明:弹性公网IP的企业项目ID

最小长度:32

最大长度:32

billing_info

String

  • 功能说明:弹性公网IP的订单信息

  • 约束:包周期才会有订单信息,按需资源此字段为空

最小长度:0

最大长度:1024

lock_status

String

  • 功能说明:记录弹性公网IP当前的冻结状态

  • 约束:metadata类型,标识欠费冻结、公安冻结

最小长度:0

最大长度:36

associate_instance_type

String

  • 功能说明:弹性公网IP绑定的实例类型

  • 取值范围:PORT、NATGW、ELB、ELBV1、VPN

  • 约束:ELBV1资源中国站已下线,目前仅存在国际站与和营云局点

最小长度:0

最大长度:36

枚举值:

  • PORT

  • NATGW

  • ELB

  • ELBV1

  • VPN

associate_instance_id

String

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

最小长度:0

最大长度:36

publicip_pool_id

String

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

最小长度:36

最大长度:36

publicip_pool_name

String

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

最小长度:0

最大长度:128

alias

String

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

最小长度:0

最大长度:255

public_border_group

String

  • 功能说明:中心还是边缘。中心CENTER,边缘为各边缘az名称

最小长度:0

最大长度:64

表6 VnicResp

参数

参数类型

描述

private_ip_address

String

  • 功能说明:PORT的内网地址

最小长度:0

最大长度:36

device_id

String

  • 功能说明:PORT的device_id

  • 约束:存在PORT时,此字段associate_instance_id相同,都为实例ID

最小长度:0

最大长度:36

device_owner

String

  • 功能说明:PORT的device_owner

  • 约束:存在PORT时,此字段和associate_instance_type都可区分实例类型

最小长度:0

最大长度:36

vtep

String

  • 功能说明:VTEP IP

最小长度:0

最大长度:36

vni

String

  • 功能说明:VXLAN ID

最小长度:0

最大长度:36

vpc_id

String

  • 功能说明:PORT所在VPC的ID

最小长度:36

最大长度:36

port_id

String

  • 功能说明:PORT的唯一标识

最小长度:36

最大长度:36

port_profile

String

  • 功能说明:端口profile信息

最小长度:0

最大长度:256

mac

String

  • 功能说明:PORT的MAC信息

最小长度:0

最大长度:36

instance_id

String

  • 功能说明:PORT的使用者,不同于device_id的归属者。举例:vip port的device_owner为vip,但是这个port实际使用者可能是虚机或其他

最小长度:0

最大长度:36

instance_type

String

  • 功能说明:标记PORT使用者,与instance_id组合使用

最小长度:0

最大长度:36

port_vif_details

String

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

最小长度:0

最大长度:255

表7 BandwidthResp

参数

参数类型

描述

id

String

  • 功能说明:带宽ID

最小长度:36

最大长度:36

size

Integer

  • 功能说明:带宽大小

最小值:0

最大值:2000

share_type

String

  • 功能说明:类型 "WHOLE"为共享带宽,"PER"为独占带宽

最小长度:0

最大长度:36

charge_mode

String

  • 功能说明:带宽计费模式

最小长度:0

最大长度:36

name

String

  • 功能说明:带宽名称

最小长度:0

最大长度:255

billing_info

String

  • 功能说明:带宽的订单信息

最小长度:0

最大长度:1024

请求示例

弹性公网IP加入共享带宽,共享带宽的id通过请求参数的bandwidth_id字段传入,弹性公网IP通过url中的publicip_id传入

POST /v3/{project_id}/eip/publicips/{publicip_id}/attach-share-bandwidth

{
  "publicip" : {
    "bandwidth_id" : "e6af636c-ea79-4c20-ba2f-402057ba7886"
  }
}

响应示例

状态码: 200

POST操作正常返回

{
  "publicip" : {
    "alias" : "TT",
    "associate_instance_id" : null,
    "associate_instance_type" : null,
    "bandwidth" : {
      "id" : "c7cd5c85-491f-4423-a691-7c74d28c4fc1",
      "size" : 5,
      "share_type" : "WHOLE",
      "charge_mode" : "bandwidth",
      "name" : "bandwidth-b8ff",
      "billing_info" : ""
    },
    "billing_info" : null,
    "created_at" : "2020-07-10T10:10:18Z",
    "description" : "",
    "enterprise_project_id" : "0",
    "id" : "1175ec9b-852d-4769-bf33-35c5be432cfe",
    "ip_version" : 4,
    "lock_status" : null,
    "project_id" : "8d53f081ea24444aa95e2bfa942ef6ee",
    "public_border_group" : "center",
    "public_ip_address" : "10.246.165.44",
    "public_ipv6_address" : null,
    "publicip_pool_id" : "ece62314-858c-4793-a768-346efca42131",
    "publicip_pool_name" : "5_bgp",
    "status" : "ACTIVE",
    "type" : "弹性公网IP",
    "updated_at" : "2020-07-11T05:03:25Z",
    "vnic" : {
      "device_id" : "cc03e7f7-b820-4a2e-b243-8022daabf0cf",
      "device_owner" : "compute:br-iaas-odin1a",
      "instance_id" : "",
      "instance_type" : "",
      "mac" : "fa:16:3e:7a:5f:db",
      "port_id" : "fb68a8e1-b93e-4100-8735-6d6b0a6a0eb5",
      "port_profile" : "",
      "private_ip_address" : "192.168.3.222",
      "vni" : "435405",
      "vpc_id" : "ac17491b-0769-4d96-b883-6d6295f6afad",
      "vtep" : "18.8.152.158"
    }
  },
  "request_id" : "db4b975a79d1da86dda3d02054f11e16"
}

SDK代码示例

SDK代码示例如下。

弹性公网IP加入共享带宽,共享带宽的id通过请求参数的bandwidth_id字段传入,弹性公网IP通过url中的publicip_id传入

 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
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 AttachShareBandwidthSolution {

    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();
        AttachShareBandwidthRequest request = new AttachShareBandwidthRequest();
        AttachSharebwReq body = new AttachSharebwReq();
        AttachSharebwDict publicipbody = new AttachSharebwDict();
        publicipbody.withBandwidthId("e6af636c-ea79-4c20-ba2f-402057ba7886");
        body.withPublicip(publicipbody);
        request.withBody(body);
        try {
            AttachShareBandwidthResponse response = client.attachShareBandwidth(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加入共享带宽,共享带宽的id通过请求参数的bandwidth_id字段传入,弹性公网IP通过url中的publicip_id传入

 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

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 = AttachShareBandwidthRequest()
        publicipbody = AttachSharebwDict(
            bandwidth_id="e6af636c-ea79-4c20-ba2f-402057ba7886"
        )
        request.body = AttachSharebwReq(
            publicip=publicipbody
        )
        response = client.attach_share_bandwidth(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加入共享带宽,共享带宽的id通过请求参数的bandwidth_id字段传入,弹性公网IP通过url中的publicip_id传入

 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.AttachShareBandwidthRequest{}
	bandwidthIdPublicip:= "e6af636c-ea79-4c20-ba2f-402057ba7886"
	publicipbody := &model.AttachSharebwDict{
		BandwidthId: &bandwidthIdPublicip,
	}
	request.Body = &model.AttachSharebwReq{
		Publicip: publicipbody,
	}
	response, err := client.AttachShareBandwidth(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

POST操作正常返回

错误码

请参见错误码

相关文档