Updated on 2026-09-21 GMT+08:00

Querying the List of Dedicated Keystores

Function

This API is used to query the dedicated keystore list.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/keystores

**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** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Number of returned records Constraints The value of limit must be a number. Range 0 to 100 Default Value 100
offset	No	Integer	Definition Index location. The query starts from the next data record specified by offset. Constraints N/A Range N/A Default Value 0

Request Parameters

**Table 3** 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Definition Total number of keystores Range N/A
keystores	Array of KeystoreDetails objects	Definition Key details list Range N/A

**Table 5** KeystoreDetails
Parameter	Type	Description
keystore_id	String	Definition Keystore ID Range N/A
domain_id	String	Definition User domain ID Range N/A
keystore_alias	String	Definition Keystore alias Range N/A
keystore_type	String	Definition Keystore type Range N/A
hsm_cluster_id	String	Definition DHSM cluster ID Range N/A
create_time	String	Definition Keystore creation time, which is a UTC timestamp. Range N/A
cluster_id	String	Definition Cluster ID Range N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 1,
  "keystores" : [ {
    "keystore_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "domain_id" : "b168fe00ff56492495a7d22974df2d0b",
    "keystore_alias" : "test",
    "keystore_type" : "typetest",
    "hsm_cluster_id" : "hsm_cluster_id",
    "cluster_id" : "cluster_id",
    "create_time" : "1581507580000"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Dedicated Keystore Management