微服务平台 TSF 创建API限流规则返回详细信息-微服务网关相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： tsf.tencentcloudapi.com 。

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

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateApiRateLimitRuleWithDetailResp。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
ApiId	是	String	Api Id 示例值：api-7h13jx9z
MaxQps	是	Integer	qps值示例值：20
UsableStatus	否	String	开启/禁用，enabled/disabled, 不传默认开启示例值：enabled

3. 输出参数

参数名称	类型	描述
Result	ApiRateLimitRule	创建的规则 ID 注意：此字段可能返回 null，表示取不到有效值。示例值：{"ApiId":null,"CreatedTime":null,"Description":null,"MaxQps":null,"RuleContent":null,"RuleId":"rule-jwo9eexw","RuleName":null,"TsfRuleId":null,"UpdatedTime":null,"UsableStatus":null}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

创建新的 API 分组限流规则

输入示例

POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApiRateLimitRuleWithDetailResp
<公共请求参数>

{
    "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
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

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

本页目录：