查询API限流规则

最近更新时间: 2026-09-17 00:03:59

1. 接口描述

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

查询API限流规则

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

接口更新时间:2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeApiRateLimitRules
Version String 公共参数,本接口取值:2018-03-26
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
ApiId String Api ID
示例值:

3. 输出参数

参数名称 类型 描述
Result Array of ApiRateLimitRule 限流结果
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
FailedOperation.TsfPrivilegeError TSF权限模块异常,请联系系统管理员。。
InternalError.GatewayDbError 网关数据异常。

5. 示例

示例1 查询API限流规则

输入示例

https://tsf.api3.<no value>/?Action=DescribeApiRateLimitRules
&ApiId=api-uk1098lc1
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": [
            {
                "UpdatedTime": "xx", 
                "MaxQps": 1, 
                "Description": "xx", 
                "RuleId": "xx", 
                "ApiId": "xx", 
                "TsfRuleId": "xx", 
                "UsableStatus": "enabled", 
                "RuleName": "xx", 
                "CreatedTime": "xx", 
                "RuleContent": "xx"
            }
        ], 
        "RequestId": "xx"
    }
}