说明:
1. 接口描述
本接口 (AssociateInstancesKeyPairs) 用于将密钥绑定到实例上。
接口请求域名：cvm.api.qcloud.com
只支持
STOPPED状态的Linux操作系统的实例。将密钥的公钥写入到实例的
SSH配置当中，用户就可以通过该密钥的私钥来登录实例。如果实例原来绑定过密钥，那么原来的密钥将失效。
如果实例原来是通过密码登录，绑定密钥后无法使用密码登录。
支持批量操作。每次请求批量实例的上限为100。如果批量实例存在不允许操作的实例，操作会以特定错误码返回。
2. 输入参数
参数名称 | 类型 | 是否必选 | 描述 |
Version | String | 是 | 表示 API 版本号，主要用于标识请求的不同 API 版本。 本接口第一版本可传：2017-03-12。 |
InstanceIds.N | Array of Strings | 是 | 一个或多个待操作的实例 ID，每次请求批量实例的上限为100。 可以通过以下方式获取可用的实例 ID： 通过登录 控制台 查询实例ID。 通过调用接口 DescribeInstances，取返回信息中的 InstanceId获取实例 ID。 |
KeyIds.N | Array of Strings | 是 | 一个或多个待操作的密钥对 ID，每次请求批量密钥对的上限为100。密钥对 ID 形如： skey-11112222。可以通过以下方式获取可用的密钥ID： 通过登录 控制台 查询密钥 ID。 通过调用接口 DescribeKeyPairs，取返回信息中的 KeyId获取密钥对 ID。 |
ForceStop | Boolean | 否 | 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机，然后再重置用户密码。取值范围： TRUE：表示在正常关机失败后进行强制关机。 FALSE：表示在正常关机失败后不进行强制关机。 默认取值：FALSE。 |
3. 输出参数
参数名称 | 类型 | 描述 |
RequestId | String | 唯一请求 ID。每次请求都会返回 RequestId。当用户调用接口失败找后台研发人员处理时需提供该RequestId。 |
4. 错误码
错误码 | 描述 |
MissingParameter | 参数缺失。请求没有带必选参数。 |
InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |
InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
InvalidInstanceId.NotFound | 无效实例 ID。指定的实例 ID 不存在。 |
InvalidInstanceId.Malformed | 无效实例 ID。指定的实例 ID 格式错误。例如 ID 长度错误 ins-1122。 |
InvalidInstance.NotSupported | 实例不支持该操作。 |
InvalidKeyPairId.Malformed | 无效密钥对 ID。指定的密钥对 ID 格式错误。例如 ID 长度错误 skey-1122。 |
InvalidKeyPairId.NotFound | 无效密钥对 ID。指定的密钥对 ID 不存在。 |
InternalServerError | 操作内部错误。 |
5. 示例
输入
https://cvm.api.qcloud.com/v2/index.php?Action=AssociateInstancesKeyPairs&Version=2017-03-12&InstanceIds.1=ins-1e4r6y8i&InstanceIds.2=ins-3e56fg78&KeyIds.1=skey-4e5ty7i8&<公共请求参数>
输出
{"Response": {"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"}}
