全部产品
Search
文档中心

专有网络 VPC:DescribeExpressConnectTrafficQos - 查询高速通道QoS策略

更新时间:Nov 13, 2024

调用DescribeExpressConnectTrafficQos接口查询高速通道QoS策略,支持分页参数。

调试

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

授权信息

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

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

请求参数

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

QoS 策略所在的地域 ID。

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

cn-shanghai
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
02fb3da4-130e-11e9-8e44-0016e04115b
QosIdListarray

QoS 策略 ID 集合。

string

QoS 策略 ID。

qos-2giu0a6vd5x0mv****
QosNameListarray

QoS 策略名称集合。

string

QoS 策略名称。

qos-test
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

4CF20CC7-D1FC-425B-A15B-DF7C8E2131A7
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20
TotalCountinteger

返回结果总数。

10
Countstring

列表当前条目数。

1
QosListarray<object>

QoS 策略信息列表。

qosListobject

QoS 策略信息。

QosIdstring

QoS 策略 ID。

qos-pksbqfmotl5hzq****
QosNamestring

QoS 策略的名称。

长度为 0128 个字符,不能以http://https://开头。

qos-test
QosDescriptionstring

QoS 策略的描述信息。

长度为 0256 个字符,不能以http://https://开头。

qos-test
Statusstring

QoS 策略的状态。取值:

  • Normal:可用。

  • Configuring:配置中。

说明 处于配置中状态的 QoS 将会限制绝大部分的 QoS 策略、QoS 队列,QoS 规则的创建、更新和删除操作。
Normal
Progressinginteger

QoS 策略整体配置进度,取值范围为:0~100

100
AssociatedInstanceListarray<object>

关联实例列表。

associatedInstanceListobject

关联实例信息。

InstanceIdstring

关联实例的 ID。

pc-bp159zj8zujwy3p07****
InstanceTypestring

关联实例的类型。取值:PHYSICALCONNECTION 物理专线。

PHYSICALCONNECTION
InstanceStatusstring

关联实例的状态。取值:

  • Normal:可用。

  • Configuring:配置中。

  • Deleting:删除中。

Normal
InstanceProgressinginteger

关联实例的配置进度,取值范围为:0~100

100
QueueListarray<object>

QoS 队列列表。

queueListobject

QoS 队列信息。

QosIdstring

QoS 策略 ID。

qos-pksbqfmotl5hzq****
QueueIdstring

QoS 队列 ID。

qos-queue-9nyx2u7n71s2rc****
QueueTypestring

QoS 队列类型,取值:

  • High:高优先级队列。

  • Medium:普通优先级队列。

  • Default:默认优先级队列。

说明 默认优先级队列无法创建。
High
BandwidthPercentstring

QoS 队列带宽百分比。

  • 当 QoS 队列类型为 Medium 的时候,此字段必须输入,取值范围为:1~100

  • 当 QoS 队列类型为 Default 的时候,此字段为"-"。

100
QueueNamestring

QoS 队列的名称。

长度为 0128 个字符,不能以http://https://开头。

qos-queue-test
QueueDescriptionstring

QoS 队列的描述信息。

长度为 0256 个字符,不能以http://https://开头。

qos-queue-test
Statusstring

QoS 队列的状态。取值:

  • Normal:可用。

  • Configuring:配置中。

  • Deleting:删除中。

Normal

示例

正常返回示例

JSON格式

{
  "RequestId": "4CF20CC7-D1FC-425B-A15B-DF7C8E2131A7",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20,
  "TotalCount": 10,
  "Count": "1",
  "QosList": [
    {
      "QosId": "qos-pksbqfmotl5hzq****",
      "QosName": "qos-test",
      "QosDescription": "qos-test",
      "Status": "Normal",
      "Progressing": 100,
      "AssociatedInstanceList": [
        {
          "InstanceId": "pc-bp159zj8zujwy3p07****",
          "InstanceType": "PHYSICALCONNECTION",
          "InstanceStatus": "Normal",
          "InstanceProgressing": 100
        }
      ],
      "QueueList": [
        {
          "QosId": "qos-pksbqfmotl5hzq****",
          "QueueId": "qos-queue-9nyx2u7n71s2rc****",
          "QueueType": "High",
          "BandwidthPercent": "100",
          "QueueName": "qos-queue-test",
          "QueueDescription": "qos-queue-test",
          "Status": "Normal"
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.%sThe param of %s is illegal.指定的参数非法

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

变更历史

变更时间变更内容概要操作
暂无变更历史