绑定密钥对
最近更新时间: 2024-10-18 10:38:39
1. 接口描述
接口请求域名： cvm.api3.fincloud.tencent.cn。
本接口 (AssociateInstancesKeyPairs) 用于将密钥绑定到实例上。
- 将密钥的公钥写入到实例的
SSH配置当中，用户就可以通过该密钥的私钥来登录实例。 - 如果实例原来绑定过密钥，那么原来的密钥将失效。
- 如果实例原来是通过密码登录，绑定密钥后无法使用密码登录。
- 支持批量操作。每次请求批量实例的上限为100。如果批量实例存在不允许操作的实例，操作会以特定错误码返回。
默认接口请求频率限制：10次/秒。
接口更新时间：2022-10-27 11:51:28。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：AssociateInstancesKeyPairs |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceIds | 是 | 否 | Array of String | 一个或多个待操作的实例ID，每次请求批量实例的上限为100。<br><br>可以通过以下方式获取可用的实例ID：<br><li>通过登录控制台查询实例ID。<br><li>通过调用接口 DescribeInstances ，取返回信息中的InstanceId获取实例ID。 |
| KeyIds | 是 | 否 | Array of String | 一个或多个待操作的密钥对ID，每次请求批量密钥对的上限为100。密钥对ID形如：skey-11112222。<br><br>可以通过以下方式获取可用的密钥ID：<br><li>通过登录控制台查询密钥ID。<br><li>通过调用接口 DescribeKeyPairs ，取返回信息中的KeyId获取密钥对ID。 |
| ForceStop | 否 | 否 | Bool | 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机，然后再重置用户密码。取值范围：<br><li>TRUE：表示在正常关机失败后进行强制关机。<br><li>FALSE：表示在正常关机失败后不进行强制关机。<br><br>默认取值：FALSE。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 此参数对外不可见。 任务ID |
| FlowId | Int64 | 此参数对外不可见。 任务流转ID |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidInstanceId.NotFound | |
| InvalidInstance.NotSupported | |
| InvalidParameterValue | |
| InvalidKeyPairId.Malformed | |
| InternalServerError | |
| InvalidParameterValue.LimitExceeded | |
| InvalidInstanceId.Malformed | |
| InvalidKeyPairId.NotFound | |
| MissingParameter |