Queries quality of service (QoS) policies.
Operation description
Before you call the ListCenInterRegionTrafficQosPolicies operation, take note of the following information:
- You must specify at least one of the TransitRouterId and TrafficQosPolicyId parameters.
- If you do not specify a QoS policy ID (TrafficQosPolicyId), the system returns information based on the values of the TransitRouterId, TransitRouterAttachmentId, TrafficQosPolicyName, and TrafficQosPolicyDescription parameters. The information about the queues in the QoS policies is not returned. In this case, the TrafficQosQueues parameter is not included in the response.
- If you specify a QoS policy ID (TrafficQosPolicyId), the system returns the information about the QoS policy and queues in the QoS policy. In this case, the TrafficQosQueues parameter is included in the response. If the value of the TrafficQosQueues parameter is an empty string, it indicates that the QoS policy contains only the default queue.
- Make sure that all the request parameters are valid. If a request parameter is invalid, a request ID is returned but the information about the QoS policy 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 Resourcesis 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:ListCenInterRegionTrafficQosPolicies | list | *All Resources * |
| 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-r6g0m3epjehw57**** |
| TrafficQosPolicyId | string | No | The ID of the QoS policy. | qos-rnghap5gc8155x**** |
| TrafficQosPolicyName | string | No | The name of the QoS policy. The name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty. | nametest |
| TrafficQosPolicyDescription | string | No | The description of the QoS policy. The description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty. | desctest |
| 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 token that determines the start point of the query. Valid values:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "113BFD47-63DF-5D9D-972C-033FB9C360CD",
"TotalCount": 1,
"MaxResults": 20,
"TrafficQosPolicies": [
{
"TrafficQosPolicyName": "nametest",
"TrafficQosPolicyStatus": "Creating",
"TrafficQosPolicyId": "qos-rnghap5gc8155x****",
"TrafficQosPolicyDescription": "desctest",
"BandwidthGuaranteeMode": "byBandwidthPercent",
"TrafficQosQueues": [
{
"QosQueueName": "namtest",
"RemainBandwidthPercent": 1,
"Bandwidth": "1",
"QosQueueId": "qos-queue-njcrmr9fiu1jii****",
"QosQueueDescription": "desctest",
"Dscps": [
5
],
"EffectiveBandwidth": "1.35"
}
],
"TransitRouterId": "tr-2ze4ta4v32umj0rb***",
"TransitRouterAttachmentId": "tr-attach-q7ct7c06jpw***"
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | MissingParam.TransitRouterIdOrTrafficQosPolicyId | Either TransitRouterId or TrafficQosPolicyId must be specified. | - |
| 400 | InvalidDescription | Description is invalid. | The error message returned because the description is invalid. |
| 400 | InvalidName | Name is invalid. | The error message returned because the specified name is invalid. |
| 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 response structure of the API has changed | View Change Details |
| 2023-12-13 | The Error code has changed | View Change Details |
| 2021-11-26 | Add Operation | View Change Details |