全部产品
Search

搜索本产品

    云企业网：ListCenInterRegionTrafficQosPolicies - 查询流量调度策略的信息

    文档中心

    云企业网：ListCenInterRegionTrafficQosPolicies - 查询流量调度策略的信息

    更新时间：Oct 22, 2024

    调用ListCenInterRegionTrafficQosPolicies接口查询流量调度策略的信息。

    接口说明

    在调用 ListCenInterRegionTrafficQosPolicies 接口过程中：

    • TransitRouterId 或 TrafficQosPolicyId 参数至少输入一个。

    • 如果您未输入流量调度策略 ID（即未指定 TrafficQosPolicyId 参数的值），则接口会根据 TransitRouterId、TransitRouterAttachmentId、TrafficQosPolicyName 和 TrafficQosPolicyDescription 参数的值仅返回流量调度策略的信息，并不会查询流量调度策略下队列的信息（即响应中不包含 TrafficQosQueues 字段）。

    • 如果您输入了流量调度策略 ID（即指定了 TrafficQosPolicyId 参数的值），则接口会为您返回该流量调度策略的信息以及该流量调度策略下队列的信息（即响应中包含 TrafficQosQueues 字段）。如果 TrafficQosQueues 字段为空数组，则表示当前流量调度策略下仅存在默认队列

    • 调用接口时请确保输入的参数值无误。如果您输入的参数有误调用接口后仍然会返回 RequestId，但不会显示流量调度策略的信息。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    TransitRouterIdstring否

    转发路由器实例 ID。

    		tr-bp1rmwxnk221e3fas****
    TransitRouterAttachmentIdstring否

    跨地域连接 ID。

    		tr-attach-r6g0m3epjehw57****
    TrafficQosPolicyIdstring否

    流量调度策略 ID。

    		qos-rnghap5gc8155x****
    TrafficQosPolicyNamestring否

    流量调度策略的名称。

    名称可以为空或长度为 1～128 个字符，不能以 http://或 https://开头。

    		nametest
    TrafficQosPolicyDescriptionstring否

    流量调度策略的描述信息。

    描述可以为空或长度为 1～256 个字符，不能以 http://或 https://开头。

    		desctest
    MaxResultsinteger否

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

    		20
    NextTokenstring否

    是否拥有下一次查询的令牌（Token）。取值：

    • 第一次查询和没有下一次查询时，均无需填写。
    • 如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。
    		FFmyTO70tTpLG6I3FmYAXGKPd****

    返回参数

    名称类型描述示例值
    object

    返回结果。

    NextTokenstring

    是否拥有下一次查询的令牌（Token）。

    • 如果 NextToken 为空表示没有下一次查询。
    • 如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。
    		FFmyTO70tTpLG6I3FmYAXGKPd****
    RequestIdstring

    请求 ID。

    		113BFD47-63DF-5D9D-972C-033FB9C360CD
    TotalCountinteger

    列表条目数。

    		1
    MaxResultsinteger

    分批次查询时每次显示的条目数。

    		20
    TrafficQosPoliciesarray<object>

    流量调度策略列表。

    TrafficQosPolicyobject

    流量策略的信息。

    TrafficQosPolicyNamestring

    流量调度策略的名称。

    		nametest
    TrafficQosPolicyStatusstring

    流量调度策略的状态。

    • Creating：创建中。
    • Active：可用。
    • Modifying：修改中。
    • Deleting：删除中。
    		Creating
    TrafficQosPolicyIdstring

    流量调度策略 ID。

    		qos-rnghap5gc8155x****
    TrafficQosPolicyDescriptionstring

    流量调度策略的描述信息。

    		desctest
    BandwidthGuaranteeModestring

    带宽保障类型。

    • byBandwidth：按带宽绝对值模式配置 QoS 队列。
    • byBandwidthPercent：按带宽百分比模式配置 QoS 队列。
    		byBandwidthPercent
    TrafficQosQueuesarray<object>

    队列信息列表。

    TrafficQosQueueobject

    队列的信息。

    QosQueueNamestring

    队列的名称。

    		namtest
    RemainBandwidthPercentinteger

    带宽保障类型为按百分比模式时，当前队列占用的跨地域带宽的百分比。

    		1
    Bandwidthstring

    带宽保障类型为按绝对值模式时，当前队列分配的跨地域带宽的值。

    		1
    QosQueueIdstring

    队列 ID。

    		qos-queue-njcrmr9fiu1jii****
    QosQueueDescriptionstring

    队列的描述信息。

    		desctest
    Dscpsarray

    当前队列待匹配的流量报文的 DSCP 值。

    Dscpinteger

    当前队列待匹配的流量报文的 DSCP 值。

    		5
    EffectiveBandwidthstring

    当前队列实际生效的带宽值。

    		1.35
    TransitRouterIdstring

    转发路由器实例 ID。

    		tr-2ze4ta4v32umj0rb***
    TransitRouterAttachmentIdstring

    网络实例连接 ID。

    		tr-attach-q7ct7c06jpw***

    示例

    正常返回示例

    JSON格式

    {
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "113BFD47-63DF-5D9D-972C-033FB9C360CD",
  "TotalCount": 1,
  "MaxResults": 20,
  "TrafficQosPolicies": [
    {
      "TrafficQosPolicyName": "nametest",
      "TrafficQosPolicyStatus": "Creating",
      "TrafficQosPolicyId": "qos-rnghap5gc8155x****",
      "TrafficQosPolicyDescription": "desctest",
      "BandwidthGuaranteeMode": "byBandwidthPercent",
      "TrafficQosQueues": [
        {
          "QosQueueName": "namtest",
          "RemainBandwidthPercent": 1,
          "Bandwidth": "1",
          "QosQueueId": "qos-queue-njcrmr9fiu1jii****",
          "QosQueueDescription": "desctest",
          "Dscps": [
            5
          ],
          "EffectiveBandwidth": "1.35"
        }
      ],
      "TransitRouterId": "tr-2ze4ta4v32umj0rb***",
      "TransitRouterAttachmentId": "tr-attach-q7ct7c06jpw***"
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    400MissingParam.TransitRouterIdOrTrafficQosPolicyIdEither TransitRouterId or TrafficQosPolicyId must be specified. -
    400InvalidDescriptionDescription is invalid.描述不合法。
    400InvalidNameName is invalid.name不合法。
    400InvalidParameterInvalid parameter.参数不合法。
    400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

    变更历史

    变更时间变更内容概要操作
    2024-08-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-12-13OpenAPI 错误码发生变更查看变更详情
    2021-11-26新增 OpenAPI查看变更详情