All Products
Search

This Product

    Smart Access Gateway:ModifyQosPolicy

    Document Center

    Smart Access Gateway:ModifyQosPolicy

    Last Updated:Mar 29, 2024

    Modifies a traffic classification rule of a quality of service (QoS) policy.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    		cn-shanghai
    QosIdstringYes

    The ID of the QoS policy.

    		qos-xitd8690ucu8ro****
    QosPolicyIdstringYes

    The ID of the traffic classification rule.

    		qospy-427m9fo6wkh****
    PriorityintegerNo

    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
    SourceCidrstringNo

    The range of the source IP addresses.

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

    		10.10.10.0/24
    DestCidrstringNo

    The range of the destination IP addresses.

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

    		10.10.20.0/24
    IpProtocolstringNo

    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
    SourcePortRangestringNo

    The range of source ports.

    Valid values: 1 to 65535 and -1.

    Set this parameter in one of the following formats:

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

    The range of destination ports.

    Valid values: 1 to 65535 and -1.

    Set this parameter in one of the following formats:

    • 1/200: port 1 to port 200
    • 80/80: port 80
    • -1/-1: all ports
    		300/400
    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.

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

    The time when the traffic classification rule becomes invalid.

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

    		2019-09-14T16:41:33+0800
    DescriptionstringNo

    The description of the traffic classification rule.

    The description must be 1 to 512 characters in length, and can contain digits, underscores (_), and hyphens (-). It must start with a letter.

    		desctest
    NamestringNo

    The name of the traffic classification rule.

    The name must be 2 to 100 characters in length, and can contain 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
    RequestIdstring

    The ID of the request.

    		551CD836-9E46-4F2C-A167-B4363180A647

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "551CD836-9E46-4F2C-A167-B4363180A647"
}

    Error codes

    HTTP status codeError codeError messageDescription
    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.DescriptionThe specified Description is invalid.The Description parameter is set to an invalid value.
    400InvalidParameter.PriorityThe specified Priority is invalid.The Priority parameter is set to an invalid value.
    400InvalidParameter.SourcePortRangeThe specified SourcePortRange is invalid.The SourcePortRange 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.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.
    400InvalidId.QOSPYThe specified QosPolicyId is invalid.The specified QosPolicyId is invalid.
    400InvalidId.QosThe specified QosId is invalid.The QosId parameter is set to an invalid value.
    400NotSupportedProtocolThe specified protocol of the QoS policy is not supported.The specified protocol of the QoS policy is not supported.
    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.