CreateTransitRouterBandwidthPackage--中转路由器-火山引擎

文档中心

立即注册

导航

CreateTransitRouterBandwidthPackage

最近更新时间：2024.10.16 16:20:25首次发布时间：2023.09.12 10:21:32

调用 CreateTransitRouterBandwidthPackage 接口，创建一个中转路由器带宽包，用于为跨地域互通提供带宽。

使用说明

单账号默认最多可创建10个带宽包。如果默认配额无法满足需要，可参考创建配额更配申请提交配额提升申请。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表中，Tags.N.a类型参数中的“N”表示标签信息的序号，需按照数字顺序从1开始填写，取值范围为1～50。多个标签之间使用&分隔。每个标签键对应一个标签值。

名称	类型	是否必选	示例值	描述
Action	String	是	CreateTransitRouterBandwidthPackage	要执行的操作，取值为CreateTransitRouterBandwidthPackage。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
LocalGeographicRegionSetId	String	是	China	中转路由器带宽包互通的本端地理区域ID。取值如下： China：中国大陆。 Asia：亚太。
PeerGeographicRegionSetId	String	是	China	中转路由器带宽包互通的对端地理区域ID。取值如下： China：中国大陆。 Asia：亚太。
Bandwidth	Integer	否	2	中转路由器带宽包的带宽峰值。取值范围为2 ~ 10000，单位为Mbps，默认值为2Mbps。
TransitRouterBandwidthPackageName	String	否	trbp-test	中转路由器带宽包的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号 (.) 、下划线 (_) 和短划线 (-) 。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为中转路由器带宽包的ID。
Description	String	否	namedesc	中转路由器带宽包的描述。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
BillingType	Integer	否	1	中转路由器带宽包的计费方式。取值如下： 1（默认值）：包年包月。
PeriodUnit	String	否	Month	中转路由器带宽包的计费周期。取值如下： Month（默认值）：按月计费。 Year：按年计费。
Period	Integer	否	1	中转路由器带宽包的购买时长，默认值为1。取值如下：当参数`PeriodUnit`取值为Month时，取值范围为1~9，12，24和36。当参数`PeriodUnit`取值为Year时，取值范围为1~3。
ClientToken	String	否	123e4567-e89b-12d3-a456-42665544****	客户端Token，用于保证请求的幂等性。该参数值由客户端自动生成，确保不同请求的取值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值仅支持ASCII字符，最大不超过64个字符。未指定该参数值时，不进行幂等校验。
ProjectName	String	否	default	中转路由器带宽包所属项目的名称。不传入该参数或该参数不传入数值时，默认为default。
Tags.N.Key	String	否	Tags.1.Key=k1&Tags.2.Key=k2	中转路由器带宽包用户标签的标签键。长度限制为1～128个字符。大小写敏感，不能以`volc:`的任意大小写组合开头。不能以空格开头或结尾。允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。说明同一资源的标签键不允许重复。不传入该参数或该参数不传入数值时，默认为空。
Tags.N.Value	String	否	Tags.1.Value=v1&Tags.2.Value=v2	中转路由器带宽包用户标签的标签值。长度限制为0～255个字符。大小写敏感，不能以空格开头或结尾。允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。说明如果传入该参数，则必须先传入`Tags.N.Key`。

返回参数

名称	类型	示例值	描述
TransitRouterBandwidthPackageId	String	tr-bp-4c2zaavbvh5fx****	带宽包实例ID。

请求示例

GET /?Action=CreateTransitRouterBandwidthPackage&Version=2020-04-01&LocalGeographicRegionSetId=China&PeerGeographicRegionSetId=China&TransitRouterBandwidthPackageName=trbp-test&Description=namedesc HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "CreateTransitRouterBandwidthPackage",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "TransitRouterBandwidthPackageId": "tr-bp-4c2zaavbvh5fx****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法，名称长度不能超过128个字符。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法，请修复名称格式后重试。
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法，描述长度不能超过255个字符。
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法，请修复描述格式后重试。
400	InvalidTransitRouterBandwidthPackage.BillingTypeMalformed	The specified BillingType is invalid.	指定的计费类型无效。
400	InvalidTransitRouterBandwidthPackage.PeriodUnitMalformed	The specified PeriodUnit is invalid.	指定的计费周期无效。
400	InvalidTransitRouterBandwidthPackage.PeriodMalformed	The specified Period is invalid.	指定的购买时长无效。
400	QuotaExceeded.BandwidthPackage	You've reached the limit on the number of TransitRouter bandwidth packages that you can create.	已达到可创建带宽包实例数量的配额上限。
400	LimitExceeded.BandwidthOfBandwidthPackage	The specified bandwidth exceeds the bandwidth limit of Transit Router bandwidth package.	指定的带宽超出带宽包取值范围。
400	OrderError	Failed to create an order.	下单失败。
400	UnsupportedOperation	The payment failed due to the account balance is not enough for this order.	账户余额不足，订单支付失败。
400	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400	InvalidTag.Disorder	The specified index order of tag is malformed.	指定标签的索引顺序参数格式不合法。
400	InvalidTagKey.Malformed	The specified parameter tag key is invalid.	标签键不合法。
400	InvalidTagValue.Malformed	The specified parameter tag value is invalid.	标签值不合法。
400	LimitExceeded.Tags	You've reached the limit on the number of tags that you can operate at a time.	已达到单次可操作标签数量的上限。
400	InvalidTransitRouterCrossBorderBandwidthPackage.FrozenStatus	The specified request is denied because your account has been frozen for cross-border. Please wait for the Service Provider to unfreeze it.	您的账号当前处于跨境封停状态，请等待运营商解封后再进行操作。
400	InvalidTransitRouterCrossBorderBandwidthPackage.UnactivatedStatus	The specified request is denied because your account has not been activated for cross-border. Please contact the Service Provider to activate it.	您的账号暂未开通跨境互通能力，无法创建跨境带宽包。请联系运营商为您开通权限。
400	InvalidTransitRouterBandwidthPackage.TimeLimitExceeded	The specified time period has exceeded the service period you signed with the Service Provider.	指定的购买时长已超过您和联通签约的服务时长。
400	UnsupportedOperation.AutoRenewal	The specified Interconnecting geographical regions don't support auto renewal. You can do manually renewal within the time period that you signed with service provider.	指定的带宽包互通区域不支持在火山平台开启自动续费。可以控制台手动续期，续期时间不得超过您和运营商签约的服务时间。
403	Forbidden.CreateCrossBorderBandwidthPackage	You can not create cross border bandwidth package due to have not passed cross-border audit yet.	未通过跨境资质审核，无法创建跨境带宽包。
403	Forbidden.PurchaseLimited	The account is not authorized to purchase the resource.	此账户无权限购买资源。
404	InvalidProject.NotFound	The specified Project does not exist.	指定的项目不存在。
404	InvalidGeographicRegionSetID.NotSupported	The specified geographic region set ID is not supported.	指定的地理区域ID无效。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。