All Products
Search
Document Center

Smart Access Gateway:ModifyQosCar

Last Updated:Mar 03, 2024

Modifies a traffic throttling rule in 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:ModifyQosCarWrite
  • Qos
    acs:smartag:{#regionId}:{#accountId}:qos/{#QosId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DescriptionstringNo

The description of the traffic throttling rule.

Qostest
RegionIdstringYes

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

cn-hangzhou
QosIdstringYes

The ID of the QoS policy.

qos-awfxl1adxeqyk****
QosCarIdstringYes

The ID of the traffic throttling rule.

qoscar-n5k8g97lihlph****
PriorityintegerNo

The priority value of the traffic throttling rule. A smaller value specifies a higher priority. If multiple rules have the same priority, the rule that is applied first takes effect. Valid values: 1 to 7.

2
LimitTypestringNo

The type of the traffic throttling rule. Valid values:

  • Absolute: throttles traffic based on a specific range of bandwidth.
  • Percent: throttles traffic based on a specific range of bandwidth percentage.
Absolute
MinBandwidthAbsintegerNo

The minimum bandwidth value. The value must be an integer. Unit: Mbit/s.

This parameter is required when you set LimitType to Absolute.

2
MaxBandwidthAbsintegerNo

The maximum bandwidth value. The value must be an integer. Unit: Mbit /s.

This parameter is required when you set LimitType to Absolute.

Note The maximum bandwidth value must be greater than the minimum bandwidth value.
6
MinBandwidthPercentintegerNo

The minimum bandwidth percentage. Unit: percent (%). Valid values: 1 to 100.

This parameter is required when you set LimitType to Percent.

20
MaxBandwidthPercentintegerNo

The maximum bandwidth percentage. Unit: percent (%). Valid values: 1 to 100.

This parameter is required when you set LimitType to Percent.

Note The maximum bandwidth percentage must be greater than the minimum bandwidth percentage.
90
PercentSourceTypestringNo

The type of bandwidth when traffic is throttled based on bandwidth percentage. Valid values:

  • CcnBandwidth: Cloud Connect Network (CCN) bandwidth
  • InternetUpBandwidth: total Internet bandwidth
CcnBandwidth
NamestringNo

The name of the traffic throttling rule.

The name must be 2 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.

nametest

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.QosCarIdYou must specify QosCarId.You must specify QosCarId.
400MissParameter.QosIdYou must specify QosId.You must set the QosId parameter.
400InvalidParameter.DescriptionYou must specify Description.You must set the Description parameter.
400MissParameter.MaxBandwidthAbsYou must specify MaxBandwidthAbs.You must specify MaxBandwidthAbs.
400MissParameter.MaxBandwidthPercentYou must specify MaxBandwidthPercent.You must specify MaxBandwidthPercent.
400MissParameter.MinBandwidthAbsYou must specify MinBandwidthAbs.You must specify MinBandwidthAbs.
400MissParameter.MinBandwidthPercentYou must specify MinBandwidthPercent.You must specify MinBandwidthPercent.
400InvalidBandwidthCompareThe specified maximum bandwidth is smaller than the minimum bandwidth. Please check your input.The specified maximum bandwidth is smaller than the minimum bandwidth. Please check your input.
400MissParameter.PercentSourceTypeYou must specify PercentSourceType.You must specify PercentSourceType.
400InvalidParameter.PriorityThe specified Priority is invalid.The Priority parameter is set to an invalid value.
400InvalidParameter.PercentSourceTypeThe specified PercentSourceType is invalid.The specified PercentSourceType is invalid.
400InvalidParameter.NameThe specified Name is invalid.The Name parameter is set to an invalid value.
400InvalidParameter.DescriptionThe specified Description is invalid.The Description parameter is set to an invalid value.

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