You can call this operation to query quality of service (QoS) policies.

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 No DescribeQoses

The operation that you want to perform.

Set the value to DescribeQoses.

RegionId String Yes cn-hangzhou

The ID of the region where the QoS policies are deployed.

QosIds String No qos-awfxl1adxeqykl***

The IDs of QoS policies. Separate multiple IDs with commas (,).

QosName String No doctest

The names of the QoS policies.

PageSize Integer No 2

The number of entries to return on each page. Default value: 10. Maximum value: 50.

PageNumber Integer No 3

The number of the page to return. Default value: 1.

Response parameters

Parameter Type Example Description
RequestId String 23DD7A46-C36C-4593-A05C-E890252C5A38

The ID of the request.

TotalCount Integer 3

The total number of entries returned.

PageNumber Integer 2

The page number of the returned page.

PageSize Integer 3

The number of entries returned per page.

Qoses Array

The information about the QoS policies.

QosId String qos-xhwhyuo43l********

The ID of the QoS policy.

QosName String doctest

The name of the QoS policy.

SagCount String 2

The number of Smart Access Gateway (SAG) instances to which the QoS policy is applied.

SmartAGIds String sag-x34wj76fe0vhw*****,sag-jp04l844chg16*****

The SAG instances to which the QoS policy is applied.

QosDescription String description

The description of the QoS policy. The description must be 1 to 512 characters in length, and can contain digits, underscores (_), and hyphens (_). It must start with a letter or Chinese character.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeQoses
&RegionId=cn-hangzhou
&<Common request parameter>

Sample success responses

XML format

<DescribeQosesResponse>
	  <PageNumber>1</PageNumber>
	  <PageSize>10</PageSize>
	  <Qoses>
		    <Qos>
			      <QosId>qos-1lcl9gv5ew7xarxxxx</QosId>
			      <QosName>bvt-test-name1566440907</QosName>
			      <SagCount>2</SagCount>
			      <SmartAGIds>sag-x34wj76fe0vhwxxxxx,sag-jp04l844chg16vxxxx</SmartAGIds>
		    </Qos>
	  </Qoses>
	  <RequestId>CCC5FADB-9363-4D21-8121-7AF72DA3F5EF</RequestId>
	  <TotalCount>1</TotalCount>
    </DescribeQosesResponse>

JSON format

{
"PageNumber":1,
"PageSize":10,
"Qoses":{
"Qos":[
{
"QosId":"qos-1lcl9gv5ew7xarxxxx",
"QosName":"bvt-test-name1566440907",
"SagCount":2,
"SmartAGIds":"sag-x34wj76fe0vhwxxxxx,sag-jp04l844chg16vxxxx"
}
]
},
"RequestId":"CCC5FADB-9363-4D21-8121-7AF72DA3F5EF",
"TotalCount":1
}

Error codes

HttpCode Error code Error message Description
403 InvalidParameter The specified parameter is invalid. The error message returned because a specified parameter is invalid.
403 MissingParameter The input parameter is missing, please check your input. The error message returned because a required parameter is missing. Check whether you have set all required parameters.
403 InternalError An internal server error occurred. The error message returned because an internal error occurred.

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