CreateQosPolicy - Smart Access Gateway - Alibaba Cloud Documentation Center

The CreateQosPolicy operation creates a stream classification rule for a Quality of Service (QoS) policy.

Operation description

Before you create quintuple rules for a QoS policy, you must create a throttling rule for that policy. For more information, see CreateQosCar.

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:CreateQosPolicy

create

*Qos

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

None

Request parameters

Parameter	Type	Required	Description	Example
Description	string	No	The description of the stream classification rule for the QoS policy. The description must be 1 to 512 characters in length. It must start with a letter or a Chinese character and can contain digits, underscores (_), and hyphens (-).	desctest
RegionId	string	Yes	The ID of the region where the QoS policy is located.	cn-shanghai
QosId	string	Yes	The instance ID of the QoS policy.	qos-xitd8690ucu8ro****
Priority	integer	Yes	The priority of the throttling rule to which the stream classification rule belongs. Valid values: 1 to 3. A smaller value indicates a higher priority.	3
SourceCidr	string	Yes	The source CIDR block. Specify the value in CIDR format. Example: 192.168.1.0/24.	10.10.10.0/24
DestCidr	string	Yes	The destination CIDR block. Specify the value in CIDR format. Example: 192.168.10.0/24.	10.10.20.0/24
IpProtocol	string	Yes	The protocol type for the stream classification rule. For information about the supported protocol types, see the console.	TCP
SourcePortRange	string	Yes	The source port range. Valid values: -1 or 1 to 65535. Examples of source port range formats: 1/200: indicates port range 1 to 200. 80/80: indicates port 80. -1/-1: indicates that the port is not restricted.	80/80
DestPortRange	string	Yes	The destination port range. Valid values: -1 or 1 to 65535. Examples of destination port range formats: 1/200: indicates port range 1 to 200. 80/80: indicates port 80. -1/-1: indicates that the port is not restricted.	80/80
StartTime	string	No	The time when the stream classification rule starts to take effect. The time is specified in the ISO 8601 standard and is in UTC+8. The format is `YYYY-MM-DDThh:mm:ss+0800`.	2022-07-14T16:41:33+0800
EndTime	string	No	The time when the stream classification rule stops taking effect. The time is specified in the ISO 8601 standard and is in UTC+8. The format is `YYYY-MM-DDThh:mm:ss+0800`.	2022-09-14T16:41:33+0800
Name	string	No	The name of the stream classification rule. The name must be 2 to 100 characters in length. It must start with a letter or a Chinese character and can contain digits, hyphens (-), and underscores (_).	nametest
DpiSignatureIds	array	No	A list of application IDs.	1
	string	No	The application ID. You can enter up to 100 application IDs at a time. To query application IDs and their information, call the ListDpiSignatures operation.	1
DpiGroupIds	array	No	A list of application group IDs.	20
	string	No	The application group ID. You can enter up to 100 application group IDs at a time. To query application group IDs and the applications they contain, call the ListDpiGroups operation.	20

Response parameters

Parameter	Type	Description	Example
	object	The response that is returned.
Description	string	The description of the stream classification rule.	desctest
EndTime	string	The time when the stream classification rule stops taking effect.	2022-09-14T16:41:33+0800
RequestId	string	The request ID.	97862812-2C7E-4D25-B0D5-B26DAC7FA293
QosPolicyId	string	The instance ID of the stream classification rule.	qospy-xhwhyuo43l********
SourcePortRange	string	The source port range.	80/80
SourceCidr	string	The source CIDR block.	10.10.10.0/24
Priority	integer	The priority of the throttling rule to which the stream classification rule belongs.	3
StartTime	string	The time when the stream classification rule starts to take effect.	2022-07-14T16:41:33+0800
DestPortRange	string	The destination port range.	80/80
DpiGroupIds	object
DpiGroupId	array	The information about the application groups.
	string	A list of application group IDs.	20
