DescribeExpressConnectTrafficQosQueue - Express Connect - Alibaba Cloud Documentation Center

Queries the information about the quality of service (QoS) queues of the Express Connect circuit.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeExpressConnectTrafficQosQueue	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the QoS policy. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
ClientToken	string	Yes	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 client 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.	0c593ea1-3bea-11e9-b96b-88e9fe63****
QueueIdList	array	No	The IDs of the QoS queues.
	string	No	The ID of the QoS queue.	qos-queue-9nyx2u7n71s2rcy4n5
QueueNameList	array	No	The names of the QoS queues.
	string	No	The name of the QoS queue.	qos-queue-test
QosId	string	No	The ID of the QoS policy.	qos-2giu0a6vd5x0mv4700

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	606998F0-B94D-48FE-8316-ACA81BB230DA
QueueList	array<object>	The information about the QoS queues.
queueList	object	The information about the QoS queue.
QosId	string	The ID of the QoS policy.	qos-ncfgzxg40zks5n0qze
QueueId	string	The ID of the QoS queue.	qos-queue-9nyx2u7n71s2rcy4n5
QueueType	string	The priority of the QoS queue. Valid values: High Medium Default Note You cannot create a QoS queue of the default priority.	High
BandwidthPercent	string	The percentage of bandwidth allocated to a QoS queue. If QueueType is set to Medium, this parameter is returned. Valid values: 1 to 100. If QueueType is set to Default, a value of - is returned.	100
QueueName	string	The name of the QoS queue. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	qos-queue-test
QueueDescription	string	The description of the QoS queue. The name must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	qos-queue-test
RuleList	array<object>	The information about the QoS rules.
ruleList	object	The information about the QoS rule.
QosId	string	The ID of the QoS policy.	qos-91xz9f8zd7yj8xwknz
QueueId	string	The ID of the QoS queue.	qos-queue-iugg0l9x27f2nocouj
Priority	integer	The priority of the QoS rule. Valid values: 1 to 9000. A larger value indicates a higher priority. The priority of each QoS rule must be unique in the same QoS policy.	1
Protocol	string	The protocol of the QoS rule. Valid values: ALL ICMP(IPv4) ICMPv6(IPv6) TCP UDP GRE SSH Telnet HTTP HTTPS MS SQL Oracle MySql RDP PostgreSQL Redis	ALL
SrcCidr	string	The source IPv4 CIDR block that matches the QoS rule traffic. Note If the parameter is unavailable, specify SrcIPv6Cidr or DstIPv6Cidr.	1.1.1.0/24
DstCidr	string	The destination IPv4 CIDR block that matches the QoS rule traffic. Note If the parameter is unavailable, specify SrcIPv6Cidr or DstIPv6Cidr.	1.1.1.0/24
SrcIPv6Cidr	string	The source IPv6 CIDR block that matches the QoS rule traffic. Note If the parameter is unavailable, specify SrcCidr or DstCidr.	2001:0db8:1234:5678::/64
DstIPv6Cidr	string	The destination IPv6 CIDR block that matches the QoS rule traffic. Note If the parameter is unavailable, specify SrcCidr or DstCidr.	2001:0db8:1234:5678::/64
SrcPortRange	string	The range of source ports that match the QoS rule traffic. Valid values: 0 to 65535. If the traffic does not match, the value is -1. You can specify only one port. The start port number must be the same as the end port number.	-1/-1
DstPortRange	string	The range of destination ports that match the QoS rule traffic. Valid values: 0 to 65535. If the traffic does not match, the value is -1. You can specify only one port. The start port number must be the same as the end port number. Different protocols correspond to different ports. Valid values: ALL (uneditable): -1/-1. ICMP(IPv4) (uneditable): -1/-1. ICMPv6(IPv6) (uneditable): -1/-1. TCP (editable): -1/-1. UDP (editable): -1/-1. GRE (uneditable): -1/-1. SSH (uneditable): 22/22. Telnet (uneditable): 23/23. HTTP (uneditable): 80/80. HTTPS (uneditable): 443/443. MS SQL (uneditable): 1443/1443. Oracle (uneditable): 1521/1521. MySql (uneditable): 3306/3306. RDP (uneditable): 3389/3389. PostgreSQL (uneditable): 5432/5432. Redis (uneditable): 6379/6379.	-1/-1
MatchDscp	integer	The DSCP value that matches the QoS rule traffic. Valid values: 0 to 63. If no value is matched, the value is -1.	1
RemarkingDscp	integer	The new DSCP value. Valid values: 0 to 63. If you do not change the value, the value is -1.	1
RuleName	string	The name of the QoS rule. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	qos-rule-test
RuleDescription	string	The description of the QoS rule. The name must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	qos-rule-test
RuleId	string	The ID of the QoS rule.	qos-rule-iugg0l9x27f2nocouj
Status	string	The status of the QoS rule. Valid values: Normal: The QoS queue is available. Configuring: The QoS queue is being configured. Deleting: The QoS queue is being deleted.	Normal
Status	string	The state of the QoS queue. Valid values: Normal: The QoS queue is available. Configuring: The QoS queue is being configured. Deleting: The QoS queue is being deleted.	Normal

Examples

Sample success responses

JSONformat

{
  "RequestId": "606998F0-B94D-48FE-8316-ACA81BB230DA",
  "QueueList": [
    {
      "QosId": "qos-ncfgzxg40zks5n0qze",
      "QueueId": "qos-queue-9nyx2u7n71s2rcy4n5",
      "QueueType": "High",
      "BandwidthPercent": 100,
      "QueueName": "qos-queue-test",
      "QueueDescription": "qos-queue-test",
      "RuleList": [
        {
          "QosId": "qos-91xz9f8zd7yj8xwknz",
          "QueueId": "qos-queue-iugg0l9x27f2nocouj",
          "Priority": 1,
          "Protocol": "ALL",
          "SrcCidr": "1.1.1.0/24",
          "DstCidr": "1.1.1.0/24\n",
          "SrcIPv6Cidr": "2001:0db8:1234:5678::/64",
          "DstIPv6Cidr": "2001:0db8:1234:5678::/64",
          "SrcPortRange": "-1/-1",
          "DstPortRange": "-1/-1",
          "MatchDscp": 1,
          "RemarkingDscp": 1,
          "RuleName": "qos-rule-test",
          "RuleDescription": "qos-rule-test",
          "RuleId": "qos-rule-iugg0l9x27f2nocouj\n",
          "Status": "Normal"
        }
      ],
      "Status": "Normal"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.%s	The param of %s is illegal.	The parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history