DescribeTransitRouterCapacityReservations - Cloud Enterprise Network

Queries the resource reservation configurations of a specified transit router.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:DescribeTransitRouterCapacityReservations

get

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
TransitRouterId	string	Yes	The ID of the Enterprise Edition transit router instance.	tr-uf6llz2286805i44g****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50
MinimumTransitRouterCapacities	array<object>	The list of reserved capacity information for each zone in the resource reservation.
	array<object>
ZoneId	string	The ID of the specified zone for the resource reservation.	cn-beijing-h
DataProcessGbps	object	The reserved capacity information of the specified zone for the resource reservation.
Effective	integer	The effective reserved value of the specified zone for the resource reservation. The effective reserved value refers to the current billed value of the resource reservation.	100
Target	integer	The target reserved value of the specified zone for the resource reservation. When you decrease the quota, the change takes effect in the next month, and the active reserved value is updated in synchronization. Upgrades and initial reservations require spooling by Alibaba Cloud and take effect immediately after the spooling is complete.	200
State	object	The status information of the specified zone for the resource reservation.
Status	string	The resource reservation status. Pending: The initial reservation is initiated and is waiting to be processed by Alibaba Cloud. Provisioning: Alibaba Cloud is processing the reservation request. Provisioned: The reservation is successful. ProvisionFailed: The reservation failed. You can refer to the failure reason. Updating: The reservation is being updated. Operations such as modifying the deployment set or increasing the reserved value require spooling by Alibaba Cloud.	Pending
Reason	string	The reason for the failure when the reservation status is ProvisionFailed. For example, Reservation.InsufficientCapacity indicates that resources are insufficient to meet the target reserved value.	Reservation.InsufficientCapacity
DeploymentSets	array<object>	The deployment set information specified for the resource reservation.
	object
ZoneID	string	The zone for which the deployment set of the resource reservation needs to be modified. To cancel the deployment set, specify the zone and leave the deployment set instance ID empty.	cn-shanghai-b
DeploymentSetID	string	The instance ID of the deployment set configured in the specified active zone of the transit router for forward routing.	ds-badxcs*****
LastModifiedTime	string	The time when the resource reservation was last modified.	2026-10-19T06:31:49Z

Examples

Success response

JSON format

{
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50",
  "MinimumTransitRouterCapacities": [
    {
      "ZoneId": "cn-beijing-h",
      "DataProcessGbps": {
        "Effective": 100,
        "Target": 200
      },
      "State": {
        "Status": "Pending",
        "Reason": "Reservation.InsufficientCapacity"
      }
    }
  ],
  "DeploymentSets": [
    {
      "ZoneID": "cn-shanghai-b",
      "DeploymentSetID": "ds-badxcs*****"
    }
  ],
  "LastModifiedTime": "2026-10-19T06:31:49Z"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTransitRouterId.NotFound	The Transit Router instance is not found.	The Transit Router instance is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.