要实现跨地域网络实例互通,您必须购买带宽包,您可以调用CreateCenBandwidthPackage接口创建带宽包。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:CreateCenBandwidthPackage | create | *CenBandwidthPackage acs:cen:*:{#accountId}:cenbandwidthpackage/* |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 由客户端生成该参数值,需保证该参数在不同请求间唯一,最大值不超过 64 个 ASCII 字符。 | 02fb3da4-130e-11e9-8e44-001**** |
Name | string | 否 | 带宽包实例的名称。 名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。 | nametest |
Description | string | 否 | 带宽包实例的描述信息。 描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。 | namedesc |
Bandwidth | integer | 是 | 带宽包实例的带宽峰值。单位:Mbps。取值范围:2~10000。 | 2 |
GeographicRegionAId | string | 是 | 网络实例所属的区域。取值:
| China |
GeographicRegionBId | string | 是 | 另一个网络实例所属的区域。取值:
| China |
BandwidthPackageChargeType | string | 否 | 带宽包实例的付费类型。取值: PREPAY,表示先付费后使用的付费方式。 | PREPAY |
Period | integer | 否 | 带宽包实例的购买时长。默认值:1。
说明
当 BandwidthPackageChargeType 为 PREPAY 时本参数必填。
| 1 |
PricingCycle | string | 否 | 带宽包实例的计费周期。取值:
| Month |
AutoPay | boolean | 否 | 是否自动支付带宽包实例的账单。取值:
如果您选择不自动支付账单,在您调用本接口后,请前往控制台的订单中心完成支付,实例才能创建成功。 | false |
AutoRenew | boolean | 否 | 是否开启自动续费功能。取值:
说明
目前仅预付费带宽包支持自动续费。
| false |
AutoRenewDuration | integer | 否 | 自动续费时长。单位:月。取值范围:0~2147483647。默认值:1。 | 1 |
Tag | array<object> | 否 | 标签信息。 一次最多支持输入 20 个标签信息。 | |
object | 否 | |||
Key | string | 否 | 资源的标签键。 一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以 一次最多支持输入 20 个标签的标签键。 | tagtest |
Value | string | 否 | 资源的标签值。 标签值可以为空或输入不超过 128 个字符的字符串,不能以 每一个标签键对应一个标签值,一次最多支持输入 20 个标签键对应的标签值。 | tagtest |
返回参数
示例
正常返回示例
JSON
格式
{
"CenBandwidthPackageId": "cenbwp-4c2zaavbvh5fx****",
"CenBandwidthPackageOrderId": "20156420004****",
"RequestId": "E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | UnSupported.ChargeType | The charge type is not supported. | 不支持该付费类型。 |
400 | ParameterIllegal.BandwidthPackage | The parameter of bandwidth packaged is illegal. | 参数中指定的BandwidthPackage不合法。 |
400 | OperationInvalid.UserCanNotBuyCrossBorderBwp | According to the laws and regulations of the operator and mainland China, you are currently not eligible to purchase or renew a cross-border bandwidth package. Please contact online customer service or your business manager for consultation. | 根据运营商及中国大陆法律法规的要求,您当前暂不符合购买/续费跨境带宽包条件,请联系在线客服或您的商务经理咨询处理。 |
400 | OperationInvalid.UserCanNotBuyBwp | The user can not buy Cen bandwidthPackage. | 用户不允许购买CEN带宽包 |
400 | Order.AccountStatusIllegal | Illegal account status for postpay service not opened for this account. | 账号未开通后付费白名单,请开通后重试。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
500 | PayFor.AccountMoneyValidateError | Your channel merchant quota is insufficient. Please contact the channel merchant. | 您的渠道商额度不足,请与渠道商联系 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-11-22 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
2024-07-26 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-05-17 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-12-13 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-07-13 | OpenAPI 错误码发生变更 | 查看变更详情 |