文档

DetachKeyPair - 解绑密钥对

更新时间:

解绑轻量应用服务器的密钥对。

接口说明

如果您需要更换密钥对或者某个用户不再需要访问特定实例,您可以解绑 SSH 密钥对,以提高实例的安全性或限制访问权限。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

指定的轻量应用服务器所属的地域 ID。

cn-hangzhou
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-426655440000
InstanceIdsarray

解绑 SSH 密钥对的实例 ID。最多支持 50 个实例 ID。

string

解绑 SSH 密钥对的实例 ID。最多支持 50 个实例 ID。

2ad1ae67295445f598017499dc****
KeyPairNamestring

密钥对名称。必须保持名称唯一性。 长度为 2~64 个英文或中文字符。必须以大小写字母或中文开头,不能以 http:// 和 https:// 开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

KeyPairName

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

20758A-585D-4A41-A9B2-28DA8F4F534F
TotalCountinteger

解绑密钥对的实例总数量。

1
FailCountinteger

绑定密钥对失败的实例总数量。

0
Resultsobject []

结果列表。

Codestring

结果码。

200
Messagestring

结果信息。

success
Successstring

密钥对解绑是否成功。可能值:

  • true:密钥对解绑成功。

  • false:密钥对解绑失败。

true
InstanceIdstring

轻量应用服务器实例 ID。

aa6e71ddb35c46679bc4753d6219d604

示例

正常返回示例

JSON格式

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "TotalCount": 1,
  "FailCount": 0,
  "Results": [
    {
      "Code": "200",
      "Message": "success",
      "Success": "true",
      "InstanceId": "aa6e71ddb35c46679bc4753d6219d604"
    }
  ]
}

错误码

HTTP status code错误码错误信息
400InvalidParameter.KeypairNotAttachedInstanceThe specified keyPair not attached to instances.
404InvalidInstanceId.NotFoundThe specified Instance Id does not exist.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
  • 本页导读 (1)