Queries the information about quality of service (QoS) queues.
Operation description
You must specify at least one of the TransitRouterId, TrafficQosPolicyId, and TrafficQosQueueId parameters.
Make sure that all the request parameters are valid. If a request parameter is invalid, a request ID is returned but the QoS queue information is not returned.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
cen:ListCenInterRegionTrafficQosQueues | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
TransitRouterId | string | No | The ID of the transit router. | tr-bp1rmwxnk221e3fas**** |
TransitRouterAttachmentId | string | No | The ID of the inter-region connection. | tr-attach-a6p8voaodog5c0**** |
TrafficQosPolicyId | string | No | The ID of the QoS policy. | qos-rnghap5gc8155x**** |
TrafficQosQueueId | string | No | The ID of the queue. | qos-queue-siakjb2nn9gz5z**** |
TrafficQosQueueName | string | No | The name of the QoS queue. The name must be 1 to 128 characters in length, and cannot start with http:// or https://. | qosQueueName |
TrafficQosQueueDescription | string | No | The description of the QoS queue. This parameter is optional. If you enter a description, it must be 1 to 256 characters in length and cannot start with http:// or https://. | qosQueueDescription |
MaxResults | integer | No | The number of entries to return on each page. Valid values: 1 to 100. Default value: 20. | 20 |
NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results.
| 2ca1ed1573cb**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"NextToken": "0151fa6aa1ed****",
"RequestId": "1D1E15D2-416D-54F3-BDD9-BC27DE4C6352",
"TrafficQosQueues": [
{
"TransitRouterAttachmentId": "tr-attach-nzrcv25d7ezt23****",
"TransitRouterId": "tr-p0wwagjv6fvxt4b7y****",
"TrafficQosQueueName": "qosQueueName",
"RemainBandwidthPercent": 1,
"Bandwidth": "1",
"EffectiveBandwidth": "1.35",
"TrafficQosPolicyId": "qos-fv2qq9yqrsjowp****",
"TrafficQosQueueId": "qos-queue-siakjb2nn9gz5z****\n",
"TrafficQosQueueDescription": "qosQueueDescription\n",
"Dscps": [
1
],
"Status": "Active"
}
]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | MissingParam.TransitRouterIdOrTrafficQosPolicyIdOrTrafficQosQueueId | Either TransitRouterId or TrafficQosPolicyId or TrafficQosQueueId must be specified. | - |
400 | InvalidParameter.MaxResults | The specified MaxResults is invalid. | - |
400 | InvalidName | Name is invalid. | The error message returned because the specified name is invalid. |
400 | InvalidDescription | Description is invalid. | The error message returned because the description is invalid. |
400 | IllegalParam.EffectiveBandwidthFilter | The input bandwidth filter value is not valid. | The input bandwidth filter value is not valid. |
400 | InvalidParameter | Invalid parameter. | The error message returned because the parameter is set to an invalid value. |
400 | Unauthorized | The AccessKeyId is unauthorized. | The error message returned because you do not have the permissions to perform this operation. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-28 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
2024-08-16 | The Error code has changed | View Change Details |
2023-12-13 | The Error code has changed | View Change Details |