Queries quality of service (QoS) policies in a specified region.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeQoses |
The operation that you want to perform. Set the value to DescribeQoses. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where the QoS policy is deployed. |
QosIds | String | No | qos-oek3r2cmvk7m8q**** |
The ID of the QoS policy.
|
QosName | String | No | zxtest |
The name of the QoS policy. The name must be 2 to 100 characters in length and can contain letters, digits, periods (.), underscores (_),and hyphens (-). The name must start with a letter. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 50. |
PageNumber | Integer | No | 1 |
The number of the page to return. Default value: 1. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
TotalCount | Integer | 1 |
The total number of QoS polices. |
PageSize | Integer | 10 |
The number of entries returned per page. |
RequestId | String | 2B5F35DD-0D66-41FC-AA99-BAE473E1A7A2 |
The ID of the request. |
PageNumber | Integer | 1 |
The page number of the returned page. |
Qoses | Array of Qos |
The list of QoS policies. |
|
Qos | |||
QosDescription | String | description |
The description of the QoS policy. |
SagCount | String | 0 |
The number of the SAG instances to which the QoS policy is applied. |
SmartAGIds | String | sag-x34wj76fe0vhw*****,sag-jp04l844chg16***** |
The IDs of the SAG instances to which the QoS policy is applied. |
QosId | String | qos-oek3r2cmvk7m8q**** |
The ID of the QoS policy. |
QosName | String | zxtest |
The name of the QoS policy. |
ResourceGroupId | String | rg-acfm2iu4fnc**** |
The ID of the resource group to which the QoS policy belongs. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeQoses
&RegionId=cn-shanghai
&QosIds=qos-oek3r2cmvk7m8q****
&QosName=zxtest
&PageSize=10
&PageNumber=1
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeQosesResponse>
<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<RequestId>2B5F35DD-0D66-41FC-AA99-BAE473E1A7A2</RequestId>
<PageNumber>1</PageNumber>
<Qoses>
<Qos>
<SagCount>0</SagCount>
<ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
<QosId>qos-oek3r2cmvk7m8q****</QosId>
<QosName>zxtest</QosName>
</Qos>
</Qoses>
</DescribeQosesResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 1,
"PageSize" : 10,
"RequestId" : "2B5F35DD-0D66-41FC-AA99-BAE473E1A7A2",
"PageNumber" : 1,
"Qoses" : {
"Qos" : [ {
"SagCount" : 0,
"ResourceGroupId" : "rg-acfm2iu4fnc****",
"QosId" : "qos-oek3r2cmvk7m8q****",
"QosName" : "zxtest"
} ]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
403 | InvalidParameter | The specified parameter is invalid. | The error message returned because a parameter is set to an invalid value. |
403 | MissingParameter | The input parameter is missing, please check your input. | The error message returned because one or more required parameters are not set. Check whether you have set all required parameters. |
403 | InternalError | An internal server error occurred. | The error message returned because an internal server error has occurred. |
For a list of error codes, visit the API Error Center.