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

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

更新时间: 2023-10-12 10:47:06

创建跨地域流量调度策略。

接口说明

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

      如果您的跨地域连接使用了测试带宽,则不支持创建跨地域流量调度策略。
    
  • 流量调度功能仅作用在企业版转发路由器的出方向。

      例如,您创建了华东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:CreateCenInterRegionTrafficQosPolicyWrite
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/*

请求参数

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

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

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

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

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

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

转发路由器实例ID。

tr-8vbuqeo5h5pu3m01d****
TransitRouterAttachmentIdstring

跨地域连接ID。

tr-attach-r6g0m3epjehw57****
TrafficQosPolicyNamestring

流量调度策略的名称。

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

nametest
TrafficQosPolicyDescriptionstring

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

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

desctest
TrafficQosQueuesobject []

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

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

QosQueueNamestring

当前队列的名称。

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

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

nametest
RemainBandwidthPercentstring

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

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

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

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

当前队列匹配的DSCP值。

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

integer

当前队列匹配的DSCP值。

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

5
QosQueueDescriptionstring

当前队列的描述信息。

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

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

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不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2021-11-26新增 OpenAPI看变更集
阿里云首页 云企业网 相关技术圈