Exporting Private Keys of Key Pairs in Batches

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.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

POST /v3/{project_id}/keypairs/private-key/batch-export

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition 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. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
[items]	Yes	Array of Keypairs objects	List of keys to be exported.

**Table 4** Keypairs
Parameter	Mandatory	Type	Description
keypair	Yes	Keypair object	Definition SSH key pair information Default Value N/A

**Table 5** Keypair
Parameter	Mandatory	Type	Description
name	No	String	Definition Key pair name. The value can contain at most 255 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. Range N/A
type	No	String	Definition Key pair type Range ssh x509
scope	No	String	Definition Domain to which the key pair belongs, which can be tenant-level or user-level. Range domain user
public_key	No	String	Definition Public key information of an SSH key pair Range N/A
fingerprint	No	String	Definition Fingerprint information about an SSH key pair Range N/A
is_key_protection	No	Boolean	Definition Whether to host keys Range true or false
frozen_state	No	String	Definition Key frozen status Range 0: normal 1: frozen due to common causes 2: frozen by the public security bureau 3: frozen due to common causes and frozen 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 the lack of real-name authentication 9: frozen due to common causes and the lack of real-name authentication 10: frozen by the public security bureau and due to the lack of real-name authentication

Status code: 200

Request succeeded.

None

Export the demo2, demo3, and demo4 SSH key pairs in batches.

[ {
  "keypair" : {
    "name" : "demo2"
  }
}, {
  "keypair" : {
    "name" : "demo3"
  }
}, {
  "keypair" : {
    "name" : "demo4"
  }
} ]

Status code: 200

Request succeeded.

"keypairs.zip"

Status Code	Description
200	Request succeeded.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.