API 网关修改使用计划-使用计划相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（ModifyUsagePlan）用于修改使用计划的名称，描述及 QPS。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyUsagePlan。
Version	是	String	公共参数，本接口取值：2018-08-08。
Region	是	String	公共参数，详见产品支持的地域列表。
UsagePlanId	是	String	使用计划唯一 ID。示例值：usagePlan-bxtnltfd
UsagePlanName	否	String	修改后的用户自定义的使用计划名称。
UsagePlanDesc	否	String	修改后的用户自定义的使用计划描述。
MaxRequestNum	否	Integer	请求配额总数，取值范围为-1或者[1, 99999999]，默认为-1，表示不开启。
MaxRequestNumPreSec	否	Integer	每秒请求限制数，取值范围为-1或者[1, 2000]，默认-1，表示不开启。

3. 输出参数

参数名称	类型	描述
Result	UsagePlanInfo	使用计划详情。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 ModifyUsagePlan

输入示例

https://apigateway.tencentcloudapi.com/?Action=ModifyUsagePlan
&UsagePlanId=usagePlan-bxtnltfd
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "UsagePlanId": "usagePlan-bxtnltfd",
            "UsagePlanName": "xx",
            "UsagePlanDesc": null,
            "MaxRequestNumPreSec": null,
            "MaxRequestNum": null,
            "CreatedTime": "2020-02-26T14:19:52Z",
            "ModifiedTime": "2020-02-26T14:25:30Z",
            "BindSecretIdTotalCount": null,
            "BindSecretIds": null,
            "BindEnvironmentTotalCount": null,
            "BindEnvironments": null
        },
        "RequestId": "d929b56e-d7c3-4929-a103-3302fa9fee2e"
    }
}

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.OssException	oss内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。
InvalidParameter.FormatError	参数格式错误。
ResourceNotFound.InvalidUsagePlan	使用计划不存在。

修改使用计划

本页目录：