使用计划绑定密钥

最近更新时间:2024-03-12 01:08:43

我的收藏

1. 接口描述

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

本接口(BindSecretIds)用于为使用计划绑定密钥。
将密钥绑定到某个使用计划,并将此使用计划绑定到某个服务发布的环境上,调用者方可使用此密钥调用这个服务中的 API,可使用本接口为使用计划绑定密钥。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:BindSecretIds。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
UsagePlanId String 待绑定的使用计划唯一 ID。
示例值:usagePlan-quqxvett
AccessKeyIds.N Array of String 待绑定的密钥 ID 数组。
示例值:["AKIDmyE2z0gvi2p6***\n"]

3. 输出参数

参数名称 类型 描述
Result Boolean 绑定操作是否成功。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 使用计划绑定密钥

使用计划绑定密钥

输入示例

https://apigateway.tencentcloudapi.com/?Action=BindSecretIds
&UsagePlanId=usagePlan-quqxvett
&AccessKeyIds.0=AKIDmyE2z0gvi2p6***************
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": true,
        "RequestId": "fcc3e46c-931d-4c58-88e9-f3cfc2251769"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.OssException oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InvalidParameterValue.InvalidAccessKeyIds 密钥错误。
InvalidParameterValue.InvalidRegion 地域错误。
LimitExceeded.AccessKeyCountInUsagePlanLimitExceeded 访问密钥数量超出限制。
ResourceNotFound.InvalidAccessKeyId 密钥不存在。
ResourceNotFound.InvalidUsagePlan 使用计划不存在。
UnsupportedOperation.AlreadyBindUsagePlan 密钥已绑定使用计划。
UnsupportedOperation.InvalidStatus 当前密钥状态不支持此操作。
UnsupportedOperation.UnsupportedBindApiKey 密钥已绑定使用计划。