All Products
Search
Document Center

Smart Access Gateway:DescribeQosPolicies

Last Updated:Mar 03, 2024

Queries quality of service (QoS) rules that contain 5-tuples.

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:DescribeQosPoliciesRead
  • Qos
    acs:smartag:{#regionId}:{#accountId}:qos/{#QosId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region to which the QoS policy belongs.

cn-hangzhou
QosIdstringYes

The ID of the QoS policy.

qos-xitd8690ucu8ro****
QosPolicyIdstringNo

The ID of the 5-tuple.

qospy-427m9fo6wkh****
DescriptionstringNo

The description of the 5-tuple.

The description must be 1 to 512 characters in length, and can contain digits, underscores (_), and hyphens (-). It must start with a letter.

docdesc
PageSizeintegerNo

The number of entries to return on each page.

Default value: 10. A maximum of 50 entries can be returned on each page.

10
PageNumberintegerNo

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

1
PriorityintegerNo

The priority of the traffic throttling rule that is applied to the 5-tuple.

Valid values: 1 to 3. A smaller value indicates a higher priority.

Note If you have submitted a ticket and created a QoS policy with the priority value 4 by calling the CreateQosPolicy operation, you can set the value to 4.
1

Response parameters

ParameterTypeDescriptionExample
object
QosPoliciesobject []

The details about the 5-tuple.

DpiSignatureIdsarray

The IDs of applications.

You can call the ListDpiSignatures operation to query application IDs and information about the applications.

string
1
IpProtocolstring

The type of the protocol that is applied to the 5-tuple.

TCP
QosIdstring

The ID of the QoS policy.

qos-xitd8690ucu8ro****
Priorityinteger

The priority of the traffic throttling rule that is applied to the 5-tuple.

1
EndTimestring

The time when the 5-tuple stops taking effect.

2019-07-14T16:41:33+0800
StartTimestring

The time when the 5-tuple starts to take effect.

2019-07-14T16:41:33+0800
Descriptionstring

The description of the 5-tuple.

docdesc
DestCidrstring

The destination CIDR block.

10.10.10.0/24
DestPortRangestring

The destination port range.

90/90
QosPolicyIdstring

The ID of the 5-tuple.

qospy-427m9fo6wkh****
Namestring

The name of the 5-tuple.

test
SourceCidrstring

The range of the source IP addresses.

10.0.0.0/24
SourcePortRangestring

The range of the source port.

80/80
DpiGroupIdsarray

The ID of the application group.

You can call the ListDpiGroups operation to query application group IDs and information about the applications.

string
20
TotalCountinteger

The total number of entries returned.

2
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

97862812-2C7E-4D25-B0D5-B26DAC7FA293
PageNumberinteger

The page number of the returned page.

1

Examples

Sample success responses

JSONformat

{
  "QosPolicies": {
    "QosPolicy": [
      {
        "DpiSignatureIds": {
          "DpiSignatureId": [
            "1"
          ]
        },
        "IpProtocol": "TCP",
        "QosId": "qos-xitd8690ucu8ro****",
        "Priority": 1,
        "EndTime": "2019-07-14T16:41:33+0800",
        "StartTime": "2019-07-14T16:41:33+0800",
        "Description": "docdesc",
        "DestCidr": "10.10.10.0/24",
        "DestPortRange": "90/90",
        "QosPolicyId": "qospy-427m9fo6wkh****",
        "Name": "test",
        "SourceCidr": "10.0.0.0/24",
        "SourcePortRange": "80/80",
        "DpiGroupIds": {
          "DpiGroupId": [
            "20"
          ]
        }
      }
    ]
  },
  "TotalCount": 2,
  "PageSize": 10,
  "RequestId": "97862812-2C7E-4D25-B0D5-B26DAC7FA293",
  "PageNumber": 1
}

Error codes

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

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