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

Obtaining the Certificate List

Function

Obtain the certificate list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/cae/certificates

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.

  • Enter 0 or up to 36 characters in UUID format with hyphens (-).

  • If this parameter is not specified or is set to 0, resources in the default enterprise project are queried.

NOTE:
For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.

X-Environment-ID

Yes

String

Environment ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

kind

String

API type. Fixed value: Certificate.

items

Array of CertItem objects

Certificate list.

Table 4 CertItem

Parameter

Type

Description

metadata

MetaCert object

Response data.

spec

SpecCert object

Response data.

Table 5 MetaCert

Parameter

Type

Description

id

String

Certificate ID.

name

String

Certificate name.

Table 6 SpecCert

Parameter

Type

Description

crt

String

Certificate content.

key

String

Private key.

created_at

String

Creation time.

Example Requests

Obtain the certificate list.

GET https://{endpoint}/v1/{project_id}/cae/certificates

Example Responses

Status code: 200

OK

{
  "api_version" : "v1",
  "kind" : "Certificate",
  "items" : [ {
    "metadata" : {
      "id" : "b88810ff-8ce1-45af-8d31-730b4a887d06",
      "name" : "test"
    },
    "spec" : {
      "crt" : "xxx",
      "key" : "xxx",
      "created_at" : "2022-12-30T09:38:04.705025Z"
    }
  } ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.