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	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of returned records. The default value is 10.
offset	No	Integer	Index location. The query starts from the next data specified by offset.

Request Parameters

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of keystores
keystores	Array of KeystoreDetails objects	List of keystore details. For details, see KeystoreDetails.

**Table 5** KeystoreDetails
Parameter	Type	Description
keystore_id	String	Keystore ID
domain_id	String	User domain ID
keystore_alias	String	Keystore alias
keystore_type	String	Keystore type
hsm_cluster_id	String	Dedicated HSM cluster ID. Ensure that no dedicated keystores are created in the current cluster.
create_time	String	Keystore creation time, which is a UTC timestamp.
cluster_id	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.

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

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" : "cluster_id",
    "create_time" : 1581507580000
  } ]
}

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.