创建API限流规则返回详细信息

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

1. 接口描述

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

创建API限流规则,并返回规则信息

默认接口请求频率限制：20次/秒。

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

接口只验签名不鉴权。

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
Result	ApiRateLimitRule	创建的规则 ID 示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 创建新 API 分组限流规则

创建新的 API 分组限流规则

输入示例

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

{
  "ApiId": "api-7h13jx9z",
  "MaxQps": 1000
}

输出示例

{
  "Response": {
    "RequestId": "ada294ab-6322-4262-982c-a8960085486b",
    "Result": {
      "ApiId": null,
      "CreatedTime": null,
      "Description": null,
      "MaxQps": null,
      "RuleContent": null,
      "RuleId": "rule-jwo9eexw",
      "RuleName": null,
      "TsfRuleId": null,
      "UpdatedTime": null,
      "UsableStatus": null
    }
  }
}