# 批量创建共享带宽 - BatchCreateSharedBandwidths #### 功能介绍 批量创建共享带宽，本接口为同步接口，非异步接口 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=BatchCreateSharedBandwidths&version=v2)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | eip:bandwidths:batchCreate | Write | bandwidth \* | - | - | - | #### URI POST /v2.0/{project_id}/batch-bandwidths 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID [参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bandwidth | 是 | [BatchCreateBandwidthOption] object | 带宽对象 | 表3BatchCreateBandwidthOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | count | 是 | Integer | **参数解释：** 批创的共享带宽的个数。 - 说明： 如果传入的参数为小数（如 2.2）或者字符类型（如"2"），会自动强制转换为整数。 **约束限制：** 表示批量创建的共享带宽数目, 该参数和租户配额数目有关，默认配额为5，批创个数不大于租户共享带宽的可用配额。 **取值范围：** 正整数。 **默认取值：** 不涉及。 最小值：**1** | | name | 是 | String | **参数解释：** 带宽名称。 **约束限制：** 不涉及。 **取值范围：** 1-64，支持数字、字母、中文、_（下划线）、-（中划线）、.（点） **默认取值：** 不涉及。 | | size | 是 | Integer | **参数解释：** 带宽大小。共享带宽的大小有最小值限制，默认为5M，可能因局点不同而不同。 **约束限制：** - 如果传入的参数为小数（如 10.2）或者字符类型（如"10"），会自动强制转换为整数。 - 注意：调整带宽时的最小单位会根据带宽范围不同存在差异。 - 小于等于300Mbit/s：默认最小单位为1Mbit/s。 - 300Mbit/s\~1000Mbit/s：默认最小单位为50Mbit/s。 - 大于1000Mbit/s：默认最小单位为500Mbit/s。 **取值范围：** 默认5Mbit/s\~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。 **默认取值：** 不涉及。 | | public_border_group | 否 | String | **参数解释：** 表示中心站点资源或者边缘站点资源。 **约束限制：** 共享带宽只能插入与该字段相同的publicip。 **取值范围：** center、边缘站点名称。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bandwidths | Array of [BatchBandwidthResp] objects | **参数解释：** 批创的带宽对象的列表。 **取值范围：** 不涉及。 | 表5BatchBandwidthResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bandwidth_type | String | **参数解释：** 带宽类型，共享带宽默认为share。 **参数解释：** share：共享带宽。bgp：动态bgp。sbgp：静态bgp | | billing_info | String | **参数解释：** 账单信息，如果billing_info不为空，说明是包周期的带宽。 **取值范围：** 0-255 | | charge_mode | String | **参数解释：** 按流量计费，按带宽计费还是按增强型95计费。只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%。 **取值范围：** bandwidth（按带宽计费），traffic（按流量计费），95peak_plus（按增强型95计费），不返回或者为空时表示是bandwidth。 | | id | String | **参数解释：** 带宽唯一标识。 **取值范围：** 最大长度36。 | | name | String | **参数解释：** 带宽名称。 **取值范围：** 1-64个字符，支持数字、字母、中文、_（下划线）、-（中划线）、.（点） | | publicip_info | Array of [PublicipInfoResp] objects | **参数解释：** 带宽对应的弹性公网IP信息。 **取值范围：** 不涉及。 | | share_type | String | **参数解释：** 带宽类型，标识是否是共享带宽。 **取值范围：** - WHOLE：表示共享带宽。 - PER：表示独享带宽。 | | size | Integer | **参数解释：** 带宽大小。 **取值范围：** 5Mbit/s\~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。 | | tenant_id | String | **参数解释：** 用户所属租户ID。 **取值范围：** 最大长度36。 | | status | String | **参数解释：** 带宽的状态。 **取值范围：** - FREEZED：冻结。 - NORMAL：正常。 | | public_border_group | String | **参数解释：** 表示中心站点资源或者边缘站点资源。 **取值范围：** center、边缘站点名称。 | 表6PublicipInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | publicip_address | String | **参数解释：** 弹性公网IP或者IPv6端口的地址。 **取值范围：** 最大长度15。 | | publicip_id | String | **参数解释：** 带宽对应的弹性公网IP或者IPv6端口的唯一标识。 **取值范围：** 最大长度36。 | | publicip_type | String | **参数解释：** 弹性公网IP的类型。 **取值范围：** 5_bgp (全动态BGP)，5_sbgp (静态BGP)，5_bgp-premium(精品BGP) - 华南-广州：5_bgp、5_sbgp - 华东-上海一：5_bgp、5_sbgp - 华东-上海二：5_bgp、5_sbgp - 华北-北京一：5_bgp、5_sbgp - 中国-香港：5_bgp、5_bgp-premium - 亚太-曼谷：5_bgp - 亚太-新加坡：5_bgp - 非洲-约翰内斯堡：5_bgp - 西南-贵阳一：5_sbgp - 华北-北京四：5_bgp、5_sbgp - 拉美-圣地亚哥：5_bgp - 拉美-圣保罗一：5_bgp - 拉美-墨西哥城一：5_bgp - 拉美-布宜诺斯艾利斯一：5_bgp - 拉美-利马一：5_bgp - 拉美-圣地亚哥二： 5_bgp | | publicipv6_address | String | **参数解释：** IPv4时无此字段，IPv6时为申请到的弹性公网IP地址。 **取值范围：** 最大长度39。 | | ip_version | Integer | **参数解释：** IP版本信息。 **取值范围：** - 4：IPv4。 - 6：开启NAT64能力。 | #### 请求示例 批量创建2个大小为10M、名称为bandwidth123的共享带宽 ``` { "bandwidth" : { "size" : 10, "name" : "bandwidth123", "count" : 2 } } ``` #### 响应示例 **状态码：200** ``` { "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", "public_border_group" : "center" }, { "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", "public_border_group" : "center" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 批量创建2个大小为10M、名称为bandwidth123的共享带宽 ``` 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("")) .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()); } } } ``` - [Python] 批量创建2个大小为10M、名称为bandwidth123的共享带宽 ``` # coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("")) \ .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) ``` - [Go] 批量创建2个大小为10M、名称为bandwidth123的共享带宽 ``` 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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := eip.EipClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := eip.NewEipClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/sdk?api=BatchCreateSharedBandwidths&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 批量创建共享带宽正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。