批量查询API限流规则列表

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

1. 接口描述

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

批量查询API限流规则列表

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

接口更新时间：2025-12-22 20:53:22。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeApiRateLimitRuleList
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ApiIds	否	否	Array of String	ApiId列表示例值： ["api-wox224ox"]

3. 输出参数

参数名称	类型	描述
Result	Array of RatelimitRule	网关API限流规则列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameterValue.GatewayParameterInvalid	无效请求参数:%s。
MissingParameter.GatewayParameterRequired	缺少请求参数:%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: DescribeApiRateLimitRuleList
<Common Parameters>

{
  "ApiIds": [
    "api-id"
  ]
}

输出示例

{
  "Response": {
    "Result": [
      {
        "RuleId": "rid",
        "ApiId": "aid",
        "RuleName": "name",
        "MaxQps": 1,
        "UsableStatus": "status",
        "RuleContent": "content",
        "TsfRuleId": "rid",
        "Description": "desc",
        "CreatedTime": "2025",
        "UpdatedTime": "2025"
      }
    ],
    "RequestId": "req-id"
  }
}