Docs

Transit Router

Bandwidth Packages

SetTransitRouterBandwidthPackageRenewal - Configuring renewal type for a TR bandwidth package

Call SetTransitRouterBandwidthPackageRenewal to configure the renewal type for a Subscription Transit Router (TR) bandwidth package.

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 value: SetTransitRouterBandwidthPackageRenewal

The interface name. The current API name is SetTransitRouterBandwidthPackageRenewal.

Version String required Example value: 2020-04-01

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

TransitRouterBandwidthPackageId String requiredExample: tr-bp-qw2u6ur8lhe2t****

The ID of the Transit Router (TR) bandwidth package. You can call the DescribeTransitRouterBandwidthPackages API to obtain the ID of the TR bandwidth package.

RenewType String required Example value: Auto

The renewal type for the TR bandwidth package. Values:

Manual: Manual renewal.

Auto: Automatic renewal.

NoRenew: Non-renewal.

RenewPeriod Integer optional Example: 1

The period for a single automatic renewal, in month. Valid values: 1–3, 6, and 12. Default: 1.

tip

This parameter takes effect when RenewType is set to Auto.

RemainRenewTimes Integer optional Example: 2

The number of automatic renewals. Values include -1 and 1 to 100. The default is -1, meaning unlimited automatic renewals.

tip

This parameter takes effect when RenewType is set to Auto.

Response parameters

This API does not have specific response parameters. For more information, see Response structure.

Request examples

GET /?Action=SetTransitRouterBandwidthPackageRenewal&Version=2020-04-01&TransitRouterBandwidthPackageId=tr-bp-qw2u6ur8lhe2t****&RenewType=Auto HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250721T083654Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250721/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
  "ResponseMetadata": {​
    "RequestId": "202507211636580162170941347CE491",​
    "Action": "SetTransitRouterBandwidthPackageRenewal",​
    "Version": "2020-04-01",​
    "Service": "transitrouter",​
    "Region": "cn-beijing"​
  },​
  "Result": {}​
}​

Error codes

The table below describes the error codes for this API that are associated with business logic. For more information, see Common error codes.

Status code	Error codes	Error message	Explanation
400	InvalidTransitRouterBandwidthPackage.ModifyRenewalSettings	Modify renewal settings failed.	Failed to modify automatic renewal settings.
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	UnsupportedOperation.PrepaidInstanceRequired	The specified request is denied because the bandwidth package is not a prepaid bandwidth package.	The specified bandwidth package is not a prepaid package. Action unsupported.
404	InvalidTransitRouterBandwidthPackage.NotFound	The specified bandwidth package id does not exist.	The specified bandwidth package does not exist.

Last updated: 2026.01.06 11:56:30