创建带宽包实例
功能介绍
创建带宽包实例。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v3/{domain_id}/ccaas/bandwidth-packages
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
账号ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
bandwidth_package |
是 |
CreateBandwidthPackage object |
创建带宽包请求体。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
实例名称。 |
description |
否 |
String |
实例描述。不支持 <>。 |
enterprise_project_id |
否 |
String |
实例所属企业项目ID。 |
project_id |
是 |
String |
实例所属项目ID。 |
local_area_id |
是 |
String |
本端大区。 云连接支持的大区有: | Chinese-Mainland | 中国大陆 | | Asia-Pacific | 亚太 | | Africa | 非洲 | | Western-Latin-America | 拉美西 | | Eastern-Latin-America | 拉美东 | | Northern-Latin-America | 拉美北 | |
remote_area_id |
是 |
String |
本端大区。 云连接支持的大区有: | Chinese-Mainland | 中国大陆 | | Asia-Pacific | 亚太 | | Africa | 非洲 | | Western-Latin-America | 拉美西 | | Eastern-Latin-America | 拉美东 | | Northern-Latin-America | 拉美北 | |
charge_mode |
是 |
String |
带宽包实例的计费方式。 bandwidth是按带宽计费。 |
billing_mode |
是 |
Integer |
带宽包实例在大陆站或国际站的计费方式:
|
bandwidth |
是 |
Integer |
带宽包实例中的带宽值。 |
resource_id |
否 |
String |
带宽包实例绑定的资源ID。 |
resource_type |
否 |
String |
带宽包实例绑定的资源类型。 cloud_connection: 云连接实例。 |
spec_code |
否 |
String |
带宽包实例的规格编码。 bandwidth.aftoela:大陆站+国际站南非-拉美东 bandwidth.aftonla:大陆站+国际站南非-拉美北 bandwidth.aftowla:大陆站+国际站南非-拉美西 bandwidth.aptoaf:国际站亚太-南非 bandwidth.aptoap:国际站亚太-亚太 bandwidth.aptoela:大陆站+国际站亚太-拉美东 bandwidth.aptonla:大陆站+国际站亚太-拉美北 bandwidth.aptowla:大陆站+国际站亚太-拉美西 bandwidth.cmtoaf:国际站中国大陆-南非 bandwidth.cmtoap:国际站中国大陆-亚太 bandwidth.cmtocm:国际站中国大陆-中国大陆 bandwidth.cmtoela:大陆站+国际站中国大陆-拉美东 bandwidth.cmtonla:大陆站+国际站中国大陆-拉美北 bandwidth.cmtowla:大陆站+国际站中国大陆-拉美西 bandwidth.elatoela:大陆站+国际站拉美东-拉美东 bandwidth.elatonla:大陆站+国际站拉美东-拉美北 bandwidth.wlatoela:大陆站+国际站拉美西-拉美东 bandwidth.wlatonla:大陆站+国际站拉美西-拉美北 bandwidth.wlatowla:大陆站+国际站拉美西-拉美西 |
interflow_mode |
否 |
String |
互通类型:
|
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求ID。 |
bandwidth_package |
BandwidthPackage object |
带宽包实例。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
实例ID。 |
name |
String |
实例名称。 |
description |
String |
实例描述。不支持 <>。 |
domain_id |
String |
实例所属账号ID。 |
enterprise_project_id |
String |
实例所属企业项目ID。 |
project_id |
String |
实例所属项目ID。 |
created_at |
String |
实例创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。 |
updated_at |
String |
实例更新时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。 |
resource_id |
String |
带宽包实例绑定的资源ID。 |
resource_type |
String |
带宽包实例绑定的资源类型。 cloud_connection: 云连接实例。 |
local_area_id |
String |
本端大区。 云连接支持的大区有: | Chinese-Mainland | 中国大陆 | | Asia-Pacific | 亚太 | | Africa | 非洲 | | Western-Latin-America | 拉美西 | | Eastern-Latin-America | 拉美东 | | Northern-Latin-America | 拉美北 | |
remote_area_id |
String |
本端大区。 云连接支持的大区有: | Chinese-Mainland | 中国大陆 | | Asia-Pacific | 亚太 | | Africa | 非洲 | | Western-Latin-America | 拉美西 | | Eastern-Latin-America | 拉美东 | | Northern-Latin-America | 拉美北 | |
spec_code |
String |
带宽包实例的规格编码。 bandwidth.aftoela:大陆站+国际站南非-拉美东 bandwidth.aftonla:大陆站+国际站南非-拉美北 bandwidth.aftowla:大陆站+国际站南非-拉美西 bandwidth.aptoaf:国际站亚太-南非 bandwidth.aptoap:国际站亚太-亚太 bandwidth.aptoela:大陆站+国际站亚太-拉美东 bandwidth.aptonla:大陆站+国际站亚太-拉美北 bandwidth.aptowla:大陆站+国际站亚太-拉美西 bandwidth.cmtoaf:国际站中国大陆-南非 bandwidth.cmtoap:国际站中国大陆-亚太 bandwidth.cmtocm:国际站中国大陆-中国大陆 bandwidth.cmtoela:大陆站+国际站中国大陆-拉美东 bandwidth.cmtonla:大陆站+国际站中国大陆-拉美北 bandwidth.cmtowla:大陆站+国际站中国大陆-拉美西 bandwidth.elatoela:大陆站+国际站拉美东-拉美东 bandwidth.elatonla:大陆站+国际站拉美东-拉美北 bandwidth.wlatoela:大陆站+国际站拉美西-拉美东 bandwidth.wlatonla:大陆站+国际站拉美西-拉美北 bandwidth.wlatowla:大陆站+国际站拉美西-拉美西 |
billing_mode |
Integer |
带宽包实例在大陆站或国际站的计费方式。 1:大陆站包周期。 2:国际站包周期。 3:大陆站按需计费。 4:国际站按需计费。 5:大陆站按95方式计费。 6:国际站按95方式计费。 |
tags |
Array of Tag objects |
实例标签。 |
status |
String |
带宽包实例的状态。ACTIVE表示状态 |
admin_state_up |
Boolean |
带宽包实例的管理状态。 |
order_id |
String |
带宽包实例的订单ID。 |
product_id |
String |
带宽包实例的产品ID。 |
charge_mode |
String |
带宽包实例的计费方式。 bandwidth是按带宽计费。 |
bandwidth |
Integer |
带宽包实例中的带宽值。 |
interflow_mode |
String |
互通类型:
|
请求示例
创建一个带宽包实例,带宽值为5M,并指定带宽包的本端大区和远端大区
POST https://{cc_endpoint}/v3/{domain_id}/ccaas/bandwidth-packages { "bandwidth_package" : { "project_id" : "XXX", "name" : "test_bwp_name", "local_area_id" : "Chinese-Mainland", "remote_area_id" : "Chinese-Mainland", "bandwidth" : 5, "charge_mode" : "bandwidth", "billing_mode" : 5, "interflow_mode" : "Area", "enterprise_project_id" : "0" } }
响应示例
状态码: 201
创建带宽包实例成功。
{ "request_id" : "61126320a1802d5c6444f9d2d76526c2", "bandwidth_package" : { "bandwidth" : 5, "status" : "ACTIVE", "id" : "XXXXX", "name" : "test_bwp_name", "description" : "", "domain_id" : "XXX", "created_at" : "2023-09-20T08:37:15Z", "updated_at" : "2023-09-20T08:37:15Z", "project_id" : "XXX", "resource_type" : "", "resource_id" : "", "local_area_id" : "Chinese-Mainland", "remote_area_id" : "Chinese-Mainland", "admin_state_up" : true, "charge_mode" : "bandwidth", "billing_mode" : "3", "spec_code" : "bandwidth.cmtocm", "order_id" : "", "product_id" : "", "enterprise_project_id" : "0", "tags" : [ ], "interflow_mode" : "Area" } }
SDK代码示例
SDK代码示例如下。
创建一个带宽包实例,带宽值为5M,并指定带宽包的本端大区和远端大区
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 53 54 55 56 57 58 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.cc.v3.region.CcRegion; import com.huaweicloud.sdk.cc.v3.*; import com.huaweicloud.sdk.cc.v3.model.*; public class CreateBandwidthPackageSolution { 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 GlobalCredentials() .withAk(ak) .withSk(sk); CcClient client = CcClient.newBuilder() .withCredential(auth) .withRegion(CcRegion.valueOf("<YOUR REGION>")) .build(); CreateBandwidthPackageRequest request = new CreateBandwidthPackageRequest(); CreateBandwidthPackageRequestBody body = new CreateBandwidthPackageRequestBody(); CreateBandwidthPackage bandwidthPackagebody = new CreateBandwidthPackage(); bandwidthPackagebody.withBillingMode(CreateBandwidthPackage.BillingModeEnum.NUMBER_5) .withBandwidth(5) .withChargeMode(CreateBandwidthPackage.ChargeModeEnum.fromValue("bandwidth")) .withRemoteAreaId(CreateBandwidthPackage.RemoteAreaIdEnum.fromValue("Chinese-Mainland")) .withEnterpriseProjectId("0") .withProjectId("XXX") .withName("test_bwp_name") .withLocalAreaId(CreateBandwidthPackage.LocalAreaIdEnum.fromValue("Chinese-Mainland")) .withInterflowMode(CreateBandwidthPackage.InterflowModeEnum.fromValue("Area")); body.withBandwidthPackage(bandwidthPackagebody); request.withBody(body); try { CreateBandwidthPackageResponse response = client.createBandwidthPackage(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()); } } } |
创建一个带宽包实例,带宽值为5M,并指定带宽包的本端大区和远端大区
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcc.v3.region.cc_region import CcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcc.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 = GlobalCredentials(ak, sk) client = CcClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateBandwidthPackageRequest() bandwidthPackagebody = CreateBandwidthPackage( billing_mode=5, bandwidth=5, charge_mode="bandwidth", remote_area_id="Chinese-Mainland", enterprise_project_id="0", project_id="XXX", name="test_bwp_name", local_area_id="Chinese-Mainland", interflow_mode="Area" ) request.body = CreateBandwidthPackageRequestBody( bandwidth_package=bandwidthPackagebody ) response = client.create_bandwidth_package(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
创建一个带宽包实例,带宽值为5M,并指定带宽包的本端大区和远端大区
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 53 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cc.NewCcClient( cc.CcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateBandwidthPackageRequest{} remoteAreaIdBandwidthPackage:= model.GetCreateBandwidthPackageRemoteAreaIdEnum().CHINESE_MAINLAND enterpriseProjectIdBandwidthPackage:= "0" localAreaIdBandwidthPackage:= model.GetCreateBandwidthPackageLocalAreaIdEnum().CHINESE_MAINLAND interflowModeBandwidthPackage:= model.GetCreateBandwidthPackageInterflowModeEnum().AREA bandwidthPackagebody := &model.CreateBandwidthPackage{ BillingMode: model.GetCreateBandwidthPackageBillingModeEnum().E_5, Bandwidth: int32(5), ChargeMode: model.GetCreateBandwidthPackageChargeModeEnum().BANDWIDTH, RemoteAreaId: &remoteAreaIdBandwidthPackage, EnterpriseProjectId: &enterpriseProjectIdBandwidthPackage, ProjectId: "XXX", Name: "test_bwp_name", LocalAreaId: &localAreaIdBandwidthPackage, InterflowMode: &interflowModeBandwidthPackage, } request.Body = &model.CreateBandwidthPackageRequestBody{ BandwidthPackage: bandwidthPackagebody, } response, err := client.CreateBandwidthPackage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
创建带宽包实例成功。 |
错误码
请参见错误码。