Importing SSH Key Pairs in Batches
Function
This API is used to batch import SSH key pairs. A maximum of 10 SSH key pairs can be selected at a time.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/keypairs/batch-import
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
[items] |
Yes |
Array of CreateKeypairRequestBody objects |
Request body for creating a key pair |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
keypair |
Yes |
CreateKeypairAction object |
Parameter in the request body for creating a key pair |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
SSH key pair name.
|
type |
No |
String |
SSH key pair type. The value can be ssh or x509. |
public_key |
No |
String |
String of an imported public key |
scope |
No |
String |
Tenant-level or user-level. The value can be domain or user. |
user_id |
No |
String |
User that an SSH key pair belongs to |
key_protection |
No |
KeyProtection object |
Private key hosting and protection for the SSH key pair. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
private_key |
No |
String |
Private key of the imported SSH key pair. |
encryption |
Yes |
Encryption object |
How a private key is encrypted and stored. |
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.
|
kms_key_id |
No |
String |
KMS key ID.
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
failed_keypairs |
Array of FailedKeypair objects |
Information about the SSH key pair that fails to be imported and the failure cause |
succeeded_keypairs |
Array of CreateKeypairResponseBody objects |
Information about the imported SSH key pair |
Parameter |
Type |
Description |
---|---|---|
keypair_name |
String |
SSH key pair name |
failed_reason |
String |
Import failure cause |
Parameter |
Type |
Description |
---|---|---|
keypair |
CreateKeypairResp object |
SSH key pair details |
Parameter |
Type |
Description |
---|---|---|
name |
String |
SSH key pair name |
type |
String |
SSH key pair type. The value can be ssh or x509. |
public_key |
String |
Public key information about an SSH key pair |
private_key |
String |
Private key information about an SSH key pair. - When an SSH key pair is created, the response contains private_key information. - When an SSH key pair is imported, the response does not contain private_key information. |
fingerprint |
String |
Fingerprint information about an SSH key pair |
user_id |
String |
User that an SSH key pair belongs to |
Example Requests
Import the demo2 and demo3 SSH key pairs in batches.
[ { "keypair" : { "name" : "demo2", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova" } }, { "keypair" : { "name" : "demo3", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova" } } ]
Example Responses
Status code: 200
The SSH key pairs are imported in batches.
{ "failed_keypairs" : [ { "keypair_name" : "demo3", "failed_reason" : "{\"error_code\":\"KPS.7004\", \"error_msg\":\"Key pair 'demo3' already exists.\"}" } ], "succeeded_keypairs" : [ { "keypair" : { "name" : "demo2", "fingerprint" : "SHA256:Wm91+h496cPk5JleSp4RdD2n4Z/5KdlDeD51lmiZ11M", "type" : "ssh", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova", "user_id" : "6c2a33b1b8474d0dbac0a24297127525" } } ] }
SDK Sample Code
The SDK sample code is as follows.
Import the demo2 and demo3 SSH key pairs in batches.
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 58 59 60 61 62 63 64 65 |
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.*; import java.util.List; import java.util.ArrayList; public class BatchImportKeypairSolution { 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(); BatchImportKeypairRequest request = new BatchImportKeypairRequest(); CreateKeypairAction keypairBody = new CreateKeypairAction(); keypairBody.withName("demo3") .withPublicKey("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova"); CreateKeypairAction keypairBody1 = new CreateKeypairAction(); keypairBody1.withName("demo2") .withPublicKey("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova"); List<CreateKeypairRequestBody> listbodyBody = new ArrayList<>(); listbodyBody.add( new CreateKeypairRequestBody() .withKeypair(keypairBody1) ); listbodyBody.add( new CreateKeypairRequestBody() .withKeypair(keypairBody) ); request.withBody(listbodyBody); try { BatchImportKeypairResponse response = client.batchImportKeypair(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()); } } } |
Import the demo2 and demo3 SSH key pairs in batches.
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 |
# 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 = BatchImportKeypairRequest() keypairBody = CreateKeypairAction( name="demo3", public_key="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova" ) keypairBody1 = CreateKeypairAction( name="demo2", public_key="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova" ) listBodybody = [ CreateKeypairRequestBody( keypair=keypairBody1 ), CreateKeypairRequestBody( keypair=keypairBody ) ] request.body = listBodybody response = client.batch_import_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) |
Import the demo2 and demo3 SSH key pairs in batches.
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 |
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.BatchImportKeypairRequest{} publicKeyKeypair:= "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova" keypairBody := &model.CreateKeypairAction{ Name: "demo3", PublicKey: &publicKeyKeypair, } publicKeyKeypair1:= "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova" keypairBody1 := &model.CreateKeypairAction{ Name: "demo2", PublicKey: &publicKeyKeypair1, } var listBodybody = []model.CreateKeypairRequestBody{ { Keypair: keypairBody1, }, { Keypair: keypairBody, }, } request.Body = &listBodybody response, err := client.BatchImportKeypair(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 |
The SSH key pairs are imported in batches. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot