文档首页> 弹性公网IP EIP> API参考> API> 带宽(V2.0)> 批量创建共享带宽
更新时间:2024-04-03 GMT+08:00
分享

批量创建共享带宽

功能介绍

批量创建共享带宽。

调用方法

请参见如何调用API

URI

POST /v2.0/{project_id}/batch-bandwidths

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bandwidth

BatchCreateBandwidthOption object

带宽对象

表3 BatchCreateBandwidthOption

参数

是否必选

参数类型

描述

count

Integer

  • 取值范围:正整数

  • 功能说明:批创的共享带宽的个数

  • 说明: 如果传入的参数为小数(如 2.2)或者字符类型(如“2”),会自动强制转换为整数。

  • 约束:表示批量创建的共享带宽数目, 该参数和租户配额数目有关,默认配额为5,批创个数不大于租户共享带宽的可用配额。

最小值:1

name

String

  • 取值范围:1-64,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

  • 功能说明:带宽名称

最小长度:1

最大长度:64

size

Integer

  • 功能说明:带宽大小。共享带宽的大小有最小值限制,默认为5M,可能因局点不同而不同。

  • 取值范围:默认5Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。

  • 约束:如果传入的参数为小数(如 10.2)或者字符类型(如“10”),会自动强制转换为整数。

  • 注意:调整带宽时的最小单位会根据带宽范围不同存在差异。

    • 小于等于300Mbit/s:默认最小单位为1Mbit/s。

    • 300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。

    • 大于1000Mbit/s:默认最小单位为500Mbit/s。

public_border_group

String

  • 功能说明:表示中心站点资源或者边缘站点资源

  • 取值范围: center、边缘站点名称

  • 约束:共享带宽只能插入与该字段相同的publicip

最小长度:1

最大长度:64

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

bandwidths

Array of BatchBandwidthResp objects

批创的带宽对象的列表

表5 BatchBandwidthResp

参数

参数类型

描述

bandwidth_type

String

  • 功能说明:带宽类型,共享带宽默认为share。

  • 取值范围:share,bgp,sbgp等。

    • share:共享带宽

    • bgp:动态bgp

    • sbgp:静态bgp

最小长度:1

最大长度:36

billing_info

String

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

最小长度:0

最大长度:255

charge_mode

String

  • 功能说明:按流量计费还是按带宽计费

  • 取值范围:bandwidth(按带宽计费),traffic(按流量计费),不返回或者为空时表示是bandwidth。

  • 约束:共享带宽仅支持按带宽计费。

枚举值:

  • bandwidth

  • traffic

  • 95peak_plus

id

String

  • 功能说明:带宽唯一标识

最大长度:36

name

String

  • 功能说明:带宽名称

  • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

最小长度:1

最大长度:64

publicip_info

Array of PublicipInfoResp objects

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

  • 约束:WHOLE类型的带宽支持多个弹性公网IP,PER类型的带宽只能对应一个弹性公网IP

share_type

String

  • 功能说明:带宽类型,标识是否是共享带宽

  • 取值范围:WHOLE,PER

    • WHOLE表示共享带宽

    • PER表示独享带宽

枚举值:

  • WHOLE

  • PER

size

Integer

  • 功能说明:带宽大小

  • 取值范围:5Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)

tenant_id

String

  • 功能说明:用户所属租户ID

最大长度:36

status

String

  • 功能说明:带宽的状态

  • 取值范围:

    • FREEZED:冻结

    • NORMAL:正常

枚举值:

  • FREEZED

  • NORMAL

public_border_group

String

  • 功能说明:表示中心站点资源或者边缘站点资源

  • 取值范围: center、边缘站点名称

  • 约束限制:只能绑定与该字段相同的publicip资源

最小长度:1

最大长度:64

表6 PublicipInfoResp

参数

参数类型

描述

publicip_address

String

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

最大长度:15

publicip_id

String

  • 功能说明:带宽对应的弹性公网IP或者IPv6端口的唯一标识

最大长度:36

publicip_type

