Call CreateTransitRouterBandwidthPackage to create a Transit Router (TR) bandwidth package that provides bandwidth for cross-region interconnection.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.

Action String required Example: CreateTransitRouterBandwidthPackage

The interface name. The current API name is CreateTransitRouterBandwidthPackage.

Version String required Example: 2020-04-01

The interface version. The current API version is 2020-04-01.

ClientToken String optional Example: 123e4567-e89b-12d3-a456-42665544****

The Client Token that is used to ensure the request idempotency.

This parameter value is auto-generated by the client. Ensure uniqueness across requests, preventing duplicate actions caused by multiple client retries during API timeouts or server internal errors.

Must not exceed 64 ASCII characters.

If you do not set this parameter, idempotency check is not performed.

Line Operator String optional Example: ChinaUnicom

The provider of cross-border bandwidth packages.

ChinaUnicom (default): China Unicom.

ChinaTelecom: China Telecom.

LocalGeographicRegionSetId String required Example: China

Local Geographic Region ID for TR bandwidth package interconnection. Values:

China: Mainland China.

Asia: Asia Pacific.

PeerGeographicRegionSetId String required Example: China

Peer Geographic Region ID for TR bandwidth package interconnection. Values:

China: Mainland China.

Asia: Asia Pacific.

Bandwidth Integer optional Example: 2

The peak bandwidth of the TR bandwidth package. Valid range: 2 to 10000 Mbps. Default: 2 Mbps.

TransitRouterBandwidthPackageName String optional Example: trbp-test

The name of the TR bandwidth package.

Must start with a letter, digit, or Chinese character. May include letters, digits, Chinese characters, and the following symbols: periods (.), underscores (_), and hyphens (-).

Must be 1 to 128 characters in length.

If you do not provide this parameter or leave it unset, it defaults to the TR bandwidth package ID.

Description String optional Example: namedesc

The description of the TR bandwidth package.

Must start with a letter, digit, or Chinese character. May include letters, digits, Chinese characters, and the following symbols: commas (,), periods (.), underscores (_), spaces ( ), equal signs (=), hyphens (-), Chinese commas ( ， ), and Chinese periods ( 。 ).

Must be 0 to 255 characters.

If you do not provide this parameter or leave it unset, it defaults to an empty string.

BillingType Integer optional Example: 1

The metering method for the TR bandwidth package. Values:

1 (default): Subscription.

PeriodUnit String optional Example: Month

The biliing cycle for the TR bandwidth package. Values:

Month (default): Billing by month.

Year: Billing by year.

Period Integer optional Example: 1

The purchase duration for the TR bandwidth package. Default: 1. Values:

When PeriodUnit is set to Month, valid values are 1 to 9, 12, 24, and 36.

When PeriodUnit is set to Year, valid values are 1 to 3.

ProjectName String optional Example: default

The name of the project to which the TR bandwidth package belongs. If you do not provide this parameter or leave it unset, it defaults to "default".

Tags.N.Key String optional Example: k1

The custom tag key of the TR bandwidth package.

Must be 1 to 128 characters.

Case-sensitive. Must not start with volc: or sys: in any case combination.

Must not start or end with a space.

May include letters, digits, spaces ( ), underscores (_), periods (.), half-width colons (:), slashes (/), equal signs (=), plus signs (+), minus signs (-) and at signs (@).

tip

Duplicate tag keys are not allowed for the same resource.

If you do not provide this parameter or leave it unset, it defaults to empty.

Tags.N.Value String optional Example: v1

The custom tag value of the TR bandwidth package.

Must be 0 to 255 characters.

Case-sensitive. Must not start or end with a space.

May include letters, digits, spaces ( ), underscores (_), periods (.), half-width colons (:), slashes (/), equal signs (=), plus signs (+), minus signs (-) and at signs (@).

tip

To provide this parameter, provide Tags.N.Key first.

Response parameters

Only the response parameters specific to this API are listed below. For more information, see Response structure.

TransitRouterBandwidthPackageId String Example: tr-bp-4c2zaavbvh5fx****

The instance ID of the bandwidth package.

Request example

Response example

Error codes

The following table lists the error codes related to the business logic for this API. For details, see Common error codes.

