文档

DescribeQosCars - 查询QoS的限速规则

更新时间:

调用DescribeQosCars接口查询QoS策略实例的限速规则信息。

调试

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

授权信息

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

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

请求参数

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

QoS 策略实例所属地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai
QosIdstring

QoS 策略实例 ID。

qos-awfxl1adxeqyk****
QosCarIdstring

QoS 策略实例的限速规则 ID。

qoscar-n5k8g97lihlph****
Orderstring

限速规则的排序方式。取值:

  • asc(默认值):升序。
  • desc:降序。

默认按照限速规则的优先级升序排列。

asc
Descriptionstring

限速规则的描述信息。

testdesc
PageSizeinteger

分页查询时每页显示的最大条目数。取值范围:1~50。默认值为 10

10
PageNumberinteger

查询页码。默认值为 1

1

返回参数

名称类型描述示例值
object

限速规则信息。

TotalCountinteger

总条目数。

10
QosCarsobject []

限速规则信息列表。

MaxBandwidthAbsinteger

最大带宽。单位:Mbps

6
PercentSourceTypestring

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

  • CcnBandwidth:云连接网带宽。

  • InternetUpBandwidth:公网上行带宽。

CcnBandwidth
MinBandwidthAbsinteger

最小带宽。单位:Mbps

2
MaxBandwidthPercentinteger

最大带宽百分比。

90
Descriptionstring

限速规则的描述信息。

des
QosIdstring

QoS 策略实例 ID。

qos-awfxl1adxeqyk****
LimitTypestring

限速类型:

  • Absolute:按带宽值。

  • Percent:按百分比。

Absolute
Priorityinteger

限速规则优先级。

3
Namestring

限速规则的名称。

name
MinBandwidthPercentinteger

最小带宽百分比。

20
QosCarIdstring

限速规则 ID。

qos-awfxl1adxeqyk****
PageSizeinteger

分页查询时,每页显示的最大条目数。

10
RequestIdstring

请求 ID。

B7B758A9-009E-4C9D-9618-714EAE8BA5E9
PageNumberinteger

查询页码。

1

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "QosCars": {
    "QosCar": [
      {
        "MaxBandwidthAbs": 6,
        "PercentSourceType": "CcnBandwidth",
        "MinBandwidthAbs": 2,
        "MaxBandwidthPercent": 90,
        "Description": "des",
        "QosId": "qos-awfxl1adxeqyk****",
        "LimitType": " Absolute",
        "Priority": 3,
        "Name": "name",
        "MinBandwidthPercent": 20,
        "QosCarId": "qos-awfxl1adxeqyk****"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "B7B758A9-009E-4C9D-9618-714EAE8BA5E9",
  "PageNumber": 1
}

错误码

HTTP status code错误码错误信息描述
400InvalidId.QosThe specified QosId is invalid.您输入的参数QosId不合法。
403MissingParameterThe input parameter is missing, please check your input.输入参数缺失,请检查您的输入。
403InvalidParameterThe specified parameter is invalid.非法参数。
403InternalErrorAn internal server error occurred.内部服务错误。

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