DescribeExpressConnectTrafficQos API Reference - Express Connect - Alibaba Cloud - Express Connect

Queries quality of service (QoS) policies for Express Connect, with pagination support.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region in which the QoS policy is created. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can use the client to generate the token, but make sure each token is unique across 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.	02fb3da4-130e-11e9-8e44-0016e04115b
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can use the client to generate the token, but make sure each token is unique across 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.	02fb3da4-130e-11e9-8e44-0016e04115b
QosIdList	array	No	The IDs of QoS policies.
	string	No	The IDs of QoS policies.	qos-2giu0a6vd5x0mv****
QosNameList	array	No	The names of QoS policies.
	string	No	The names of QoS policies.	qos-test
NextToken	string	No	The pagination token used to retrieve a new page of results. If no value is returned for NetToken, you do not need to specify this parameter. If a value is returned for NextToken, you must specify the token that is obtained from the previous query as the value of NextToken.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return. Valid values: 1 to 100. Default value: 10.	20
ResourceGroupId	string	No	The resource group ID.	rg-acfmxazfdgdg****
Tags	array<object>	No	The tags of the resource.
	object	No	The tags of the resource.
Key	string	No	The tag key. At least one tag key is required. You can specify up to 20 tag keys. The tag key cannot be an empty string. A tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. A tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	4CF20CC7-D1FC-425B-A15B-DF7C8E2131A7
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists. If a value is returned for NextToken, the value can be used in the next request to retrieve a new page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
TotalCount	integer	The number of returned entries.	10
Count	string	The total number of entries returned.	1
QosList	array<object>	The information about QoS policies.
	array<object>	The information about the QoS policies.
QosId	string	The ID of the QoS policy.	qos-pksbqfmotl5hzq****
QosName	string	The name of the QoS policy. The name can be up to 128 characters in length and cannot start with `http://` or `https://`.	qos-test
QosDescription	string	The description of the QoS policy. The description can be up to 256 characters in length. It cannot start with `http://` or `https://`.	qos-test
Status	string	The state of the QoS policy. Valid values: Normal: The QoS policy is available. Configuring: The QoS policy is being configured. Note If a QoS policy is in the Configuring state, you cannot perform most of the operations to create, update, or delete QoS policies, QoS queues, or QoS rules. Valid values: Configuring : Configuring Normal : Normal	Normal
Progressing	integer	The configuration progress of the QoS policy. Valid values: 0 to 100.	100
AssociatedInstanceList	array<object>	The instances associated with the QoS policy.
	object
InstanceId	string	The ID of the instance associated with the QoS policy.	pc-bp159zj8zujwy3p07****
InstanceType	string	The type of the instance associated with the QoS policy. Only PHYSICALCONNECTION is returned. Valid values: PHYSICALCONNECTION : PHYSICALCONNECTION	PHYSICALCONNECTION
InstanceStatus	string	The state of the instance associated with the QoS policy. Valid values: Normal: The instance is available. Configuring: The instance is being configured. Deleting: The instance is being deleted. Valid values: Configuring : Configuring Normal : Normal Deleting : Deleting	Normal
InstanceProgressing	integer	The configuration progress of the instance associated with the QoS policy. Valid values: 0 to 100.	100
QueueList	array<object>	The information about the QoS queues.
	object
QosId	string	The ID of the QoS policy.	qos-pksbqfmotl5hzq****
QueueId	string	The ID of the QoS queue.	qos-queue-9nyx2u7n71s2rc****
QueueType	string	The type of the QoS queue. Valid values: High: high-priority queue. Medium: standard queue. Default: default queue. Note You cannot create a default queue. Valid values: High : High Medium : Medium Default : Default	High
BandwidthPercent	string	The percentage of bandwidth allocated to a QoS queue. If QueueType is set to Medium, this parameter is required. 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 can be up 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 can be up to 256 characters in length. It cannot start with `http://` or `https://`.	qos-queue-test
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
ResourceGroupId	string	The ID of the resource group.	rg-acfmz7vtyl4f***
Tags	array<object>	The tag list.
	object	The tag list.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua

Examples

Success response

JSON format

{
  "RequestId": "4CF20CC7-D1FC-425B-A15B-DF7C8E2131A7",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20,
  "TotalCount": 10,
  "Count": "1",
  "QosList": [
    {
      "QosId": "qos-pksbqfmotl5hzq****",
      "QosName": "qos-test",
      "QosDescription": "qos-test",
      "Status": "Normal",
      "Progressing": 100,
      "AssociatedInstanceList": [
        {
          "InstanceId": "pc-bp159zj8zujwy3p07****",
          "InstanceType": "PHYSICALCONNECTION",
          "InstanceStatus": "Normal",
          "InstanceProgressing": 100
        }
      ],
      "QueueList": [
        {
          "QosId": "qos-pksbqfmotl5hzq****",
          "QueueId": "qos-queue-9nyx2u7n71s2rc****",
          "QueueType": "High",
          "BandwidthPercent": "100",
          "QueueName": "qos-queue-test",
          "QueueDescription": "qos-queue-test",
          "Status": "Normal"
        }
      ],
      "ResourceGroupId": "rg-acfmz7vtyl4f***",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ]
}

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.