All Products
Search
Document Center

Cloud Enterprise Network:CreateCenInterRegionTrafficQosQueue

Last Updated:Nov 19, 2024

Creates queues in a quality of service (QoS) policy to manage network traffic based on finer granularities, improve service performance, and meet service-level agreements (SLAs).

Operation description

The CreateCenInterRegionTrafficQosQueue operation is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the ListCenInterRegionTrafficQosPolicies operation 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

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:CreateCenInterRegionTrafficQosQueuecreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
123e4567-e89b-12d3-a456-426****
DryRunbooleanNo

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run. The system checks the required parameters, the request format, and the service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and sends the request.
false
QosQueueNamestringNo

The name of the queue.

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

nametest
QosQueueDescriptionstringNo

The description of the 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://.

desctest
RemainBandwidthPercentstringNo

The maximum percentage of inter-region bandwidth that can be allocated to the queue.

  • Unit: percentage. For example, a value of 20 specifies that the queue can consume at most 20% of inter-region bandwidth.
  • The sum of the percentage values specified for all queues that belong to the same inter-region connection cannot exceed 100%.
20
BandwidthlongNo

The maximum absolute bandwidth value that can be allocated to the queue. Unit: Mbit/s.

  • The value specifies an absolute bandwidth. For example, a value of 20 specifies that the queue can consume at most 20 Mbit/s of bandwidth.
  • The sum of the bandwidth values specified for all queues that belong to the same inter-region connection cannot exceed the maximum bandwidth of the inter-region connection.
20
TrafficQosPolicyIdstringYes

The ID of the QoS policy.

qos-qdvybn468kaoxx****
DscpsarrayYes

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 (,).

integerYes

The 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 (,).

5

Response parameters

ParameterTypeDescriptionExample
object

The response.

QosQueueIdstring

The ID of the queue.

qos-queue-irqhi8k5fdyuu5****
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.RemainBandwidthPercentThe specified RemainBandwidthPercent is invalid.The error message returned because the RemainBandwidthPercent parameter is set to invalid value.
400IncorrectStatus.TrafficQosPolicyThe status of TrafficQosPolicy is incorrect.The error message returned because the status of the specified QoS policy does not support the operation.
400Duplicated.DscpsThe parameter Dscps are duplicated.The error message returned because the descriptions are duplicate.
400InvalidDescriptionDescription is invalid.The error message returned because the description is invalid.
400InvalidNameName is invalid.The error message returned because the specified name is invalid.
400MissingParam.BandwidthThe parameter Bandwidth is mandatory.The error message returned because no bandwidth value is specified. You must specify a bandwidth value.
400IllegalParam.BandwidthGuaranteeModeMismatchThe BandwidthGuaranteeMode does not match the Bandwidth or RemainBandwidthPercent.The BandwidthGuaranteeMode does not match the Bandwidth or RemainBandwidthPercent.
400IllegalParam.AttachmentBandwidthExceedThe entered bandwidth causes the total QoS guaranteed bandwidth to exceed the cross-region bandwidth allocation value.The entered bandwidth causes the total QoS guaranteed bandwidth to exceed the cross-region bandwidth allocation value.
400MissingParam.RemainBandwidthPercentRemainBandwidthPercent is missing.RemainBandwidthPercent is missing.
400IllegalParam.BandwidthBandwidth is illegalThe error message returned because the specified bandwidth value is invalid.
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.
404InvalidTrafficQosPolicyId.NotFoundThe specified TrafficQosPolicyId is not found.The error message returned because the specified QoS policy ID (TrafficQosPolicyId) does not exist.

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 changedView Change Details
2024-08-16The Error code has changedView Change Details
2023-12-13The Error code has changedView Change Details
2023-01-09The Error code has changedView Change Details