DescribeQosPolicies - Smart Access Gateway - Alibaba Cloud Documentation Center

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:DescribeQosPolicies	Read	Qos acs:smartag:{#regionId}:{#accountId}:qos/{#QosId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region to which the QoS policy belongs.	cn-hangzhou
QosId	string	Yes	The ID of the QoS policy.	qos-xitd8690ucu8ro****
QosPolicyId	string	No	The ID of the 5-tuple.	qospy-427m9fo6wkh****
Description	string	No	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
PageSize	integer	No	The number of entries to return on each page. Default value: 10. A maximum of 50 entries can be returned on each page.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
Priority	integer	No	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

Parameter	Type	Description	Example
	object
QosPolicies	object []	The details about the 5-tuple.
DpiSignatureIds	array	The IDs of applications. You can call the ListDpiSignatures operation to query application IDs and information about the applications.
	string		1
IpProtocol	string	The type of the protocol that is applied to the 5-tuple.	TCP
QosId	string	The ID of the QoS policy.	qos-xitd8690ucu8ro****
Priority	integer	The priority of the traffic throttling rule that is applied to the 5-tuple.	1
EndTime	string	The time when the 5-tuple stops taking effect.	2019-07-14T16:41:33+0800
StartTime	string	The time when the 5-tuple starts to take effect.	2019-07-14T16:41:33+0800
Description	string	The description of the 5-tuple.	docdesc
DestCidr	string	The destination CIDR block.	10.10.10.0/24
DestPortRange	string	The destination port range.	90/90
QosPolicyId	string	The ID of the 5-tuple.	qospy-427m9fo6wkh****
Name	string	The name of the 5-tuple.	test
SourceCidr	string	The range of the source IP addresses.	10.0.0.0/24
SourcePortRange	string	The range of the source port.	80/80
DpiGroupIds	array	The ID of the application group. You can call the ListDpiGroups operation to query application group IDs and information about the applications.
	string		20
TotalCount	integer	The total number of entries returned.	2
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	97862812-2C7E-4D25-B0D5-B26DAC7FA293
PageNumber	integer	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 code	Error code	Error message	Description
400	InvalidId.Qos	The specified QosId is invalid.	The QosId parameter is set to an invalid value.
403	MissingParameter	The input parameter is missing, please check your input.	Missing parameters. Check whether all required parameters are set.
403	InvalidParameter	The specified parameter is invalid.	Invalid parameters.
403	InternalError	An internal server error occurred.	An internal server error occurred.

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