Help Center/ Cloud Search Service/ API Reference/ API V1/ Logstash/ Querying the Certificate List
Updated on 2025-12-26 GMT+08:00
View PDF

Querying the Certificate List

Function

This API is used to query the certificate list.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/certs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints:

N/A

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

ID of the cluster to be queried. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

String

Definition:

Start value for the query

Constraints:

N/A

Value range:

1-1000

Default value:

1

limit

No

String

Definition:

Number of queries.

Constraints:

N/A

Value range:

1-1000

Default value:

10

certsType

No

String

Definition:

Certificate type. If this parameter is not specified, the system searches the custom certificate list.

Constraints:

N/A

Value range:

defaultCerts: default certificate type.

Default value:

defaultCerts

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

certsRecords

CertsRecordsDatastore object

Definition:

Certificate record.

Value range:

N/A

totalSize

Integer

Definition:

Number of certificate records.

Value range:

N/A
Table 4 CertsRecordsDatastore

Parameter

Type

Description

id

String

Definition:

Certificate record ID.

Value range:

N/A

status

String

Definition:

Certificate status.

Value range:

  • checking

  • available

  • unavailable

  • starting

  • working

  • stopping

  • stopped

  • restoring

fileLocation

String

Definition:

Location of the certificate record file.

Value range:

N/A

fileName

Boolean

Definition:

Name of the certificate record file.

Value range:

N/A

updateAt

Boolean

'Definition:

Certificate record update time.

Value range:

N/A

Example Requests

This API is used to query the certificate list.

GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/certs

Example Responses

Status code: 200

Request succeeded.

{
  "certsRecords" : [ {
    "id" : "2630b1ab-47f8-445c-a4e0-5de74683d767",
    "status" : "available",
    "fileLocation" : "/rds/datastore/logstash/v7.10.0/package/logstash-7.10.0/extend/custom_certs/",
    "fileName" : "xxxx.cer",
    "updateAt" : "2023-06-14T06:54:36"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request instead of retrying.

409

The request cannot be processed due to a conflict.

This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

412

The server does not meet one of the requirements that the requester puts on the request.

Error Codes

See Error Codes.

Parent topic: Logstash