DescribeQosPolicies - Smart Access Gateway - Alibaba Cloud Documentation Center

You can call the DescribeQosPolicies operation to query the quintuple rule configurations for a Quality of Service (QoS) policy.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:DescribeQosPolicies

get

*Qos

acs:smartag:{#regionId}:{#accountId}:qos/{#QosId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the QoS policy instance resides.	cn-hangzhou
QosId	string	Yes	The ID of the QoS policy instance.	qos-xitd8690ucu8ro****
QosPolicyId	string	No	The ID of the quintuple rule instance in the QoS policy.	qospy-427m9fo6wkh****
Description	string	No	The description of the quintuple rule instance in the QoS policy. The description must be 1 to 512 characters in length, start with a letter or a Chinese character, and can contain digits, underscores (_), and hyphens (-).	docdesc
PageSize	integer	No	The number of quintuple rules to return on each page. The default value is 10. The maximum value is 50.	10
PageNumber	integer	No	The page number. The default value is 1.	1
Priority	integer	No	The priority of the throttling rule to which the quintuple rule in the QoS policy belongs. The priority range is 1 to 3. A smaller value indicates a higher priority. Note If you have submitted a ticket and created a priority-4 QoS policy by calling the CreateQosPolicy operation, you can use this operation to query the configurations of quintuple rules for the priority-4 QoS policy.	1

Response parameters

Parameter	Type	Description	Example
	object	A list of quintuple rule configurations for the QoS policy.
QosPolicies	object
QosPolicy	array<object>	A list of quintuple rule configurations for the QoS policy.
	object
DpiSignatureIds	object
DpiSignatureId	array	A list of application IDs.
	string	An application ID. You can call the ListDpiSignatures operation to query application IDs and their corresponding application information.	1
IpProtocol	string	The protocol type of the quintuple rule in the QoS policy.	TCP
QosId	string	The ID of the QoS policy instance.	qos-xitd8690ucu8ro****
Priority	integer	The priority of the throttling rule to which the quintuple rule in the QoS policy belongs.	1
EndTime	string	The time when the quintuple rule in the QoS policy stops taking effect.	2019-07-14T16:41:33+0800
StartTime	string	The time when the quintuple rule in the QoS policy starts to take effect.	2019-07-14T16:41:33+0800
Description	string	The description of the quintuple rule in the QoS policy.	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 quintuple rule instance in the QoS policy.	qospy-427m9fo6wkh****
Name	string	The name of the quintuple rule in the QoS policy.	test
SourceCidr	string	The source CIDR block.	10.0.0.0/24
SourcePortRange	string	The source port range.	80/80
DpiGroupIds	object
DpiGroupId	array	A list of application group IDs.
	string	An application group ID. You can call the ListDpiGroups operation to query application group IDs and the applications they contain.	20
TotalCount	integer	The total number of quintuple rules that meet the query conditions.	2
PageSize	integer	The number of quintuple rules returned on each page.	10
RequestId	string	The request ID.	97862812-2C7E-4D25-B0D5-B26DAC7FA293
PageNumber	integer	The page number.	1

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.