Name	string	The name of the stream classification rule.	nametest
DestCidr	string	The destination CIDR block.	10.10.10.0/24
DpiSignatureIds	object
DpiSignatureId	array	The information about the applications.
	string	A list of application IDs.	1
QosId	string	The instance ID of the QoS policy.	qos-xitd8690ucu8ro****
IpProtocol	string	The protocol type that is used by the stream classification rule.	TCP

Examples

Success response

JSON format

{
  "Description": "desctest",
  "EndTime": "2022-09-14T16:41:33+0800",
  "RequestId": "97862812-2C7E-4D25-B0D5-B26DAC7FA293",
  "QosPolicyId": "qospy-xhwhyuo43l********",
  "SourcePortRange": "80/80",
  "SourceCidr": "10.10.10.0/24",
  "Priority": 3,
  "StartTime": "2022-07-14T16:41:33+0800",
  "DestPortRange": "80/80",
  "DpiGroupIds": {
    "DpiGroupId": [
      "20"
    ]
  },
  "Name": "nametest",
  "DestCidr": "10.10.10.0/24",
  "DpiSignatureIds": {
    "DpiSignatureId": [
      "1"
    ]
  },
  "QosId": "qos-xitd8690ucu8ro****",
  "IpProtocol": "TCP"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotSupportedProtocol	The specified protocol of the QoS policy is not supported.	The specified protocol of the QoS policy is not supported.
400	InvalidId.Qos	The specified QosId is invalid.	The QosId parameter is set to an invalid value.
400	QosPolicyPerQosAmountLimit	The maximum number of policies in a QoS is exceeded. You can submit a ticket to increase the quota.	The maximum number of rules in a QoS policy has reached the upper limit. You can submit a ticket to increase the quota.
400	MissParameter.RegionId	You must specify RegionId.	You must set the RegionId parameter.
400	MissParameter.QosId	You must specify QosId.	You must set the QosId parameter.
400	MissParameter.QosPolicyId	You must specify QosPolicyId.	You must set the QosPolicyId parameter.
400	InvalidParameter.Priority	The specified Priority is invalid.	The Priority parameter is set to an invalid value.
400	MissParameter.SourceCidr	You must specify SourceCidr.	You must set the SourceCidr parameter.
400	MissParameter.SourcePortRange	You must specify SourcePortRange.	You must set the SourcePortRange parameter.
400	MissParameter.DestCidr	You must specify DestCidr.	You must set the DestCidr parameter.
400	MissParameter.DestPortRange	You must specify DestPortRange.	You must set the DestPortRange parameter.
400	MissParameter.IpProtocol	You must specify IpProtocol.	You must set the IpProtocol parameter.
400	InvalidParameter.Description	The specified Description is invalid.	The Description parameter is set to an invalid value.
400	InvalidParameter.DestCidr	The specified DestCidr is invalid.	The DestCidr parameter is set to an invalid value.
400	InvalidParameter.DestPortRange	The specified DestPortRange is invalid.	The DestPortRange parameter is set to an invalid value.
400	InvalidParameter.SourceCidr	The specified SourceCidr is invalid.	The SourceCidr parameter is set to an invalid value.
400	InvalidParameter.SourcePortRange	The specified SourcePortRange is invalid.	The SourcePortRange parameter is set to an invalid value.
400	InvalidParameter.StartTime	The specified StartTime is invalid.	The StartTime parameter is set to an invalid value.
400	InvalidParameter.EndTime	The specified EndTime is invalid.	The EndTime parameter is set to an invalid value.
400	InvalidTimeRangeCompare	The specified end time is earlier than the start time. Please check your input.	The specified end time is earlier than the start time. Please check your input.
400	InvalidParameter.Name	The specified Name is invalid.	The Name parameter is set to an invalid value.
403	InternalError	An internal server error occurred.	An internal server error occurred.
403	InvalidPortRange	The specified port range is invalid.	The specified port range is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.