导入私钥
功能介绍
导入私钥到指定密钥对。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/keypairs/private-key/import
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
keypair |
是 |
ImportPrivateKeyKeypairBean object |
待导入的密钥对信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
SSH密钥对的名称。 - 新创建的密钥对名称不能和已有密钥对的名称相同。 - SSH密钥对名称由英文字母、数字、下划线、中划线组成,长度不能超过64个字节 |
user_id |
否 |
String |
SSH密钥对所属的用户信息 |
key_protection |
是 |
ImportPrivateKeyProtection object |
SSH密钥对私钥托管与保护。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
private_key |
是 |
String |
导入SSH密钥对的私钥。 |
encryption |
是 |
Encryption object |
对私钥进行加密存储的方式。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
keypair |
ImportPrivateKeyKeypairBean object |
一 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
SSH密钥对的名称。 - 新创建的密钥对名称不能和已有密钥对的名称相同。 - SSH密钥对名称由英文字母、数字、下划线、中划线组成,长度不能超过64个字节 |
user_id |
String |
SSH密钥对所属的用户信息 |
key_protection |
ImportPrivateKeyProtection object |
SSH密钥对私钥托管与保护。 |
参数 |
参数类型 |
描述 |
---|---|---|
private_key |
String |
导入SSH密钥对的私钥。 |
encryption |
Encryption object |
对私钥进行加密存储的方式。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
取值范围:“kms”或“default”。
|
kms_key_name |
String |
kms密钥的名称。
|
kms_key_id |
String |
kms密钥的ID。
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
{ "keypair" : { "name" : "demo2", "key_protection" : { "private_key" : "-----BEGIN RSA PRIVATE KEY-----...", "encryption" : { "type" : "kms", "kms_key_name" : "kps/default" } } } }
响应示例
状态码: 200
请求已成功
{ "keypair" : { "name" : "demo2" } }
状态码: 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 58 59 |
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"); 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(); 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 46 |
# 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 = 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 52 53 |
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.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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
400 |
Error response |
错误码
请参见错误码。