Status code	Error codes	Error message	Description
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	The parameters of this idempotent request are inconsistent with those used in the previous request.
400	InvalidDescription.Malformed	The specified description is malformed.	The format specified for the description is invalid. Correct the description format and retry.
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	The format specified for the description is invalid. A description must not exceed 255 characters.
400	InvalidLineOperator.LineOperatorMalformed	The specified line operator is malformed.	The specified line operator is invalid.
400	InvalidName.Malformed	The specified name is malformed.	The format specified for the name is invalid. Correct the name format and retry.
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	The format specified for the name is invalid. A name must not exceed 128 characters.
400	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	The format specified for CientToken is invalid. It must not exceed 64 ASCII characters.
400	InvalidTag.Disorder	The specified index order of tag is malformed.	The index order format specified for the tag is invalid
400	InvalidTagKey.Malformed	The specified parameter tag key is invalid.	The tag key is invalid.
400	InvalidTagValue.Malformed	The specified parameter tag value is invalid.	The tag value is invalid.
400	InvalidTransitRouterBandwidthPackage.BillingTypeMalformed	The specified BillingType is invalid.	The specified billing method is invalid.
400	InvalidTransitRouterBandwidthPackage.PeriodMalformed	The specified Period is invalid.	The specified purchase duration is invalid.
400	InvalidTransitRouterBandwidthPackage.PeriodUnitMalformed	The specified PeriodUnit is invalid.	The specified billing cycle is invalid.
400	InvalidTransitRouterBandwidthPackage.RemainRenewTimesMalformed	The specified RemainRenewTimes is invalid.	The specified remaining automatic renewals is invalid.
400	InvalidTransitRouterBandwidthPackage.RenewPeriodMalformed	The specified RenewPeriod is invalid.	The specified renewal cycle is invalid.
400	InvalidTransitRouterBandwidthPackage.RenewTypeMalformed	The specified RenewType is invalid.	The specified renewal type is invalid.
400	InvalidTransitRouterBandwidthPackage.TimeLimitExceeded	The specified time period has exceeded the service period you signed with the Service Provider.	The specified duration exceeds the service period you contracted with China Unicom.
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.	The cross-border service under your account is suspended. Proceed after the line operator reactivates your service.
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.	Your account has not enabled cross-border interconnection capabilities and cannot create cross-border bandwidth packages. Contact the line operator to grant you permission.
400	LimitExceeded.BandwidthOfBandwidthPackage	The specified bandwidth exceeds the bandwidth limit of Transit Router bandwidth package.	The specified bandwidth exceeds the valid range of the bandwidth package.
400	LimitExceeded.Tags	You've reached the limit on the number of tags that you can operate at a time.	You have reached the maximum of tags that can be processed in a single request.
400	OrderError	Failed to create an order.	The order placement failed.
400	QuotaExceeded.BandwidthPackage	You've reached the limit on the number of TransitRouter bandwidth packages that you can create.	You have reached the maximum number of bandwidth packages that can be created.
400	UnsupportedOperation.CreateNonCrossBorderBandwidthPackageWithLineOperator	The specified request is denied because the non cross border bandwidth package with specified line operator.	The specified bandwidth package is a non-cross-border package and does not support specifying a line operator.
400	UnsupportedOperation	The order is not allowed due to lack of Payment Method in your account, please provide Payment Method.	The action request on this instance is denied due to no payment method in the account.
400	UnsupportedOperation	The payment failed due to the account balance is not enough for this order.	The order payment failed due to insufficient account balance.
400	UnsupportedOperation	The request on the specified instance is denied due to the account in arrears status.	The action request on this instance is denied because the account is in arrears.
403	Forbidden.CreateCrossBorderBandwidthPackage	You can not create cross border bandwidth package due to have not passed cross-border audit yet.	You fail the cross-border qualification review and cannot purchase cross-border bandwidth package.
403	Forbidden.CreateTransitRouterBandwidthPackage	You are not authorized to create the bandwidth package of 95 peak billing type.	No permission to create a Pay-by-95th-peak bandwidth package. Enable the allowlist for Pay-by-95th-peak bandwidth packages.
403	Forbidden.NotVerifiedAccount	Please complete the real name verification, since the specified bandwidth package contains cloud resources in China Mainland.	The specified bandwidth package includes cloud resources in China Mainland regions. Complete real-name authentication first.
403	Forbidden.PackageLineTypeTelecomNotSupport	You are not authorized to create bandwidth package with specific line type of Telecom.	No permission to create bandwidth packages provided by China Telecom. Enable the allowlist.
403	Forbidden.PurchaseLimited	The account is not authorized to purchase the resource.	This account has no permission to purchase resources.
404	InvalidGeographicRegionSetID.NotSupported	The specified geographic region set ID is not supported.	The specified geographic region ID is invalid.
404	InvalidProject.NotFound	The specified Project does not exist.	The specified project does not exist.
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	The idempotent request is in progress.