文档首页/ 弹性公网IP EIP/ API参考/ API/ 带宽(V2.0)/ 创建共享带宽

更新时间：2024-08-15 GMT+08:00

在线调试

CLI示例

查看PDF

创建共享带宽

功能介绍

创建共享带宽。

调用方法

请参见如何调用API。

URI

POST /v2.0/{project_id}/bandwidths

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取项目ID请参见获取项目ID

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
bandwidth	是	CreateSharedBandwidthOption object	带宽对象

表3 CreateSharedBandwidthOption
参数	是否必选	参数类型	描述
enterprise_project_id	否	String	企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目创建共享带宽时，给共享带宽绑定企业项目ID。关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。缺省值：0 最大长度：36
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。
charge_mode	否	String	功能说明：按带宽计费还是按增强型95计费。取值范围：bandwidth，95peak_plus（按增强型95计费），不返回或者为空时表示是bandwidth。约束：只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%。枚举值： bandwidth 95peak_plus
public_border_group	否	String	功能说明：表示中心站点资源或者边缘站点资源取值范围： center、边缘站点名称约束：共享带宽只能插入与该字段相同的publicip 最小长度：1 最大长度：64
bandwidth_type	否	String	功能说明：指定带宽类型创建，默认中心站点为share，边缘站点为edgeshare 取值范围：查询当前租户可见的带宽类型列表获取，默认情况下: 中心站点: share 边缘站点: edgeshare 最小长度：1 最大长度：64

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
bandwidth	BandwidthResp object	带宽对象

表5 BandwidthResp
参数	参数类型	描述
bandwidth_type	String	功能说明：带宽类型，共享带宽默认为share。取值范围：share,share_sbgp share: 通用共享带宽 share_sbgp: 静态共享带宽最小长度：1 最大长度：36
billing_info	String	功能说明：账单信息，如果billinginfo不为空，说明是包周期的带宽最小长度：0 最大长度：255
charge_mode	String	功能说明：按流量计费,按带宽计费还是按增强型95计费。取值范围：bandwidth（按带宽计费），traffic（按流量计费），95peak_plus（按增强型95计费），不返回或者为空时表示是bandwidth。约束：只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%。枚举值： 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	功能说明：共享带宽类型，标识是否是共享带宽取值范围：PER，WHOLE（PER为独占带宽，WHOLE是共享带宽）。枚举值： WHOLE PER
size	Integer	功能说明：带宽大小取值范围：默认1Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。
tenant_id	String	功能说明：用户所属租户ID 最大长度：36
enterprise_project_id	String	企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。创建弹性公网IP时，给弹性公网IP绑定企业项目ID。不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。最大长度：36
status	String	功能说明：带宽的状态取值范围： FREEZED：冻结 NORMAL：正常枚举值： FREEZED NORMAL
enable_bandwidth_rules	Boolean	功能说明：是否开启企业级qos 取值范围：true/false，该字段仅在上海1局点返回
rule_quota	Integer	功能说明：带宽支持的最大分组规则数。（该字段仅在上海1局点返回）最小值：0 最大值：1024
bandwidth_rules	Array of BandWidthRules objects	功能说明：带宽规则对象（该字段仅在上海1局点返回）
created_at	String	功能说明：资源创建时间，UTC时间格式： yyyy-MM-ddTHH:mm:ss
updated_at	String	功能说明：资源更新时间，UTC时间格式： yyyy-MM-ddTHH:mm:ss
public_border_group	String	功能说明：表示中心站点资源或者边缘站点资源取值范围： center、边缘站点名称约束：共享带宽只能绑定与该字段相同的publicip 最小长度：1 最大长度：64

表6 BandWidthRules
参数	参数类型	描述
id	String	功能说明：带宽规则ID 最大长度：36
name	String	功能说明：带宽规则名称最小长度：0 最大长度：64
admin_state_up	Boolean	功能说明：配置状态，为False时配置不生效。
egress_size	Integer	功能说明：出网带宽最大值，单位Mbps 取值范围[0,n]，其中n为所属带宽的带宽大小（size字段）。0表示设置为最大带宽最小值：0 缺省值：0
egress_guarented_size	Integer	功能说明：出网保障带宽大小，单位Mbps 取值范围[0,x]，其中x为所属带宽剩余的保障额最小值：0 缺省值：0
publicip_info	Array of PublicipInfoResp objects	功能说明：带宽对应的弹性公网IP信息约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP

表7 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

请求示例

创建大小为10M，宽带名称bandwidth123的共享带宽。

{
  "bandwidth" : {
    "enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439",
    "size" : 10,
    "name" : "bandwidth123"
  }
}

响应示例

状态码： 200

POST操作正常返回

{
  "bandwidth" : {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439",
    "billing_info" : "",
    "size" : 10,
    "share_type" : "WHOLE",
    "bandwidth_type" : "share",
    "publicip_info" : [ ],
    "name" : "bandwidth123",
    "charge_mode" : "bandwidth",
    "enable_bandwidth_rules" : false,
    "rule_quota" : 0,
    "bandwidth_rules" : [ ],
    "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855",
    "status" : "NORMAL"
  }
}

SDK代码示例

SDK代码示例如下。

创建大小为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 CreateSharedBandwidthSolution {

    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();
        CreateSharedBandwidthRequest request = new CreateSharedBandwidthRequest();
        CreateSharedBandwidhRequestBody body = new CreateSharedBandwidhRequestBody();
        CreateSharedBandwidthOption bandwidthbody = new CreateSharedBandwidthOption();
        bandwidthbody.withEnterpriseProjectId("b261ac1f-2489-4bc7-b31b-c33c3346a439")
            .withName("bandwidth123")
            .withSize(10);
        body.withBandwidth(bandwidthbody);
        request.withBody(body);
        try {
            CreateSharedBandwidthResponse response = client.createSharedBandwidth(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());
        }
    }
}

          

        

      
     

创建大小为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"]

    credentials = BasicCredentials(ak, sk)

    client = EipClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EipRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateSharedBandwidthRequest()
        bandwidthbody = CreateSharedBandwidthOption(
            enterprise_project_id="b261ac1f-2489-4bc7-b31b-c33c3346a439",
            name="bandwidth123",
            size=10
        )
        request.body = CreateSharedBandwidhRequestBody(
            bandwidth=bandwidthbody
        )
        response = client.create_shared_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)

          

        

      
     

创建大小为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")

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

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

    request := &model.CreateSharedBandwidthRequest{}
	enterpriseProjectIdBandwidth:= "b261ac1f-2489-4bc7-b31b-c33c3346a439"
	bandwidthbody := &model.CreateSharedBandwidthOption{
		EnterpriseProjectId: &enterpriseProjectIdBandwidth,
		Name: "bandwidth123",
		Size: int32(10),
	}
	request.Body = &model.CreateSharedBandwidhRequestBody{
		Bandwidth: bandwidthbody,
	}
	response, err := client.CreateSharedBandwidth(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

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

状态码

状态码	描述
200	POST操作正常返回

错误码

请参见错误码。

父主题：带宽(V2.0)

上一篇：按需转包年/包月带宽

下一篇：批量创建共享带宽

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建共享带宽

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线