文档

CreateTrafficControl - 创建流控策略

更新时间:

创建用户自定义的流控策略。

接口说明

  • 此功能面向开放 API 的用户
  • 策略创建后,未绑定 API 前是无意义的,绑定 API 后,对绑定的 API 即时生效
  • 该接口调用的 QPS 限制为:单用户 QPS 不超过 50

调试

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

授权信息

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

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

请求参数

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

流控策略名称,支持大小写英文字母,中文,数字,下划线,长度 4~50,且不能以下划线开头。

流控测试
TrafficControlUnitstring

流控策略单位,可选值:

  • SECOND:秒
  • MINUTE:分钟
  • HOUR:小时
  • DAY:天
MINUTE
ApiDefaultinteger

每个 API 默认流控值

10000
UserDefaultinteger

每个用户默认的流控值

10000
AppDefaultinteger

每个 app 默认的流控值

10000
Descriptionstring

流控描述信息

流控测试描述

返回参数

名称类型描述示例值
object
TrafficControlIdstring

流控策略唯一 ID

tf123456
RequestIdstring

本次请求编号

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

示例

正常返回示例

JSON格式

{
  "TrafficControlId": "tf123456",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004"
}

JSON格式

{
  "TrafficControlId": "tf123456",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)