Updated on 2024-08-06 GMT+08:00

Accessing the page for importing private keys

Function

Import the private key to the specified key pair.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/keypairs/private-key/import

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

keypair

Yes

ImportPrivateKeyKeypairBean object

Information about the key pair to be imported

Table 4 ImportPrivateKeyKeypairBean

Parameter

Mandatory

Type

Description

name

Yes

String

SSH key pair name. - The name of a key pair must be unique. - The key pair name can contain letters, digits, underscores (_), and hyphens (-) and cannot exceed 64 bytes.

user_id

No

String

User that an SSH key pair belongs to

key_protection

Yes

ImportPrivateKeyProtection object

Private key hosting and protection for the SSH key pair.

Table 5 ImportPrivateKeyProtection

Parameter

Mandatory

Type

Description

private_key

Yes

String

Private key of the imported SSH key pair.

encryption

Yes

Encryption object

How a private key is encrypted and stored.

Table 6 Encryption

Parameter

Mandatory

Type

Description

type

Yes

String

Value options: - default: The default encryption mode. Applicable to sites where KMS is not deployed. - kms: KMS encryption mode. If the KMS service is not available at the site, set this parameter to default.

kms_key_name

No

String

KMS key name.

  • If type is set to kms, you must enter the KMS key name or ID.

kms_key_id

No

String

KMS key ID.

  • If type is set to kms, you must enter the KMS key name or ID.

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

keypair

ImportPrivateKeyKeypairBean object

One

Table 8 ImportPrivateKeyKeypairBean

Parameter

Type

Description

name

String

SSH key pair name. - The name of a key pair must be unique. - The key pair name can contain letters, digits, underscores (_), and hyphens (-) and cannot exceed 64 bytes.

user_id

String

User that an SSH key pair belongs to

key_protection

ImportPrivateKeyProtection object

Private key hosting and protection for the SSH key pair.

Table 9 ImportPrivateKeyProtection

Parameter

Type

Description

private_key

String

Private key of the imported SSH key pair.

encryption

Encryption object

How a private key is encrypted and stored.

Table 10 Encryption

Parameter

Type

Description

type

String

Value options: - default: The default encryption mode. Applicable to sites where KMS is not deployed. - kms: KMS encryption mode. If the KMS service is not available at the site, set this parameter to default.

kms_key_name

String

KMS key name.

  • If type is set to kms, you must enter the KMS key name or ID.

kms_key_id

String

KMS key ID.

  • If type is set to kms, you must enter the KMS key name or ID.

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

{
  "keypair" : {
    "name" : "demo2",
    "key_protection" : {
      "private_key" : "-----BEGIN RSA PRIVATE KEY-----...",
      "encryption" : {
        "type" : "kms",
        "kms_key_name" : "kps/default"
      }
    }
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "keypair" : {
    "name" : "demo2"
  }
}

Status code: 400

Error response

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

SDK Sample Code

The SDK sample code is as follows.

 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 ImportPrivateKeySolution {

    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();
        ImportPrivateKeyRequest request = new ImportPrivateKeyRequest();
        ImportPrivateKeyRequestBody body = new ImportPrivateKeyRequestBody();
        Encryption encryptionKeyProtection = new Encryption();
        encryptionKeyProtection.withType(Encryption.TypeEnum.fromValue("kms"))
            .withKmsKeyName("kps/default");
        ImportPrivateKeyProtection keyProtectionKeypair = new ImportPrivateKeyProtection();
        keyProtectionKeypair.withPrivateKey("-----BEGIN RSA PRIVATE KEY-----...")
            .withEncryption(encryptionKeyProtection);
        ImportPrivateKeyKeypairBean keypairbody = new ImportPrivateKeyKeypairBean();
        keypairbody.withName("demo2")
            .withKeyProtection(keyProtectionKeypair);
        body.withKeypair(keypairbody);
        request.withBody(body);
        try {
            ImportPrivateKeyResponse response = client.importPrivateKey(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
# 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 = ImportPrivateKeyRequest()
        encryptionKeyProtection = Encryption(
            type="kms",
            kms_key_name="kps/default"
        )
        keyProtectionKeypair = ImportPrivateKeyProtection(
            private_key="-----BEGIN RSA PRIVATE KEY-----...",
            encryption=encryptionKeyProtection
        )
        keypairbody = ImportPrivateKeyKeypairBean(
            name="demo2",
            key_protection=keyProtectionKeypair
        )
        request.body = ImportPrivateKeyRequestBody(
            keypair=keypairbody
        )
        response = client.import_private_key(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")

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

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

    request := &model.ImportPrivateKeyRequest{}
	kmsKeyNameEncryption:= "kps/default"
	encryptionKeyProtection := &model.Encryption{
		Type: model.GetEncryptionTypeEnum().KMS,
		KmsKeyName: &kmsKeyNameEncryption,
	}
	keyProtectionKeypair := &model.ImportPrivateKeyProtection{
		PrivateKey: "-----BEGIN RSA PRIVATE KEY-----...",
		Encryption: encryptionKeyProtection,
	}
	keypairbody := &model.ImportPrivateKeyKeypairBean{
		Name: "demo2",
		KeyProtection: keyProtectionKeypair,
	}
	request.Body = &model.ImportPrivateKeyRequestBody{
		Keypair: keypairbody,
	}
	response, err := client.ImportPrivateKey(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

400

Error response

Error Codes

See Error Codes.