Updated on 2025-08-08 GMT+08:00

Creating an EC Data Key Pair

Function

This API is used to create an EC data key pair. The returned result contains the plaintext public key and ciphertext private key. You can determine whether to return the plaintext private key based on the parameter.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/kms/create-ec-datakey-pair

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.

It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

key_id

Yes

String

Key ID, which is 36-byte long and matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$,

for example, 0d0466b0-e727-4d9c-b35d-f84bb474a37f.

key_spec

Yes

String

The algorithm, length, and curve information are included. The value can be ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, or SM2.

with_plain_text

No

Boolean

Whether to return the plaintext private key. The default value is true.

additional_authenticated_data

No

String

Additional information for authentication and encryption. Do not enter sensitive information.

sequence

No

String

A 36-byte serial number of a request message,

for example, 919c82d4-8046-4722-9094-35c3c6524cff.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

key_id

String

Key ID.

key_spec

String

The algorithm, length, and curve information are included. The value can be RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, or SM2.

public_key

String

Plaintext public key information.

private_key_cipher_text

String

Ciphertext private key.

private_key_plain_text

String

Plaintext private key. Only one of private_key_plain_text, wrapped_private_key, and ciphertext_recipient can have a value.

wrapped_private_key

String

Ciphertext private key encrypted using the custom private key. Only one of private_key_plain_text, wrapped_private_key, and ciphertext_recipient can have a value.

ciphertext_recipient

String

Ciphertext private key encrypted using the QingTian public key. Only one of private_key_plain_text, wrapped_private_key, and ciphertext_recipient can have a value.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 6 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 10 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 12 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 14 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 502

Table 15 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 16 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 504

Table 17 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 18 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Example Requests

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "key_spec" : "ECC_NIST_P256",
  "with_plain_text" : true,
  "additional_authenticated_data" : "aad",
  "sequence" : "sequence"
}

Example Responses

Status code: 200

Request succeeded.

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "key_spec" : "ECC_NIST_P256",
  "public_key" : "public_key",
  "private_key_cipher_text" : "private_key_cipher_text",
  "private_key_plain_text" : "private_key_plain_text",
  "wrapped_private_key" : "wrapped_private_key",
  "ciphertext_recipient" : "ciphertext_recipient"
}

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
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.kms.v2.region.KmsRegion;
import com.huaweicloud.sdk.kms.v2.*;
import com.huaweicloud.sdk.kms.v2.model.*;


public class CreateEcDatakeyPairSolution {

    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);

        KmsClient client = KmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(KmsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateEcDatakeyPairRequest request = new CreateEcDatakeyPairRequest();
        CreateEcDatakeyPairRequestBody body = new CreateEcDatakeyPairRequestBody();
        body.withSequence("sequence");
        body.withAdditionalAuthenticatedData("aad");
        body.withWithPlainText(true);
        body.withKeySpec(CreateEcDatakeyPairRequestBody.KeySpecEnum.fromValue("ECC_NIST_P256"));
        body.withKeyId("0d0466b0-e727-4d9c-b35d-f84bb474a37f");
        request.withBody(body);
        try {
            CreateEcDatakeyPairResponse response = client.createEcDatakeyPair(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkms.v2.region.kms_region import KmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkms.v2 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 = KmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateEcDatakeyPairRequest()
        request.body = CreateEcDatakeyPairRequestBody(
            sequence="sequence",
            additional_authenticated_data="aad",
            with_plain_text=True,
            key_spec="ECC_NIST_P256",
            key_id="0d0466b0-e727-4d9c-b35d-f84bb474a37f"
        )
        response = client.create_ec_datakey_pair(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/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 := kms.NewKmsClient(
        kms.KmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateEcDatakeyPairRequest{}
	sequenceCreateEcDatakeyPairRequestBody:= "sequence"
	additionalAuthenticatedDataCreateEcDatakeyPairRequestBody:= "aad"
	withPlainTextCreateEcDatakeyPairRequestBody:= true
	request.Body = &model.CreateEcDatakeyPairRequestBody{
		Sequence: &sequenceCreateEcDatakeyPairRequestBody,
		AdditionalAuthenticatedData: &additionalAuthenticatedDataCreateEcDatakeyPairRequestBody,
		WithPlainText: &withPlainTextCreateEcDatakeyPairRequestBody,
		KeySpec: model.GetCreateEcDatakeyPairRequestBodyKeySpecEnum().ECC_NIST_P256,
		KeyId: "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
	}
	response, err := client.CreateEcDatakeyPair(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

Invalid request parameters.

401

Username and password are required for the requested page.

403

Authentication failed.

404

The resource does not exist.

500

Internal service error.

502

Request failed. The server has received an invalid response.

504

Gateway timed out.

Error Codes

See Error Codes.