All Products
Search
Document Center

Cloud Enterprise Network:ListCenInterRegionTrafficQosQueues

Last Updated:Oct 22, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cen:ListCenInterRegionTrafficQosQueuesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TransitRouterIdstringNo

The ID of the transit router.

tr-bp1rmwxnk221e3fas****
TransitRouterAttachmentIdstringNo

The ID of the inter-region connection.

tr-attach-a6p8voaodog5c0****
TrafficQosPolicyIdstringNo

The ID of the QoS policy.

qos-rnghap5gc8155x****
TrafficQosQueueIdstringNo

The ID of the queue.

qos-queue-siakjb2nn9gz5z****
TrafficQosQueueNamestringNo

The name of the QoS queue.

The name must be 1 to 128 characters in length, and cannot start with http:// or https://.

qosQueueName
TrafficQosQueueDescriptionstringNo

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
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.

20
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results.

  • If NextToken is empty, no next page exists.
  • If a value of NextToken is returned, the value indicates the token that is used for the next query.
2ca1ed1573cb****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. Valid values:

  • If NextToken is empty, no next page exists.
  • If a value of NextToken is returned, the value indicates the token that is used for the next query.
0151fa6aa1ed****
RequestIdstring

The ID of the request.

1D1E15D2-416D-54F3-BDD9-BC27DE4C6352
TrafficQosQueuesarray<object>

The information about the QoS queue.

TrafficQosQueueobject

The information about the queue.

TransitRouterAttachmentIdstring

The ID of the inter-region connection.

tr-attach-nzrcv25d7ezt23****
TransitRouterIdstring

The ID of the transit router.

tr-p0wwagjv6fvxt4b7y****
TrafficQosQueueNamestring

The name of the QoS queue.

qosQueueName
RemainBandwidthPercentinteger

The percentage of the inter-region bandwidth that can be consumed by the QoS queue.

A value of 1 indicates that the QoS queue can consume at most 1% of the inter-region bandwidth.

1
TrafficQosPolicyIdstring

The ID of the QoS policy.

qos-fv2qq9yqrsjowp****
TrafficQosQueueIdstring

The ID of the QoS queue.

qos-queue-siakjb2nn9gz5z****
TrafficQosQueueDescriptionstring

The description of the QoS queue.

qosQueueDescription
Dscpsarray

The Differentiated Services Code Point (DSCP) value that matches the current QoS queue.

Dscpinteger

The DSCP value that matches the current QoS queue.

1
Statusstring

The status of the QoS queue. Valid values:

  • Creating
  • Active
  • Deleting
Active

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400MissingParam.TransitRouterIdOrTrafficQosPolicyIdOrTrafficQosQueueIdEither TransitRouterId or TrafficQosPolicyId or TrafficQosQueueId must be specified.-
400InvalidParameter.MaxResultsThe specified MaxResults is invalid. -
400InvalidNameName is invalid.The error message returned because the specified name is invalid.
400InvalidDescriptionDescription is invalid.The error message returned because the description is invalid.
400IllegalParam.EffectiveBandwidthFilterThe input bandwidth filter value is not valid.The input bandwidth filter value is not valid.
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe 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 timeSummary of changesOperation
2024-08-28The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2024-08-16The Error code has changedView Change Details
2023-12-13The Error code has changedView Change Details