最近更新时间：2023.07.25 18:39:31
首次发布时间：2022.07.01 09:10:29
调用 DetachKeyPair 接口为一台或多台Linux实例解绑密钥对。
仅安装了密码插件的实例支持解绑密钥对，请先安装密码插件。
当前密钥对仅支持解绑 运行中 、 已停止 两种状态的实例。
解绑后的实例密钥对不再生效，如果您的实例已设置密码登录，解绑密钥对后，仍可以使用密码登录，否则需要重新绑定密钥对或重置密码才能登录实例，请谨慎操作。
解绑密钥对后需重启实例，密钥对生效。
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DetachKeyPair | 要执行的操作，取值：DetachKeyPair。 |
| Version | String | 是 | 2020-04-01 | API的版本，取值：2020-04-01。 |
InstanceIds.N | String | 是 | InstanceIds.1=i-ahipakt2gcg95jpv****&InstanceIds.2=i-ahipakt2gdg95lbe**** | 实例ID，最多支持100个ID。
|
KeyPairName | String | 否 | ssh_key_pair | 密钥对名称。
|
KeyPairId | String | 否 | kp-ybqcopwrdwl8j1****** | 密钥对唯一ID，可以调用DescribeKeyPairs接口查询。
|
ClientToken | String | 否 | 333456899ff**** | 保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
OperationDetails | Array of Struct | - | 操作详情，具体请参见下表“ OperationDetails结构 ”。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| InstanceId | String | i-bp67acfmxazb4p**** | 操作的实例ID。 |
Error | Struct | - | 操作的实例错误信息，具体请参见下表“ Error结构 ”。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | InvalidInstance.NotFound | 批量请求处理中，单个请求操作失败的错误码，具体请参见下表“错误码（批量操作时具体单个请求失败的异常）”。 |
| Message | String | The specified instance does not exist. | 批量请求处理中，单个请求的异常信息，具体请参见下表“错误码（批量操作时具体单个请求失败的异常）”。 |
| 错误码 | 错误信息 | 描述 |
|---|---|---|
InvalidInstance.NotFound | The specified instance does not exist. | 指定的实例不存在。 |
| InvalidKeyPairForWindows.Unsupported | The OSType of this specified instance is Windows, which does not support key pairs. | 指定的实例是Windows操作系统，不支持密钥对。 |
| InvalidResetAuthenticationAgent.NotFound | The specified reset-authentication agent does not install on the instance. | 指定的密码重置插件不存在。 |
| InvalidInstanceStatus | The status of the specified instance does not support this request. | 当前的实例状态不支持此操作。 |
| FlowLimitExceeded | You've reach the limit on request rate of resources. | 您已超过资源请求限速。 |
GET /?Action=DetachKeyPair&Version=2020-04-01&KeyPairName=ssh_key_pair1&InstanceIds.1=i-ahipakt2gcg95jpv****&InstanceIds.2=i-ahipakt2gdg95lbe**** HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing Service: ecs
{ "ResponseMetadata": { "RequestId": "202106111445100102252431000052****", "Action": "DetachKeyPair", "Version": "2020-04-01", "Service": "ecs", "Region": "cn-beijing" }, "Result": { "OperationDetails": [ { "InstanceId": "i-ahipakt2gcg95jpv****", "Error": null }, { "InstanceId": "i-ahipakt2gdg95lbe****", "Error": { "Code": "InvalidInstance.NotFound", "Message": "The specified instance does not exist." } } ] } }
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter.KeyPairNameAndKeyPairId | The required parameters KeyPairName and KeyPairId are not supplied. | 密钥对名称与密钥对ID不允许同时为空。 |
400 | MissingParameter.InstanceIds | The required parameter InstanceIds is not supplied. | 实例ID不能为空。 |
| 400 | LimitExceeded.MaximumInstanceIds | You've reached the limit on the number of InstanceIds that you can set. | 指定的InstanceIds数量超过最大限制。 |
| 400 | InvalidClientToken.Malformed | The specified ClientToken is malformed. | 指定的ClientToken不合法。 |
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. | 幂等参数不一致。 |
| 404 | InvalidKeyPair.NotFound | The specified KeyPair does not exist. | 指定的密钥对不存在。 |
| 412 | IdempotentProcessing | The request uses the same client token as a previous one that is still in process. | 先前的幂等请求仍在处理中，请稍后重试。 |
| 500 | InternalError | An internal error has occurred. | 内部错误，请重试。如果多次尝试失败，请提交工单。 |