Queries quality of service (QoS) policies.

Usage notes

When you call the ListCenInterRegionTrafficQosPolicies operation, take note of the following information:

  • If you set the TrafficQosPolicyId parameter, information about the specified QoS policy and the queues in the QoS policy is returned.
  • If you do not set the TrafficQosPolicyId parameter, the system returns information about QoS policies based on the values of the TransitRouterId, TransitRouterAttachmentId, TrafficQosPolicyName, and TrafficQosPolicyDescription parameters, but does not return information about the queues in the QoS policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListCenInterRegionTrafficQosPolicies

The operation that you want to perform. Set the value to ListCenInterRegionTrafficQosPolicies.

TransitRouterId String Yes tr-bp1rmwxnk221e3fas****

The ID of the transit router.

TransitRouterAttachmentId String Yes tr-attach-r6g0m3epjehw57****

The ID of the inter-region connection.

TrafficQosPolicyId String No qos-rnghap5gc8155x****

The ID of the QoS policy.

TrafficQosPolicyName String No nametest

The name of the QoS policy.

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

TrafficQosPolicyDescription String No desctest

The description of the QoS policy.

The description must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The description must start with a letter.

MaxResults Integer No 20

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

NextToken String No FFmyTO70tTpLG6I3FmYAXGKPd****

The token that is used for the next query. Valid values:

  • If this is your first query or no next query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.

Response parameters

Parameter Type Example Description
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

The token that is used for the next query.

  • If the value returned of NextToken is empty, it indicates that no next query is to be sent.
  • If a value of NextToken is returned, the value indicates the token that is used for the next query.
RequestId String 113BFD47-63DF-5D9D-972C-033FB9C360CD

The ID of the request.

TotalCount Integer 1

The number of entries returned.

MaxResults Integer 20

The number of entries returned per page.

TrafficQosPolicies Array of TrafficQosPolicy

The list of QoS policies.

TrafficQosPolicyName String nametest

The name of the QoS policy.

TrafficQosPolicyStatus String Creating

The status of the QoS policy.

  • Creating: being created
  • Active: available
  • Modifying: being modified
  • Deleting: being deleted
  • Deleted: deleted
TrafficQosPolicyId String qos-rnghap5gc8155x****

The ID of the QoS policy.

TrafficQosPolicyDescription String desctest

The description of the QoS policy.

TrafficQosQueues Array of TrafficQosQueue

The list of queues.

QosQueueName String namtest

The name of the queue.

RemainBandwidthPercent Integer 1

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

QosQueueId String qos-queue-njcrmr9fiu1jii****

The ID of the queue.

QosQueueDescription String desctest

The description of the queue.

Dscps Array of Integer 5

The differentiated services code point (DSCP) value of the packets to be matched by the queue.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListCenInterRegionTrafficQosPolicies
&TransitRouterId=tr-bp1rmwxnk221e3fas****
&TransitRouterAttachmentId=tr-attach-r6g0m3epjehw57****
&TrafficQosPolicyId=qos-rnghap5gc8155x****
&TrafficQosPolicyName=nametest
&TrafficQosPolicyDescription=desctest
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListCenInterRegionTrafficQosPoliciesResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>113BFD47-63DF-5D9D-972C-033FB9C360CD</RequestId>
    <TotalCount>1</TotalCount>
    <MaxResults>20</MaxResults>
    <TrafficQosPolicies>
        <TrafficQosPolicyName>nametest</TrafficQosPolicyName>
        <TrafficQosPolicyStatus>Creating</TrafficQosPolicyStatus>
        <TrafficQosPolicyId>qos-rnghap5gc8155x****</TrafficQosPolicyId>
        <TrafficQosPolicyDescription>desctest</TrafficQosPolicyDescription>
        <TrafficQosQueues>
            <QosQueueName>namtest</QosQueueName>
            <RemainBandwidthPercent>1</RemainBandwidthPercent>
            <QosQueueId>qos-queue-njcrmr9fiu1jii****</QosQueueId>
            <QosQueueDescription>desctest</QosQueueDescription>
            <Dscps>5</Dscps>
        </TrafficQosQueues>
    </TrafficQosPolicies>
</ListCenInterRegionTrafficQosPoliciesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "113BFD47-63DF-5D9D-972C-033FB9C360CD",
  "TotalCount" : 1,
  "MaxResults" : 20,
  "TrafficQosPolicies" : [ {
    "TrafficQosPolicyName" : "nametest",
    "TrafficQosPolicyStatus" : "Creating",
    "TrafficQosPolicyId" : "qos-rnghap5gc8155x****",
    "TrafficQosPolicyDescription" : "desctest",
    "TrafficQosQueues" : [ {
      "QosQueueName" : "namtest",
      "RemainBandwidthPercent" : 1,
      "QosQueueId" : "qos-queue-njcrmr9fiu1jii****",
      "QosQueueDescription" : "desctest",
      "Dscps" : [ 5 ]
    } ]
  } ]
}

Error codes

For a list of error codes, visit the Error Center.