文档中心 > 密钥管理系统 > API 文档 > 密钥相关接口 > 绑定密钥和云产品资源的使用关系

绑定密钥和云产品资源的使用关系

最近更新时间:2020-08-17 08:13:55

1. 接口描述

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

记录当前key被哪个云产品的那个资源所使用。如果当前key设置了自动过期,则取消该设置,确保当前key不会自动失效。如果当前关联关系已经创建,也返回成功。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:BindCloudResource。
Version String 公共参数,本接口取值:2019-01-18。
Region String 公共参数,详见产品支持的 地域列表
KeyId String cmk的ID
ProductId String 云产品的唯一性标识符
ResourceId String 资源/实例ID,由调用方根据自己的云产品特征来定义,以字符串形式做存储。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 绑定密钥和云产品资源的使用关系

绑定密钥和云产品资源的使用关系

输入示例

https://kms.tencentcloudapi.com/?Action=BindCloudResource
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b01
&ProductId=ssm
&ResourceId=resourceId
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "fe11aa29-0cc2-4204-bfea-6ebb30cc00d7"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CmkUsedByCloudProduct CMK正在被云产品使用。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.InvalidKeyId KeyId不合法。
ResourceUnavailable.CmkNotFound CMK不存在。
ResourceUnavailable.CmkStateNotSupport CMK 状态不支持该操作。
UnsupportedOperation.ServiceTemporaryUnavailable 服务暂时不可用。
目录