CreateUsagePlan
最近更新时间: 2025-10-20 17:05:59
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
本接口（CreateUsagePlan）用于创建使用计划。 用户在使用 API 网关时，需要创建使用计划并将其绑定到服务的环境中使用。
默认接口请求频率限制：20次/秒。
接口更新时间：2020-11-24 15:14:41。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateUsagePlan |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| UsagePlanName | 是 | 否 | String | 用户自定义的使用计划名称。 |
| UsagePlanDesc | 否 | 否 | String | 用户自定义的使用计划描述。 |
| MaxRequestNum | 否 | 否 | Int64 | 请求配额总数，取值范围为-1或者[1, 99999999]，默认为-1，表示不开启。 |
| MaxRequestNumPreSec | 否 | 否 | Int64 | 每秒请求限制数，取值范围为-1或者[1, 2000]，默认-1，表示不开启。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | UsagePlanInfo | 使用计划详情。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.FormatError | 参数格式错误。 |
| LimitExceeded.UsagePlanLimitExceeded | 使用计划数量超出限制。 |
| InvalidParameterValue.InvalidRegion | 地域错误。 |