Help Center/Data Encryption Workshop/API Reference/APIs/Key Management APIs/Dedicated Keystore Management/Creating a Dedicated Keystore
Updated on 2025-09-15 GMT+08:00
View PDF

Creating a Dedicated Keystore

Function

Create a dedicated keystore. The keystore uses Dedicated HSM instances to store keys.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/keystores

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 used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

keystore_alias

Yes

String

Alias of the dedicated keystore. The value contains 1 to 255 characters, matches the regular expression ^[a-zA-Z0-9:/_-]{1,255}$, and must be unique.

hsm_cluster_id

No

String

ID of the Dedicated HSM cluster. Ensure that no dedicated keystores are created in the current cluster.

hsm_ca_cert

No

String

CA certificate of the Dedicated HSM cluster

cluster_id

No

String

Cluster ID. If a Dedicated HSM is used, the cluster_id is hsm_cluster_id. If a CDMS is used, the cluster_id is cdms_cluster_id.

keystore_type

No

String

Dedicated keystore cluster type. 1 indicates Dedicated HSM cluster, 2 indicates CDMS cluster, and 0 indicates the original KMS cluster.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

keystore

KeystoreInfo object

Keystore information

Table 5 KeystoreInfo

Parameter

Type

Description

keystore_id

String

Keystore ID

domain_id

String

User domain ID

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 7 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 8 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 9 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 10 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 11 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 12 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 13 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 14 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 15 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 16 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 17 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 18 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 19 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

Create a dedicated keystore whose alias is keystore_alia1 and cluster ID is hsm_cluster_id.

{
  "keystore_alias" : "keystore_alia1",
  "hsm_cluster_id" : "hsm_cluster_id",
  "hsm_ca_cert" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE-----"
}

Example Responses

Status code: 200

Request succeeded.

{
  "keystore" : {
    "keystore_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "domain_id" : "b168fe00ff56492495a7d22974df2d0b"
  }
}

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

Failed to complete the request. The server receives an invalid response from the upstream server.

504

Gateway timed out.

Error Codes

See Error Codes.

Parent Topic: Dedicated Keystore Management