文档首页/ 数据加密服务 DEW/ API参考/ API说明/ 管理SSH密钥对/ 密钥对任务管理/ 解绑SSH密钥对

更新时间：2024-07-11 GMT+08:00

查看PDF

解绑SSH密钥对

功能介绍

给指定的虚拟机解除绑定SSH密钥对并恢复SSH密码登录。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/keypairs/disassociate

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
server	是	DisassociateEcsServerInfo object	需要绑定密钥对的虚拟机信息。

表4 DisassociateEcsServerInfo
参数	是否必选	参数类型	描述
id	是	String	需要绑定(替换或重置)SSH密钥对的虚拟机id
auth	否	Auth object	可选字段，鉴权认证类型。替换时需要该参数，重置时不需要该参数。

表5 Auth
参数	是否必选	参数类型	描述
type	否	String	取值为枚举类型。password或keypair。
key	否	String	type为枚举值password时，key表示密码； type为枚举值keypair时，key表示私钥；

响应参数

状态码： 202

表6 响应Body参数
参数	参数类型	描述
task_id	String	任务下发成功返回的ID。
server_id	String	绑定的虚拟机id。
status	String	任务下发的状态。SUCCESS或FAILED。
error_code	String	任务下发失败返回的错误码。
error_msg	String	任务下发失败返回的错误信息。

状态码： 400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

{
  "server" : {
    "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7",
    "auth" : {
      "type" : "keypair",
      "key" : "-----BEGINRSAPRIVATEKEY-----\nM..."
    }
  }
}

{
  "server" : {
    "id" : "x76baba7-ef09-40a2-87ff-3eafec0696e7"
  }
}

响应示例

状态码： 202

{
  "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c"
}

状态码： 400

Error response

{
  "error_code" : "KPS.XXX",
  "error_msg" : "XXX"
}

SDK代码示例

SDK代码示例如下。

        
         
           
           
             package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kps.v3.region.KpsRegion;
import com.huaweicloud.sdk.kps.v3.*;
import com.huaweicloud.sdk.kps.v3.model.*;


public class DisassociateKeypairSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        KpsClient client = KpsClient.newBuilder()
                .withCredential(auth)
                .withRegion(KpsRegion.valueOf("<YOUR REGION>"))
                .build();
        DisassociateKeypairRequest request = new DisassociateKeypairRequest();
        DisassociateKeypairRequestBody body = new DisassociateKeypairRequestBody();
        Auth authServer = new Auth();
        authServer.withType(Auth.TypeEnum.fromValue("keypair"))
            .withKey("-----BEGINRSAPRIVATEKEY-----
M...");
        DisassociateEcsServerInfo serverbody = new DisassociateEcsServerInfo();
        serverbody.withId("d76baba7-ef09-40a2-87ff-3eafec0696e7")
            .withAuth(authServer);
        body.withServer(serverbody);
        request.withBody(body);
        try {
            DisassociateKeypairResponse response = client.disassociateKeypair(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

            

          

        
       

        
         
           
           
             package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kps.v3.region.KpsRegion;
import com.huaweicloud.sdk.kps.v3.*;
import com.huaweicloud.sdk.kps.v3.model.*;


public class DisassociateKeypairSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        KpsClient client = KpsClient.newBuilder()
                .withCredential(auth)
                .withRegion(KpsRegion.valueOf("<YOUR REGION>"))
                .build();
        DisassociateKeypairRequest request = new DisassociateKeypairRequest();
        DisassociateKeypairRequestBody body = new DisassociateKeypairRequestBody();
        DisassociateEcsServerInfo serverbody = new DisassociateEcsServerInfo();
        serverbody.withId("x76baba7-ef09-40a2-87ff-3eafec0696e7");
        body.withServer(serverbody);
        request.withBody(body);
        try {
            DisassociateKeypairResponse response = client.disassociateKeypair(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

            

          

        
       

        
         
           
           
             # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkps.v3.region.kps_region import KpsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkps.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = KpsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KpsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = DisassociateKeypairRequest()
        authServer = Auth(
            type="keypair",
            key="-----BEGINRSAPRIVATEKEY-----
        M..."
        )
        serverbody = DisassociateEcsServerInfo(
            id="d76baba7-ef09-40a2-87ff-3eafec0696e7",
            auth=authServer
        )
        request.body = DisassociateKeypairRequestBody(
            server=serverbody
        )
        response = client.disassociate_keypair(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

        
         
           
           
             # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkps.v3.region.kps_region import KpsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkps.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = KpsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KpsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = DisassociateKeypairRequest()
        serverbody = DisassociateEcsServerInfo(
            id="x76baba7-ef09-40a2-87ff-3eafec0696e7"
        )
        request.body = DisassociateKeypairRequestBody(
            server=serverbody
        )
        response = client.disassociate_keypair(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kps "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := kps.NewKpsClient(
        kps.KpsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.DisassociateKeypairRequest{}
	typeAuth:= model.GetAuthTypeEnum().KEYPAIR
	keyAuth:= "-----BEGINRSAPRIVATEKEY-----
M..."
	authServer := &model.Auth{
		Type: &typeAuth,
		Key: &keyAuth,
	}
	serverbody := &model.DisassociateEcsServerInfo{
		Id: "d76baba7-ef09-40a2-87ff-3eafec0696e7",
		Auth: authServer,
	}
	request.Body = &model.DisassociateKeypairRequestBody{
		Server: serverbody,
	}
	response, err := client.DisassociateKeypair(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kps "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := kps.NewKpsClient(
        kps.KpsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.DisassociateKeypairRequest{}
	serverbody := &model.DisassociateEcsServerInfo{
		Id: "x76baba7-ef09-40a2-87ff-3eafec0696e7",
	}
	request.Body = &model.DisassociateKeypairRequestBody{
		Server: serverbody,
	}
	response, err := client.DisassociateKeypair(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
202	OK
400	Error response

错误码

请参见错误码。

父主题：密钥对任务管理

上一篇：绑定SSH密钥对

下一篇：批量绑定SSH密钥对

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消