文档首页/ 数据加密服务 DEW/ API参考/ API说明/ 管理SSH密钥对/ 密钥对任务管理/ 绑定SSH密钥对
更新时间：2024-11-20 GMT+08:00
查看PDF
分享

绑定SSH密钥对

功能介绍

给指定的虚拟机绑定（替换或重置，替换需提供虚拟机已配置的SSH密钥对私钥；重置不需要提供虚拟机的SSH密钥对私钥）新的SSH密钥对。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/keypairs/associate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

keypair_name

是

String

SSH密钥对的名称

server

是

EcsServerInfo object

需要绑定密钥对的虚拟机信息。
表4 EcsServerInfo

参数

是否必选

参数类型

描述

id

是

String

需要绑定(替换或重置)SSH密钥对的虚拟机id

auth

否

Auth object

可选字段，鉴权认证类型。替换时需要该参数，重置时不需要该参数。

disable_password

否

Boolean

  • true：禁用虚拟机的ssh登录。

  • false：不禁用虚拟机的ssh登录。

port

否

Long

SSH监听端口。
表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

错误描述

请求示例

  • {
  "keypair_name" : "newkeypair1",
  "server" : {
    "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7",
    "auth" : {
      "type" : "keypair",
      "key" : "-----BEGINRSAPRIVATEKEY-----M..."
    }
  }
}
  • {
  "keypair_name" : "newkeypair2",
  "server" : {
    "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7"
  }
}

响应示例

状态码： 202

OK

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

状态码： 400

Error response

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

SDK代码示例

SDK代码示例如下。

  •  1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
    		 
    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 AssociateKeypairSolution {

    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");
        String projectId = "{project_id}";

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

        KpsClient client = KpsClient.newBuilder()
                .withCredential(auth)
                .withRegion(KpsRegion.valueOf("<YOUR REGION>"))
                .build();
        AssociateKeypairRequest request = new AssociateKeypairRequest();
        AssociateKeypairRequestBody body = new AssociateKeypairRequestBody();
        Auth authServer = new Auth();
        authServer.withType(Auth.TypeEnum.fromValue("keypair"))
            .withKey("-----BEGINRSAPRIVATEKEY-----M...");
        EcsServerInfo serverbody = new EcsServerInfo();
        serverbody.withId("d76baba7-ef09-40a2-87ff-3eafec0696e7")
            .withAuth(authServer);
        body.withServer(serverbody);
        body.withKeypairName("newkeypair1");
        request.withBody(body);
        try {
            AssociateKeypairResponse response = client.associateKeypair(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());
        }
    }
}

  •  1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    		 
    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 AssociateKeypairSolution {

    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");
        String projectId = "{project_id}";

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

        KpsClient client = KpsClient.newBuilder()
                .withCredential(auth)
                .withRegion(KpsRegion.valueOf("<YOUR REGION>"))
                .build();
        AssociateKeypairRequest request = new AssociateKeypairRequest();
        AssociateKeypairRequestBody body = new AssociateKeypairRequestBody();
        EcsServerInfo serverbody = new EcsServerInfo();
        serverbody.withId("d76baba7-ef09-40a2-87ff-3eafec0696e7");
        body.withServer(serverbody);
        body.withKeypairName("newkeypair2");
        request.withBody(body);
        try {
            AssociateKeypairResponse response = client.associateKeypair(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());
        }
    }
}

  •  1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
    		 
    # 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = AssociateKeypairRequest()
        authServer = Auth(
            type="keypair",
            key="-----BEGINRSAPRIVATEKEY-----M..."
        )
        serverbody = EcsServerInfo(
            id="d76baba7-ef09-40a2-87ff-3eafec0696e7",
            auth=authServer
        )
        request.body = AssociateKeypairRequestBody(
            server=serverbody,
            keypair_name="newkeypair1"
        )
        response = client.associate_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)

  •  1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
    		 
    # 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = AssociateKeypairRequest()
        serverbody = EcsServerInfo(
            id="d76baba7-ef09-40a2-87ff-3eafec0696e7"
        )
        request.body = AssociateKeypairRequestBody(
            server=serverbody,
            keypair_name="newkeypair2"
        )
        response = client.associate_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)

  •  1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
    		 
    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")
    projectId := "{project_id}"

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

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

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

  •  1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
    		 
    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")
    projectId := "{project_id}"

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

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

    request := &model.AssociateKeypairRequest{}
	serverbody := &model.EcsServerInfo{
		Id: "d76baba7-ef09-40a2-87ff-3eafec0696e7",
	}
	request.Body = &model.AssociateKeypairRequestBody{
		Server: serverbody,
		KeypairName: "newkeypair2",
	}
	response, err := client.AssociateKeypair(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

202

OK

400

Error response

错误码

请参见错误码。

父主题： 密钥对任务管理

相关文档