All Products
Search
Document Center

Smart Access Gateway:DescribeQoses

Last Updated:Mar 03, 2024

Queries quality of service (QoS) policies in a specified region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:DescribeQosesRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the QoS policy is deployed.

cn-shanghai
QosIdsstringNo

The ID of the QoS policy.

  • Separate multiple QoS polices with commas (,).
  • If you do not specify this parameter, all QoS policies in the region are queried.
qos-oek3r2cmvk7m8q****
QosNamestringNo

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.

zxtest
PageSizeintegerNo

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

10
PageNumberintegerNo

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

1

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of QoS polices.

1
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

2B5F35DD-0D66-41FC-AA99-BAE473E1A7A2
PageNumberinteger

The page number of the returned page.

1
Qosesobject []

The list of QoS policies.

QosDescriptionstring

The description of the QoS policy.

description
SagCountstring

The number of the SAG instances to which the QoS policy is applied.

0
SmartAGIdsstring

The IDs of the SAG instances to which the QoS policy is applied.

sag-x34wj76fe0vhw*****,sag-jp04l844chg16*****
QosIdstring

The ID of the QoS policy.

qos-oek3r2cmvk7m8q****
QosNamestring

The name of the QoS policy.

zxtest
ResourceGroupIdstring

The ID of the resource group to which the QoS policy belongs.

rg-acfm2iu4fnc****

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "2B5F35DD-0D66-41FC-AA99-BAE473E1A7A2",
  "PageNumber": 1,
  "Qoses": {
    "Qos": [
      {
        "QosDescription": "description",
        "SagCount": "0",
        "SmartAGIds": "sag-x34wj76fe0vhw*****,sag-jp04l844chg16*****",
        "QosId": "qos-oek3r2cmvk7m8q****",
        "QosName": "zxtest",
        "ResourceGroupId": "rg-acfm2iu4fnc****"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
403InvalidParameterThe specified parameter is invalid.Invalid parameters.
403MissingParameterThe input parameter is missing, please check your input.Missing parameters. Check whether all required parameters are set.
403InternalErrorAn internal server error occurred.An internal server error occurred.

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