解绑密钥对

最近更新时间: 2024-10-18 10:38:39

1. 接口描述

接口请求域名: cvm.api3.fincloud.tencent.cn。

本接口 (DisassociateInstancesKeyPairs) 用于解除实例的密钥绑定关系。

  • 只支持STOPPED状态的Linux操作系统的实例。
  • 解绑密钥后,实例可以通过原来设置的密码登录。
  • 如果原来没有设置密码,解绑后将无法使用 SSH 登录。可以调用 ResetInstancesPassword 接口来设置登陆密码。
  • 支持批量操作。每次请求批量实例的上限为100。如果批量实例存在不允许操作的实例,操作会以特定错误码返回。

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

接口更新时间:2022-10-27 11:52:02。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DisassociateInstancesKeyPairs
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