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

解绑密钥

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

1. 接口描述

本接口 (UnBindInstanceKey) 用于解除 CVM 的密钥绑定关系。
接口请求域名:cvm.api.qcloud.com
解绑密钥只支持关机状态的 Linux 子机。
解绑密钥后,实例可以通过原来设置的密码登录。
如果原来没有设置密码,解绑后将无法使用 SSH 登录。可以调用 ResetInstancePassword 来增加一个登录密码。

2. 输入参数

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

3. 输出参数

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

4. 示例

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