Create a queue for a quality of service (QoS) policy.

Usage note

CreateCenInterRegionTrafficQosQueue is an asynchronous operation. After you send a request, the queue ID is returned but the operation is still being performed in the system background. You can call ListCenInterRegionTrafficQosPolicies to query the status of the QoS policy to determine the status of the queue. When you call this operation, you must set the TrafficQosPolicyId parameter.

  • If a QoS policy is in the Modifying state, the queue is being created. In this case, you can query the QoS policy and queue but cannot perform other operations.
  • If a QoS policy is in the Active state, the queue is created.

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 CreateCenInterRegionTrafficQosQueue

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

ClientToken String No 123e4567-e89b-12d3-a456-426****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must ensure that it is unique among all requests. The token can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
DryRun Boolean No false

Specifies whether only to precheck the request. Valid values:

  • true: prechecks the request but does not create the resource. The system checks the required parameters, the request format, and the service limits. If the request fails to pass the precheck, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): sends the request. After the request passes the precheck, the queue is created.
QosQueueName String No nametest

Enter a name for the queue.

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

QosQueueDescription String No desctest

The description of the queue.

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

RemainBandwidthPercent String Yes 20

The maximum bandwidth of the queue,

  • in percentage. For example, a value of 20 specifies that the queue can occupy at most 20% of the bandwidth allocated to the inter-region connection.
  • The sum of percentage values specified for all queues that belong to the same inter-region connection cannot exceed 100%.
TrafficQosPolicyId String Yes qos-qdvybn468kaoxx****

The ID of the QoS policy.

Dscps.N Integer Yes 5

The differentiated services code point (DSCP) value that matches the current queue.

You can specify at most 20 DSCP values for a queue in each call. Separate DSCP values with commas (,).

Response parameters

Parameter Type Example Description
QosQueueId String qos-queue-irqhi8k5fdyuu5****

The ID of the queue.

RequestId String 845F66F6-5C27-53A1-9428-B859086237B2

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateCenInterRegionTrafficQosQueue
&ClientToken=123e4567-e89b-12d3-a456-426****
&DryRun=false
&QosQueueName=nametest
&QosQueueDescription=desctest
&RemainBandwidthPercent=20
&TrafficQosPolicyId=qos-qdvybn468kaoxx****
&Dscps=[5]
&Common request parameters

Sample responses

XML format

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

<CreateCenInterRegionTrafficQosQueueResponse>
    <QosQueueId>qos-queue-irqhi8k5fdyuu5****</QosQueueId>
    <RequestId>845F66F6-5C27-53A1-9428-B859086237B2</RequestId>
</CreateCenInterRegionTrafficQosQueueResponse>

JSON format

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

{
  "QosQueueId" : "qos-queue-irqhi8k5fdyuu5****",
  "RequestId" : "845F66F6-5C27-53A1-9428-B859086237B2"
}

Error codes

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