帮你快速理解、总结文档立即下载

绑定密钥

最近更新时间:2019-12-03 14:34:28
我的收藏
说明:
当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。

1. 接口描述

本接口 (BindInstanceKey) 用于将密钥绑定到 CVM 实例上。
接口请求域名:cvm.api.qcloud.com
系统将密钥的公钥写入到实例的 SSH 配置当中,用户就可以通过这个密钥的私钥登录 CVM 了。
如果实例原来绑定过密钥,那么原来的密钥将失效。
如果实例原来是通过密码登录,绑定密钥后无法使用密码登录。
只有已关机状态的子机才能绑定密钥。
注意:Windows 无法绑定密钥。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。
参数名称
是否必选
类型
描述
instanceIds.n
是
String
实例 ID(此接口支持同时传入多个 ID。此参数的具体格式可参见 API 简介的id.n一节)。
keyId
是
String
密钥 ID。

3. 输出参数

参数名称
类型
描述
code
Int
公共错误码。0表示成功,其他值表示失败。
message
String
模块错误信息描述,与接口相关。

4. 示例

输入
https://cvm.api.qcloud.com/v2/index.php?Action=BindInstanceKey
&instanceIds.0=ins-xxxxx
&instanceIds.1=ins-xxxxx
&keyId=skey-xxxxx
输出
{
"code": 0,
"message": ""
}