首页 云企业网 开发参考 API参考 API目录 流量调度 流量调度策略 CreateCenInterRegionTrafficQosPolicy - 创建跨地域流量调度策略

CreateCenInterRegionTrafficQosPolicy - 创建跨地域流量调度策略

更新时间: 2024-11-22 10:31:44

如果您需要优化和控制跨区域的网络流量,您可以调用CreateCenInterRegionTrafficQosPolicy接口创建企业版转发路由器下的跨地域流量调度策略。

接口说明

  • 仅企业版转发路由器下的跨地域连接支持创建跨地域流量调度策略。

  • 流量调度功能仅作用在企业版转发路由器的出方向。

    例如,您创建了华东 1(杭州)与华北 1(青岛)地域的跨地域连接,您在华东 1(杭州)地域的转发路由器下配置流量调度功能后,在流量从华东 1(杭州)地域去往华北 1(青岛)地域的过程中,流量调度功能可以帮您保证各类业务的使用带宽。在流量从华北 1(青岛)地域去往华东 1(杭州)地域的过程中,流量调度功能不帮您保证业务带宽。

  • CreateCenInterRegionTrafficQosPolicy 接口属于异步接口,即系统会先返回一个流量调度策略 ID,但该流量调度策略并未创建完成,系统后台的创建任务仍在进行。您可以调用 ListCenInterRegionTrafficQosPolicies 接口查询流量调度策略的状态。

    • 当流量调度策略处于 Creating 状态时,表示流量调度策略正在创建中,在该状态下,您只能对流量调度策略执行查询操作,不能执行其他操作。
    • 当流量调度策略处于 Active 状态时,表示流量调度策略创建完成。

前提条件

在调用 CreateCenInterRegionTrafficQosPolicy 接口前,确保已满足以下条件:

调试

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

授权信息

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

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

请求参数

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

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

由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。

123e4567-e89b-12d3-a456-426655****
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建流量调度策略。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接创建流量调度策略。
false
TransitRouterIdstring

转发路由器实例 ID。

tr-8vbuqeo5h5pu3m01d****
TransitRouterAttachmentIdstring

跨地域连接 ID。

tr-attach-r6g0m3epjehw57****
TrafficQosPolicyNamestring

流量调度策略的名称。

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

nametest
TrafficQosPolicyDescriptionstring

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

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

desctest
BandwidthGuaranteeModestring

带宽保障类型,可以选择按带宽绝对值或者按带宽百分比模式。取值:

  • byBandwidth:按带宽绝对值模式配置 QoS 队列。

  • byBandwidthPercent(默认值):按带宽百分比模式配置 QoS 队列。

byBandwidthPercent
TrafficQosQueuesarray<object>

流量调度策略包含的队列信息。

最多支持创建 3 个队列,更多队列需要用 CreateCenInterRegionTrafficQosQueue 创建。

object

队列信息。

QosQueueNamestring

当前队列的名称。

一个流量调度策略最多支持创建 3 个队列,每个队列可以被指定一个队列名称。

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

nametest
RemainBandwidthPercentstring

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

一个流量调度策略最多支持创建 10 个队列,每个队列可以被指定允许使用的跨地域带宽百分比。

例如,您输入 1,则表示符合当前队列的流量报文最多只能使用 1%的跨地域带宽。

说明 一个流量调度策略下,所有队列的跨地域带宽百分比之和不能超过 100%。
1
Bandwidthstring

当前队列可使用的跨地域带宽的绝对值,单位是 Mbps。

一个流量调度策略最多支持创建 10 个队列,每个队列可以被指定允许使用的跨地域带宽。

例如,您输入 1,则表示符合当前队列的流量报文最多只能使用 1Mbps 的跨地域带宽。

说明 一个流量调度策略下,所有已分配队列的跨地域带宽绝对值之和不能超过跨地域带宽的值。
1
Dscpsarray

当前队列匹配的 DSCP 值。

一个流量调度策略最多支持创建 3 个队列,每个队列最多支持匹配 60 个 DSCP 值,DSCP 值之间使用半角逗号(,)分隔。

integer

当前队列匹配的 DSCP 值。

一个流量调度策略最多支持创建 3 个队列,每个队列最多支持匹配 60 个 DSCP 值,DSCP 值之间使用半角逗号(,)分隔。

5
QosQueueDescriptionstring

当前队列的描述信息。

一个流量调度策略最多支持创建 10 个队列,每个队列可以被添加一个队列描述信息。

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

desctest

返回参数

名称类型描述示例值
object

返回结果。

TrafficQosPolicyIdstring

流量调度策略 ID。

qos-eczzew0v1kzrb5****
RequestIdstring

请求 ID。

6DF9A765-BCD2-5C7E-8C32-C35C8A361A39

示例

正常返回示例

JSON格式

{
  "TrafficQosPolicyId": "qos-eczzew0v1kzrb5****",
  "RequestId": "6DF9A765-BCD2-5C7E-8C32-C35C8A361A39"
}

错误码

HTTP status code错误码错误信息描述
400AssociationExist.TrafficQosThe traffic qos with the specified attachment already exists.该Attachment已存在流量调度策略。
400InvalidTransitRouterId.NotFoundThe specified TransitRouterId is not found.指定的转发路由器不存在
400IllegalParam.TransitRouterAttachmentIdTransitRouterAttachmentId is illegal.参数中指定的TrInstance不合法。
400InvalidParamSize.TrafficQosQueuesThe queue size included in the traffic QoS policy exceeds the limit.流量调度策略中包含的队列大小超出限制。
400IllegalParam.BandwidthGuaranteeModeMismatchThe BandwidthGuaranteeMode does not match the Bandwidth or RemainBandwidthPercent.带宽保障类型和带宽绝对值或百分比的类型不匹配。
400IllegalParam.AttachmentBandwidthExceedThe entered bandwidth causes the total QoS guaranteed bandwidth to exceed the cross-region bandwidth allocation value.输入的带宽使得QoS总保障带宽超过了跨地域带宽分配的值。
400IllegalParam.BandwidthGuaranteeModeThe input bandwidth guarantee type is not valid.输入的带宽保障类型不合法。
400MissingParam.RemainBandwidthPercentRemainBandwidthPercent is missing.缺少保障带宽百分比。
400MissingParam.BandwidthThe parameter Bandwidth is mandatory.带宽值参数是必需的。
400IllegalParam.RemainBandwidthPercentThe specified RemainBandwidthPercent is invalid.参数中指定的RemainBandwidthPercent不合法。
400IllegalParam.BandwidthBandwidth is illegal跨地域连接时入参带宽值非法。
400IllegalParam.BandwidthPackageStatusThe status of the bandwidth package is incorrect.带宽包的状态错误。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2024-08-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-08-16OpenAPI 错误码发生变更查看变更详情
2024-07-10OpenAPI 错误码发生变更查看变更详情
2021-11-26新增 OpenAPI查看变更详情
上一篇: CreateCenInterRegionTrafficQosQueue - 创建流量调度策略下队列的配置 下一篇: DeleteCenInterRegionTrafficQosQueue - 删除流量调度策略下的队列
阿里云首页 云企业网 相关技术圈