All Products
Search
Document Center

Smart Access Gateway:CreateQosPolicy

Last Updated:Mar 29, 2024

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

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

Request parameters

ParameterTypeRequiredDescriptionExample
DescriptionstringNo

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
RegionIdstringYes

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

cn-shanghai
QosIdstringYes

The ID of the QoS policy.

qos-xitd8690ucu8ro****
PriorityintegerYes

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
SourceCidrstringYes

The source CIDR block.

Specify the value of this parameter in CIDR notation. Example: 192.168.1.0/24.

10.10.10.0/24
DestCidrstringYes

The destination CIDR block.

Specify the value of this parameter in CIDR notation. Example: 192.168.10.0/24.

10.10.20.0/24
IpProtocolstringYes

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
SourcePortRangestringYes

The source port range.

Valid values: 1 to 65535 and -1.

Examples:

  • 1/200: a port range from 1 to 200
  • 80/80: port 80
  • -1/-1: all ports
80/80
DestPortRangestringYes

The destination port range.

Valid values: 1 to 65535 and -1.

Examples:

  • 1/200: a port range from 1 to 200
  • 80/80: port 80
  • -1/-1: all ports
80/80
StartTimestringNo

The time when the traffic classification rule takes effect.

Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss+0800 format. The time must be in UTC+8.

2022-07-14T16:41:33+0800
EndTimestringNo

The time when the traffic classification rule expires.

Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss+0800 format. The time must be in UTC+8.

2022-09-14T16:41:33+0800
NamestringNo

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
DpiSignatureIdsarrayNo
stringNo

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
DpiGroupIdsarrayNo
stringNo

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

ParameterTypeDescriptionExample
object
Descriptionstring

The description of the traffic classification rule.

desctest
EndTimestring

The time when the traffic classification rule expires.

2022-09-14T16:41:33+0800
RequestIdstring

The ID of the request.

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

The ID of the traffic classification rule.

qospy-xhwhyuo43l********
SourcePortRangestring

The source port range.

80/80
SourceCidrstring

The source CIDR block.

10.10.10.0/24
Priorityinteger

The priority of the traffic throttling policy to which the traffic classification rule belongs.

3
StartTimestring

The time when the traffic classification rule takes effect.

2022-07-14T16:41:33+0800
DestPortRangestring

The destination port range.

80/80
DpiGroupIdsarray

The ID of the application group.

string
20
Namestring

The name of the traffic classification rule.

nametest
DestCidrstring

The destination CIDR block.

10.10.10.0/24
DpiSignatureIdsarray

The IDs of applications.

string
1
QosIdstring

The ID of the QoS policy.

qos-xitd8690ucu8ro****
IpProtocolstring

The protocol that applies to the traffic classification rule.

TCP

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 codeError codeError messageDescription
400NotSupportedProtocolThe specified protocol of the QoS policy is not supported.The specified protocol of the QoS policy is not supported.
400InvalidId.QosThe specified QosId is invalid.The QosId parameter is set to an invalid value.
400QosPolicyPerQosAmountLimitThe 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.
400MissParameter.RegionIdYou must specify RegionId.You must set the RegionId parameter.
400MissParameter.QosIdYou must specify QosId.You must set the QosId parameter.
400MissParameter.QosPolicyIdYou must specify QosPolicyId.You must set the QosPolicyId parameter.
400InvalidParameter.PriorityThe specified Priority is invalid.The Priority parameter is set to an invalid value.
400MissParameter.SourceCidrYou must specify SourceCidr.You must set the SourceCidr parameter.
400MissParameter.SourcePortRangeYou must specify SourcePortRange.You must set the SourcePortRange parameter.
400MissParameter.DestCidrYou must specify DestCidr.You must set the DestCidr parameter.
400MissParameter.DestPortRangeYou must specify DestPortRange.You must set the DestPortRange parameter.
400MissParameter.IpProtocolYou must specify IpProtocol.You must set the IpProtocol parameter.
400InvalidParameter.DescriptionThe specified Description is invalid.The Description parameter is set to an invalid value.
400InvalidParameter.DestCidrThe specified DestCidr is invalid.The DestCidr parameter is set to an invalid value.
400InvalidParameter.DestPortRangeThe specified DestPortRange is invalid.The DestPortRange parameter is set to an invalid value.
400InvalidParameter.SourceCidrThe specified SourceCidr is invalid.The SourceCidr parameter is set to an invalid value.
400InvalidParameter.SourcePortRangeThe specified SourcePortRange is invalid.The SourcePortRange parameter is set to an invalid value.
400InvalidParameter.StartTimeThe specified StartTime is invalid.The StartTime parameter is set to an invalid value.
400InvalidParameter.EndTimeThe specified EndTime is invalid.The EndTime parameter is set to an invalid value.
400InvalidTimeRangeCompareThe 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.
400InvalidParameter.NameThe specified Name is invalid.The Name parameter is set to an invalid value.
403InternalErrorAn internal server error occurred.An internal server error occurred.
403InvalidPortRangeThe specified port range is invalid.The specified port range is invalid.

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