调用ListCenInterRegionTrafficQosPolicies接口查询流量调度策略的信息。
接口说明
在调用 ListCenInterRegionTrafficQosPolicies 接口过程中：
-
TransitRouterId 或 TrafficQosPolicyId 参数至少输入一个。
-
如果您未输入流量调度策略 ID（即未指定 TrafficQosPolicyId 参数的值），则接口会根据 TransitRouterId、TransitRouterAttachmentId、TrafficQosPolicyName 和 TrafficQosPolicyDescription 参数的值仅返回流量调度策略的信息，并不会查询流量调度策略下队列的信息（即响应中不包含 TrafficQosQueues 字段）。
-
如果您输入了流量调度策略 ID（即指定了 TrafficQosPolicyId 参数的值），则接口会为您返回该流量调度策略的信息以及该流量调度策略下队列的信息（即响应中包含 TrafficQosQueues 字段）。如果 TrafficQosQueues 字段为空数组，则表示当前流量调度策略下仅存在默认队列
-
调用接口时请确保输入的参数值无误。如果您输入的参数有误调用接口后仍然会返回 RequestId，但不会显示流量调度策略的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cen:ListCenInterRegionTrafficQosPolicies |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TransitRouterId |
string |
否 |
转发路由器实例 ID。 |
tr-bp1rmwxnk221e3fas**** |
| TransitRouterAttachmentId |
string |
否 |
跨地域连接 ID。 |
tr-attach-r6g0m3epjehw57**** |
| TrafficQosPolicyId |
string |
否 |
流量调度策略 ID。 |
qos-rnghap5gc8155x**** |
| TrafficQosPolicyName |
string |
否 |
流量调度策略的名称。 名称可以为空或长度为 1～128 个字符，不能以 http://或 https://开头。 |
nametest |
| TrafficQosPolicyDescription |
string |
否 |
流量调度策略的描述信息。 描述可以为空或长度为 1～256 个字符，不能以 http://或 https://开头。 |
desctest |
| MaxResults |
integer |
否 |
分批次查询时每次显示的条目数。取值范围：1~100。默认值：20。 |
20 |
| NextToken |
string |
否 |
是否拥有下一次查询的令牌（Token）。取值：
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| NextToken |
string |
是否拥有下一次查询的令牌（Token）。
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| RequestId |
string |
请求 ID。 |
113BFD47-63DF-5D9D-972C-033FB9C360CD |
| TotalCount |
integer |
列表条目数。 |
1 |
| MaxResults |
integer |
分批次查询时每次显示的条目数。 |
20 |
| TrafficQosPolicies |
array<object> |
流量调度策略列表。 |
|
|
object |
流量策略的信息。 |
||
| TrafficQosPolicyName |
string |
流量调度策略的名称。 |
nametest |
| TrafficQosPolicyStatus |
string |
流量调度策略的状态。
|
Creating |
| TrafficQosPolicyId |
string |
流量调度策略 ID。 |
qos-rnghap5gc8155x**** |
| TrafficQosPolicyDescription |
string |
流量调度策略的描述信息。 |
desctest |
| BandwidthGuaranteeMode |
string |
带宽保障类型。
|
byBandwidthPercent |
| TrafficQosQueues |
array<object> |
队列信息列表。 |
|
|
object |
队列的信息。 |
||
| QosQueueName |
string |
队列的名称。 |
namtest |
| RemainBandwidthPercent |
integer |
带宽保障类型为按百分比模式时，当前队列占用的跨地域带宽的百分比。 |
1 |
| Bandwidth |
string |
带宽保障类型为按绝对值模式时，当前队列分配的跨地域带宽的值。 |
1 |
| QosQueueId |
string |
队列 ID。 |
qos-queue-njcrmr9fiu1jii**** |
| QosQueueDescription |
string |
队列的描述信息。 |
desctest |
| Dscps |
array |
当前队列待匹配的流量报文的 DSCP 值。 |
|
|
integer |
当前队列待匹配的流量报文的 DSCP 值。 |
5 |
|
| EffectiveBandwidth |
string |
当前队列实际生效的带宽值。 |
1.35 |
| TransitRouterId |
string |
转发路由器实例 ID。 |
tr-2ze4ta4v32umj0rb*** |
| TransitRouterAttachmentId |
string |
网络实例连接 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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | MissingParam.TransitRouterIdOrTrafficQosPolicyId | Either TransitRouterId or TrafficQosPolicyId must be specified. | |
| 400 | InvalidDescription | Description is invalid. | 描述不合法。 |
| 400 | InvalidName | Name is invalid. | name不合法。 |
| 400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。