String

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

  • 取值范围:5_bgp(全动态BGP),5_sbgp(静态BGP),5_youxuanbgp(优选BGP)

    • 华南-广州:5_bgp、5_sbgp

    • 华东-上海一:5_bgp、5_sbgp

    • 华东-上海二:5_bgp、5_sbgp

    • 华北-北京一:5_bgp、5_sbgp

    • 中国-香港:5_bgp、5_youxuanbgp

    • 亚太-曼谷:5_bgp

    • 亚太-新加坡:5_bgp

    • 非洲-约翰内斯堡:5_bgp

    • 西南-贵阳一:5_sbgp

    • 华北-北京四:5_bgp、5_sbgp

    • 拉美-圣地亚哥:5_bgp

    • 拉美-圣保罗一:5_bgp

    • 拉美-墨西哥城一:5_bgp

    • 拉美-布宜诺斯艾利一:5_bgp

    • 拉美-利马一:5_bgp

    • 拉美-圣地亚哥二: 5_bgp

  • 约束:

    • 必须是系统具体支持的类型。

    • publicip_id为IPv4端口,所以"type"字段未给定时,默认为5_bgp。

最大长度:36

publicipv6_address

String

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

最大长度:39

ip_version

Integer

  • 功能说明:IP版本信息

  • 取值范围:

    • 4:IPv4

    • 6:开启NAT64能力

枚举值:

  • 4

  • 6

请求示例

批量创建2个大小为10M、名称为bandwidth123的共享带宽。

{
  "bandwidth" : {
    "size" : 10,
    "name" : "bandwidth123",
    "count" : 2
  }
}

响应示例

状态码: 200

POST操作正常返回

{
  "bandwidths" : [ {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321",
    "size" : 10,
    "share_type" : "WHOLE",
    "bandwidth_type" : "share",
    "publicip_info" : [ ],
    "name" : "bandwidth123",
    "charge_mode" : "bandwidth",
    "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855",
    "status" : "NORMAL"
  }, {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321",
    "size" : 10,
    "share_type" : "WHOLE",
    "bandwidth_type" : "share",
    "publicip_info" : [ ],
    "name" : "bandwidth123",
    "charge_mode" : "bandwidth",
    "id" : "d91b0028-6f6b-4478-808a-297b75b6812a",
    "status" : "NORMAL"
  } ]
}

SDK代码示例

SDK代码示例如下。

批量创建2个大小为10M、名称为bandwidth123的共享带宽。

 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
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.v2.region.EipRegion;
import com.huaweicloud.sdk.eip.v2.*;
import com.huaweicloud.sdk.eip.v2.model.*;


public class BatchCreateSharedBandwidthsSolution {

    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();
        BatchCreateSharedBandwidthsRequest request = new BatchCreateSharedBandwidthsRequest();
        BatchCreateBandwidthRequestBody body = new BatchCreateBandwidthRequestBody();
        BatchCreateBandwidthOption bandwidthbody = new BatchCreateBandwidthOption();
        bandwidthbody.withCount(2)
            .withName("bandwidth123")
            .withSize(10);
        body.withBandwidth(bandwidthbody);
        request.withBody(body);
        try {
            BatchCreateSharedBandwidthsResponse response = client.batchCreateSharedBandwidths(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());
        }
    }
}

批量创建2个大小为10M、名称为bandwidth123的共享带宽。

 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

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v2.region.eip_region import EipRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeip.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 = __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 = BatchCreateSharedBandwidthsRequest()
        bandwidthbody = BatchCreateBandwidthOption(
            count=2,
            name="bandwidth123",
            size=10
        )
        request.body = BatchCreateBandwidthRequestBody(
            bandwidth=bandwidthbody
        )
        response = client.batch_create_shared_bandwidths(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

批量创建2个大小为10M、名称为bandwidth123的共享带宽。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := eip.NewEipClient(
        eip.EipClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchCreateSharedBandwidthsRequest{}
	bandwidthbody := &model.BatchCreateBandwidthOption{
		Count: int32(2),
		Name: "bandwidth123",
		Size: int32(10),
	}
	request.Body = &model.BatchCreateBandwidthRequestBody{
		Bandwidth: bandwidthbody,
	}
	response, err := client.BatchCreateSharedBandwidths(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

POST操作正常返回

错误码

请参见错误码

分享:

    相关文档

    相关产品