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

使用说明

在调用ListCenInterRegionTrafficQosPolicies接口过程中:

  • 如果您未输入流量调度策略ID(即未指定TrafficQosPolicyId参数的值),则接口会根据TransitRouterIdTransitRouterAttachmentIdTrafficQosPolicyNameTrafficQosPolicyDescription参数的值仅返回流量调度策略的信息,并不会查询流量调度策略下队列的信息(即响应中不包含TrafficQosQueues字段)。
  • 如果您输入了流量调度策略ID(即指定了TrafficQosPolicyId参数的值),则接口会为您返回该流量调度策略的信息以及该流量调度策略下队列的信息(即响应中包含TrafficQosQueues字段)。

    如果TrafficQosQueues字段为空数组,则表示当前流量调度策略下仅存在默认队列。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListCenInterRegionTrafficQosPolicies

系统规定参数。取值:ListCenInterRegionTrafficQosPolicies

TransitRouterId String tr-bp1rmwxnk221e3fas****

转发路由器实例ID。

TransitRouterAttachmentId String tr-attach-r6g0m3epjehw57****

跨地域连接ID。

TrafficQosPolicyId String qos-rnghap5gc8155x****

流量调度策略ID。

TrafficQosPolicyName String nametest

流量调度策略的名称。

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、短划线(-)和下划线(_)。

TrafficQosPolicyDescription String desctest

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

描述长度为2~128个字符,以大小写字母或中文开头,可包含数字、短划线(-)和下划线(_)。

MaxResults Integer 20

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

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

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

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

返回数据

名称 类型 示例值 描述
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

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

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String 113BFD47-63DF-5D9D-972C-033FB9C360CD

请求ID。

TotalCount Integer 1

列表条目数。

MaxResults Integer 20

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

TrafficQosPolicies Array of TrafficQosPolicy

流量调度策略列表。

TrafficQosPolicyName String nametest

流量调度策略的名称。

TrafficQosPolicyStatus String Creating

流量调度策略的状态。

  • Creating:创建中。
  • Active:可用。
  • Modifying:修改中。
  • Deleting:删除中。
  • Deleted:已删除。
TrafficQosPolicyId String qos-rnghap5gc8155x****

流量调度策略ID。

TrafficQosPolicyDescription String desctest

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

TrafficQosQueues Array of TrafficQosQueue

队列信息列表。

QosQueueName String namtest

队列的名称。

RemainBandwidthPercent Integer 1

当前队列占用的跨地域带宽的百分比。

QosQueueId String qos-queue-njcrmr9fiu1jii****

队列ID。

QosQueueDescription String desctest

队列的描述信息。

Dscps Array of Integer 5

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListCenInterRegionTrafficQosPolicies
&TransitRouterId=tr-bp1rmwxnk221e3fas****
&TransitRouterAttachmentId=tr-attach-r6g0m3epjehw57****
&TrafficQosPolicyId=qos-rnghap5gc8155x****
&TrafficQosPolicyName=nametest
&TrafficQosPolicyDescription=desctest
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListCenInterRegionTrafficQosPoliciesResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>113BFD47-63DF-5D9D-972C-033FB9C360CD</RequestId>
    <TotalCount>1</TotalCount>
    <MaxResults>20</MaxResults>
    <TrafficQosPolicies>
        <TrafficQosPolicyName>nametest</TrafficQosPolicyName>
        <TrafficQosPolicyStatus>Creating</TrafficQosPolicyStatus>
        <TrafficQosPolicyId>qos-rnghap5gc8155x****</TrafficQosPolicyId>
        <TrafficQosPolicyDescription>desctest</TrafficQosPolicyDescription>
        <TrafficQosQueues>
            <QosQueueName>namtest</QosQueueName>
            <RemainBandwidthPercent>1</RemainBandwidthPercent>
            <QosQueueId>qos-queue-njcrmr9fiu1jii****</QosQueueId>
            <QosQueueDescription>desctest</QosQueueDescription>
            <Dscps>5</Dscps>
        </TrafficQosQueues>
    </TrafficQosPolicies>
</ListCenInterRegionTrafficQosPoliciesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "113BFD47-63DF-5D9D-972C-033FB9C360CD",
  "TotalCount" : 1,
  "MaxResults" : 20,
  "TrafficQosPolicies" : [ {
    "TrafficQosPolicyName" : "nametest",
    "TrafficQosPolicyStatus" : "Creating",
    "TrafficQosPolicyId" : "qos-rnghap5gc8155x****",
    "TrafficQosPolicyDescription" : "desctest",
    "TrafficQosQueues" : [ {
      "QosQueueName" : "namtest",
      "RemainBandwidthPercent" : 1,
      "QosQueueId" : "qos-queue-njcrmr9fiu1jii****",
      "QosQueueDescription" : "desctest",
      "Dscps" : [ 5 ]
    } ]
  } ]
}

错误码

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