创建API限流规则

最近更新时间: 2026-10-11 00:12:04

1. 接口描述

接口请求域名: tsf.api3.fincloud.tencent.com。

创建API限流规则

默认接口请求频率限制:10000次/秒。

接口更新时间:2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:CreateApiRateLimitRule
Version 是 否 String 公共参数,本接口取值:2018-03-26
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
ApiId 是 否 String Api Id
示例值:
MaxQps 是 否 Uint64 qps值
示例值:
UsableStatus 否 否 String 开启/禁用,enabled/disabled, 不传默认开启
示例值:

3. 输出参数

参数名称 类型 描述
Result Bool 是否成功
示例值:
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。

错误码 描述
UnauthorizedOperation.LicenseUnauthorized 您所购买的服务不支持该操作。
InvalidParameterValue.GatewayParameterInvalid 无效请求参数:%s。
InternalError.GatewayConsistencyError 数据一致性异常:%s。
InternalError.GatewayDbError 网关数据异常。

5. 示例

示例1 创建API限流规则

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: CreateApiRateLimitRule
<Common Parameters>

{
  "ApiId": "api-8c7538te",
  "UsableStatus": "enabled",
  "MaxQps": 10000
}

输出示例

{
  "Response": {
    "RequestId": "af8bda56-e2f3-440f-a05c-25d63bdc397e",
    "Result": true
  }
}