如果您需要优化和控制跨区域的网络流量,您可以调用CreateCenInterRegionTrafficQosPolicy接口创建企业版转发路由器下的跨地域流量调度策略。
接口说明
-
仅企业版转发路由器下的跨地域连接支持创建跨地域流量调度策略。
-
流量调度功能仅作用在企业版转发路由器的出方向。
例如,您创建了华东 1(杭州)与华北 1(青岛)地域的跨地域连接,您在华东 1(杭州)地域的转发路由器下配置流量调度功能后,在流量从华东 1(杭州)地域去往华北 1(青岛)地域的过程中,流量调度功能可以帮您保证各类业务的使用带宽。在流量从华北 1(青岛)地域去往华东 1(杭州)地域的过程中,流量调度功能不帮您保证业务带宽。
-
CreateCenInterRegionTrafficQosPolicy 接口属于异步接口,即系统会先返回一个流量调度策略 ID,但该流量调度策略并未创建完成,系统后台的创建任务仍在进行。您可以调用 ListCenInterRegionTrafficQosPolicies 接口查询流量调度策略的状态。
当流量调度策略处于 Creating 状态时,表示流量调度策略正在创建中,在该状态下,您只能对流量调度策略执行查询操作,不能执行其他操作。
当流量调度策略处于 Active 状态时,表示流量调度策略创建完成。
前提条件
在调用 CreateCenInterRegionTrafficQosPolicy 接口前,确保已满足以下条件:
已创建跨地域连接。具体操作,请参见 CreateTransitRouterPeerAttachment 。
已创建流量标记策略。具体操作,请参见 CreateTrafficMarkingPolicy 。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
cen:CreateCenInterRegionTrafficQosPolicy |
create |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
ClientToken |
string |
否 |
客户端 Token,用于保证请求的幂等性。 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。 |
123e4567-e89b-12d3-a456-426655**** |
DryRun |
boolean |
否 |
是否只预检此次请求。取值:
|
false |
TransitRouterId |
string |
是 |
转发路由器实例 ID。 |
tr-8vbuqeo5h5pu3m01d**** |
TransitRouterAttachmentId |
string |
是 |
跨地域连接 ID。 |
tr-attach-r6g0m3epjehw57**** |
TrafficQosPolicyName |
string |
否 |
流量调度策略的名称。 名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。 |
nametest |
TrafficQosPolicyDescription |
string |
否 |
流量调度策略的描述信息。 描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。 |
desctest |
BandwidthGuaranteeMode |
string |
否 |
带宽保障类型,可以选择按带宽绝对值或者按带宽百分比模式。取值:
|
byBandwidthPercent |
TrafficQosQueues |
array<object> |
否 |
流量调度策略包含的队列信息。 最多支持创建 3 个队列,更多队列需要用 CreateCenInterRegionTrafficQosQueue 创建。 |
|
object |
否 |
队列信息。 |
||
QosQueueName |
string |
否 |
当前队列的名称。 一个流量调度策略最多支持创建 3 个队列,每个队列可以被指定一个队列名称。 名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。 |
nametest |
RemainBandwidthPercent |
string |
否 |
当前队列可使用的跨地域带宽的百分比。 一个流量调度策略最多支持创建 10 个队列,每个队列可以被指定允许使用的跨地域带宽百分比。 例如,您输入 1,则表示符合当前队列的流量报文最多只能使用 1%的跨地域带宽。 说明
一个流量调度策略下,所有队列的跨地域带宽百分比之和不能超过 100%。 |
1 |
Bandwidth |
string |
否 |
当前队列可使用的跨地域带宽的绝对值,单位是 Mbps。 一个流量调度策略最多支持创建 10 个队列,每个队列可以被指定允许使用的跨地域带宽。 例如,您输入 1,则表示符合当前队列的流量报文最多只能使用 1Mbps 的跨地域带宽。 说明
一个流量调度策略下,所有已分配队列的跨地域带宽绝对值之和不能超过跨地域带宽的值。 |
1 |
Dscps |
array |
否 |
当前队列匹配的 DSCP 值。 一个流量调度策略最多支持创建 3 个队列,每个队列最多支持匹配 60 个 DSCP 值,DSCP 值之间使用半角逗号(,)分隔。 |
|
integer |
否 |
当前队列匹配的 DSCP 值。 一个流量调度策略最多支持创建 3 个队列,每个队列最多支持匹配 60 个 DSCP 值,DSCP 值之间使用半角逗号(,)分隔。 |
5 |
|
QosQueueDescription |
string |
否 |
当前队列的描述信息。 一个流量调度策略最多支持创建 10 个队列,每个队列可以被添加一个队列描述信息。 描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。 |
desctest |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回结果。 |
||
TrafficQosPolicyId |
string |
流量调度策略 ID。 |
qos-eczzew0v1kzrb5**** |
RequestId |
string |
请求 ID。 |
6DF9A765-BCD2-5C7E-8C32-C35C8A361A39 |
示例
正常返回示例
JSON
格式
{
"TrafficQosPolicyId": "qos-eczzew0v1kzrb5****",
"RequestId": "6DF9A765-BCD2-5C7E-8C32-C35C8A361A39"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | AssociationExist.TrafficQos | The traffic qos with the specified attachment already exists. | 该Attachment已存在流量调度策略。 |
400 | InvalidTransitRouterId.NotFound | The specified TransitRouterId is not found. | 指定的转发路由器不存在 |
400 | IllegalParam.TransitRouterAttachmentId | TransitRouterAttachmentId is illegal. | 参数中指定的TrInstance不合法。 |
400 | InvalidParamSize.TrafficQosQueues | The queue size included in the traffic QoS policy exceeds the limit. | 流量调度策略中包含的队列大小超出限制。 |
400 | IllegalParam.BandwidthGuaranteeModeMismatch | The BandwidthGuaranteeMode does not match the Bandwidth or RemainBandwidthPercent. | 带宽保障类型和带宽绝对值或百分比的类型不匹配。 |
400 | IllegalParam.AttachmentBandwidthExceed | The entered bandwidth causes the total QoS guaranteed bandwidth to exceed the cross-region bandwidth allocation value. | 输入的带宽使得QoS总保障带宽超过了跨地域带宽分配的值。 |
400 | IllegalParam.BandwidthGuaranteeMode | The input bandwidth guarantee type is not valid. | 输入的带宽保障类型不合法。 |
400 | MissingParam.RemainBandwidthPercent | RemainBandwidthPercent is missing. | 缺少保障带宽百分比。 |
400 | MissingParam.Bandwidth | The parameter Bandwidth is mandatory. | 带宽值参数是必需的。 |
400 | IllegalParam.RemainBandwidthPercent | The specified RemainBandwidthPercent is invalid. | 参数中指定的RemainBandwidthPercent不合法。 |
400 | IllegalParam.Bandwidth | Bandwidth is illegal | 跨地域连接时入参带宽值非法。 |
400 | IllegalParam.BandwidthPackageStatus | The status of the bandwidth package is incorrect. | 带宽包的状态错误。 |
400 | IncorrectStatus.TransitRouterInstance | The status of TransitRouter is incorrect. | 转发路由器状态不正确。 |
400 | IncorrectStatus.TransitRouterAttachment | TransitRouterAttachmentId status is invalid. | 当前TransitRouterAttachment的状态不支持该操作,请稍后重试。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
400 | MissingParam.TransitRouterId | The parameter TransitrouterId is mandatory. | 缺少参数TransitRouterId。 |
400 | MissingParam.TransitRouterAttachmentId | The parameter TransitRouterAttachmentId is Missing. | 缺少参数TransitRouterAttachmentId。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。