DescribeExpressConnectTrafficQosQueue-阿里云帮助中心

Queries Express Connect QoS queues by calling DescribeExpressConnectTrafficQosQueue.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeExpressConnectTrafficQosQueue

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the QoS policy. You can call DescribeRegions to query the region ID.	cn-shanghai
ClientToken	string	No	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 RequestId of the API request as the ClientToken. The RequestId may differ for each API request.	0c593ea1-3bea-11e9-b96b-88e9fe63****
ClientToken	string	No	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 Note 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。	0c593ea1-3bea-11e9-b96b-88e9fe63****
QueueIdList	array	No	The QoS queue IDs.
	string	No	The QoS queue ID.	qos-queue-9nyx2u7n71s2rc****
QueueNameList	array	No	The QoS queue names.
	string	No	The QoS queue name.	qos-queue-test
QosId	string	No	The QoS policy ID.	qos-2giu0a6vd5x0mv****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	606998F0-B94D-48FE-8316-ACA81BB230DA
QueueList	array<object>	The list of QoS queues.
	array<object>	The QoS queue information.
QosId	string	The QoS policy ID.	qos-ncfgzxg40zks5n****
QueueId	string	The QoS queue ID.	qos-queue-9nyx2u7n71s2rc****
QueueType	string	The type of the QoS queue. Valid values: High: high-priority queue. Medium: medium-priority queue. Default: default-priority queue. Note The default-priority queue cannot be created.	High
BandwidthPercent	string	The bandwidth percentage of the QoS queue. When the QoS queue type is Medium, this field is required. Valid values: 1 to 100. When the QoS queue type is Default, this field is "-".	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 description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	qos-queue-test
RuleList	array<object>	The list of QoS rules.
	object	The QoS rule information.
QosId	string	The ID of the QoS policy.	qos-91xz9f8zd7yj8x****
QueueId	string	The ID of the QoS queue.	qos-queue-iugg0l9x27f2no****
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../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../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:****::/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:****::/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-iugg0l9x27f2no****
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 status of the QoS queue. Valid values: Normal: active. Configuring: being configured. Deleting: being deleted.	Normal

Examples

Success response

JSON format

{
  "RequestId": "606998F0-B94D-48FE-8316-ACA81BB230DA",
  "QueueList": [
    {
      "QosId": "qos-ncfgzxg40zks5n****",
      "QueueId": "qos-queue-9nyx2u7n71s2rc****",
      "QueueType": "High",
      "BandwidthPercent": "100",
      "QueueName": "qos-queue-test",
      "QueueDescription": "qos-queue-test",
      "RuleList": [
        {
          "QosId": "qos-91xz9f8zd7yj8x****",
          "QueueId": "qos-queue-iugg0l9x27f2no****",
          "Priority": 1,
          "Protocol": "ALL",
          "SrcCidr": "1.1.**.**/24",
          "DstCidr": "1.1.**.**/24\n",
          "SrcIPv6Cidr": "2001:0db8:1234:****::/64",
          "DstIPv6Cidr": "2001:0db8:1234:****::/64",
          "SrcPortRange": "-1/-1",
          "DstPortRange": "-1/-1",
          "MatchDscp": 1,
          "RemarkingDscp": 1,
          "RuleName": "qos-rule-test",
          "RuleDescription": "qos-rule-test",
          "RuleId": "qos-rule-iugg0l9x27f2no****\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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.