Exporting Private Keys of Key Pairs in Batches
Function
This API is used to export private keys of key pairs in batches. A maximum of 10 private keys can be selected at a time.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/keypairs/private-key/batch-export
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 Keypairs objects |
- |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
keypair |
Yes |
Keypair object |
Key pair information |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
SSH key pair name |
type |
No |
String |
Type of the SSH key pair. The value can be ssh or x509. |
scope |
No |
String |
Tenant-level or user-level. The value can be domain or user. |
public_key |
No |
String |
Public key information about an SSH key pair |
fingerprint |
No |
String |
Fingerprint information about an SSH key pair |
is_key_protection |
No |
Boolean |
Whether to host keys |
frozen_state |
No |
String |
Frozen Status - 0: normal, not frozen - 1: frozen due to common causes - 2: frozen by the public security bureau - 3: frozen due to common causes and by the public security bureau - 4: frozen due to violations - 5: frozen due to common causes and violations - 6: frozen by the public security bureau and due to violations - 7: frozen by the public security bureau and due to common causes and violations - 8: frozen due to lack of real-name authentication - 9: frozen due to common causes and lack of real-name authentication - 10: frozen by the public security bureau and due to lack of real-name authentication |
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Export the demo2, demo3, and demo4 SSH key pairs in batches.
[ { "keypair" : { "name" : "demo2" } }, { "keypair" : { "name" : "demo3" } }, { "keypair" : { "name" : "demo4" } } ]
Example Responses
Status code: 200
Request succeeded.
"keypairs.zip"
SDK Sample Code
The SDK sample code is as follows.
Export the demo2, demo3, and demo4 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 66 67 68 69 |
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 BatchExportPrivateKeySolution { 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(); BatchExportPrivateKeyRequest request = new BatchExportPrivateKeyRequest(); Keypair keypairBody = new Keypair(); keypairBody.withName("demo4"); Keypair keypairBody1 = new Keypair(); keypairBody1.withName("demo3"); Keypair keypairBody2 = new Keypair(); keypairBody2.withName("demo2"); List<Keypairs> listbodyBody = new ArrayList<>(); listbodyBody.add( new Keypairs() .withKeypair(keypairBody2) ); listbodyBody.add( new Keypairs() .withKeypair(keypairBody1) ); listbodyBody.add( new Keypairs() .withKeypair(keypairBody) ); request.withBody(listbodyBody); try { BatchExportPrivateKeyResponse response = client.batchExportPrivateKey(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()); } } } |
Export the demo2, demo3, and demo4 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 |
# 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 = BatchExportPrivateKeyRequest() keypairBody = Keypair( name="demo4" ) keypairBody1 = Keypair( name="demo3" ) keypairBody2 = Keypair( name="demo2" ) listBodybody = [ Keypairs( keypair=keypairBody2 ), Keypairs( keypair=keypairBody1 ), Keypairs( keypair=keypairBody ) ] request.body = listBodybody response = client.batch_export_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) |
Export the demo2, demo3, and demo4 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 |
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.BatchExportPrivateKeyRequest{} nameKeypair:= "demo4" keypairBody := &model.Keypair{ Name: &nameKeypair, } nameKeypair1:= "demo3" keypairBody1 := &model.Keypair{ Name: &nameKeypair1, } nameKeypair2:= "demo2" keypairBody2 := &model.Keypair{ Name: &nameKeypair2, } var listBodybody = []model.Keypairs{ { Keypair: keypairBody2, }, { Keypair: keypairBody1, }, { Keypair: keypairBody, }, } request.Body = &listBodybody response, err := client.BatchExportPrivateKey(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. |
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