Creates a traffic classification rule for a quality of service (QoS) policy.
Operation description
Prerequisites
A traffic throttling rule is created. For more information, see CreateQosCar .
Debugging
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 Resourcesis 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:CreateQosPolicy | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Description | string | No | The description of the traffic classification rule. The description must be 1 to 512 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter. | desctest |
| RegionId | string | Yes | The ID of the region to which the QoS policy belongs. | cn-shanghai |
| QosId | string | Yes | The ID of the QoS policy. | qos-xitd8690ucu8ro**** |
| Priority | integer | Yes | The priority of the traffic throttling policy to which the traffic 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 of this parameter in CIDR notation. Example: 192.168.1.0/24. | 10.10.10.0/24 |
| DestCidr | string | Yes | The destination CIDR block. Specify the value of this parameter in CIDR notation. Example: 192.168.10.0/24. | 10.10.20.0/24 |
| IpProtocol | string | Yes | The type of the protocol that applies to the traffic classification rule. The supported protocols provided in this topic are for reference only. The actual protocols in the console shall prevail. | TCP |
| SourcePortRange | string | Yes | The source port range. Valid values: 1 to 65535 and -1. Examples:
| 80/80 |
| DestPortRange | string | Yes | The destination port range. Valid values: 1 to 65535 and -1. Examples:
| 80/80 |
| StartTime | string | No | The time when the traffic classification rule takes effect. Specify the time in the ISO 8601 standard in the | 2022-07-14T16:41:33+0800 |
| EndTime | string | No | The time when the traffic classification rule expires. Specify the time in the ISO 8601 standard in the | 2022-09-14T16:41:33+0800 |
| Name | string | No | The name of the traffic classification rule. The name must be 2 to 100 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter. | nametest |
| DpiSignatureIds | array | No | ||
| string | No | The ID of the application. You can enter at most 100 application IDs at a time. You can call the ListDpiSignatures operation to query application IDs and information about the applications. | 1 | |
| DpiGroupIds | array | No | ||
| string | No | The ID of the application group. You can enter at most 100 application group IDs at a time. You can call the ListDpiGroups operation to query application group IDs and information about the applications. | 20 |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. |
For a list of error codes, visit the Service error codes.