全部产品
Search
文档中心

智能接入网关:CreateQosCar - 创建QoS的限速规则

更新时间:Mar 29, 2024

调用CreateQosCar接口创建QoS的限速规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:CreateQosCarWrite
  • Qos
    acs:smartag:{#regionId}:{#accountId}:qos/{#QosId}

请求参数

名称类型必填描述示例值
Descriptionstring

QoS 限速规则的描述信息。

Qosdesc
RegionIdstring

QoS 策略实例所在的地域 ID。

您可以调用 DescribeRegions 接口查询地域 ID。

cn-shanghai
QosIdstring

QoS 策略的实例 ID。

qos-xitd8690ucu8ro****
Priorityinteger

设置限速规则的优先级。

取值范围:1~3。数值越小,优先级越高。同优先级时先下发的规则优先生效。

2
LimitTypestring

限速类型,取值:

  • Absolute:按带宽值。

  • Percent:按百分比。

Absolute
MinBandwidthAbsinteger

最小带宽值,带宽值需要输入整数,单位:Mbps。

LimitTypeAbsolute 时必填。

2
MaxBandwidthAbsinteger

最大带宽值,带宽值需要输入整数,单位:Mbps。

LimitTypeAbsolute 时必填。

说明 输入的最大带宽值必须大于最小带宽值。
6
MinBandwidthPercentinteger

最小带宽百分比,单位:百分比(%),取值范围:1~100

LimitTypePercent 时必填。

20
MaxBandwidthPercentinteger

最大带宽百分比,单位:百分比(%),取值范围:1~100

LimitTypePercent 时必填。

说明 输入的最大带宽百分比必须大于最小带宽百分比。
90
PercentSourceTypestring

百分比限速时的带宽类型,取值:

  • CcnBandwidth:表示 CCN 带宽。

  • InternetUpBandwidth:表示 Internet 总带宽。

CcnBandwidth
Namestring

QoS 限速规则名称。

长度为 2~128,以字母或中文开头,且只包含中文、字母、数字、半角句号(.)、下划线(_)和短划线(-)。

nametest

返回参数

名称类型描述示例值
object

返回结果。

MinBandwidthAbsinteger

最小带宽值,单位:Mbps。

LimitTypeAbsolute 时必填。

2
Descriptionstring

QoS 限速规则描述。

Qosdesc
RequestIdstring

请求 ID。

AC13E8FF-4D61-40AD-868E-817F2D3AC86A
QosCarIdstring

QoS 限速规则的实例 ID。

qoscar-n5k8g97lihlph****
MaxBandwidthAbsinteger

最大带宽值,单位:Mbps。

LimitTypeAbsolute 时必填。

6
MaxBandwidthPercentinteger

最大带宽百分比,单位:百分比(%)。

90
Priorityinteger

规则的优先级。

2
QosIdstring

QoS 策略的实例 ID。

qos-xitd8690ucu8ro****
PercentSourceTypestring

按百分比限速时的带宽类型,取值:

  • CcnBandwidth:表示 CCN 带宽。

  • InternetUpBandwidth:表示 Internet 总带宽。

CcnBandwidth
MinBandwidthPercentinteger

最小带宽百分比,单位:百分比(%)。

20
LimitTypestring

限速类型,取值:

  • Absolute:按带宽值。

  • Percent:按百分比。

Percent

示例

正常返回示例

JSON格式

{
  "MinBandwidthAbs": 2,
  "Description": "Qosdesc",
  "RequestId": "AC13E8FF-4D61-40AD-868E-817F2D3AC86A",
  "QosCarId": "qoscar-n5k8g97lihlph****",
  "MaxBandwidthAbs": 6,
  "MaxBandwidthPercent": 90,
  "Priority": 2,
  "QosId": "qos-xitd8690ucu8ro****",
  "PercentSourceType": "CcnBandwidth",
  "MinBandwidthPercent": 20,
  "LimitType": "Percent"
}

错误码

HTTP status code错误码错误信息描述
400MissParameter.RegionIdYou must specify RegionId.您的输入中缺少必填参数RegionId。
400MissParameter.QosIdYou must specify QosId.您的输入中缺少必填参数QosId。
400MissParameter.LimitTypeYou must specify LimitType.您的输入中缺少必填参数"LimitType"。
400MissParameter.PriorityYou must specify Priority.您的输入中缺少必填参数"Priority"。
400InvalidParameter.LimitTypeYou must specify LimitType.您的输入中缺少必填参数"LimitType"。
400MissParameter.MaxBandwidthAbsYou must specify MaxBandwidthAbs.您的输入中缺少必填参数"MaxBandwidthAbs"。
400MissParameter.MaxBandwidthPercentYou must specify MaxBandwidthPercent.您的输入中缺少必填参数"MaxBandwidthPercent"。
400MissParameter.MinBandwidthAbsYou must specify MinBandwidthAbs.您的输入中缺少必填参数"MinBandwidthAbs"。
400MissParameter.MinBandwidthPercentYou must specify MinBandwidthPercent.您的输入中缺少必填参数"MinBandwidthPercent"。
400InvalidBandwidthCompareThe specified maximum bandwidth is smaller than the minimum bandwidth. Please check your input.您输入的参数中最大带宽值小于最小带宽值,请检查您的输入。
400MissParameter.PercentSourceTypeYou must specify PercentSourceType.您的输入中缺少必填参数"PercentSourceType"。
400InvalidId.QosThe specified QosId is invalid.您输入的参数QosId不合法。
400Invalid.QosCar.PriorityThe specified priority of QosCarId is invalid.指定的QosCar的优先级priority参数不合法。
400QosCarPerQosAmountLimitThe maximum number of QosCar in a QoS is exceeded. You can submit a ticket to increase the quota.单个QoS策略中的限速规则数量已达上限。
400InvalidParameter.PriorityThe specified Priority is invalid.您输入的参数Priority不合法。
400InvalidParameter.PercentSourceTypeThe specified PercentSourceType is invalid.您输入的参数"PercentSourceType"不合法。
400InvalidParameter.DescriptionThe specified Description is invalid.您输入的参数Description不合法。
400InvalidParameter.LimitTypeThe specified LimitType is invalid.您输入的参数"LimitType"不合法。
400InvalidParameter.NameThe specified Name is invalid.您输入的参数Name不合法。
403InternalErrorAn internal server error occurred.内部服务错误。

访问错误中心查看更多错误码。