Updated on 2025-05-29 GMT+08:00

Querying the CSR List

Function

Query the CSR list.

URI

GET /v3/scm/csr

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of certificate records on each page. The options are as follows:

  • 10: 10 certificate records can be displayed on each page.

  • 20: 20 certificate records can be displayed on each page.

  • 50: 50 certificate records can be displayed on each page.

Minimum: 10

Maximum: 50

Default: 10

offset

No

Integer

Offset.

Minimum: 0

Maximum: 100

Default: 0

name

No

String

CSR name.

Minimum: 0

Maximum: 32

private_key_algo

No

String

Key algorithm type. The value can be:

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • EC_P256

  • EC_P384

  • SM2

Minimum: 0

Maximum: 64

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.

Minimum: 32

Maximum: 2097152

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

csr_list

Array of CSRResponseBody objects

CSR list. For details, see the data structure description of the CSRResponseBody field.

Array Length: 0 - 1000

total

Integer

Number of CSRs.

Minimum: 0

Maximum: 10000

Table 4 CSRResponseBody

Parameter

Type

Description

id

String

CSR ID

Minimum: 16

Maximum: 16

name

String

CSR name

Minimum: 3

Maximum: 63

csr

String

CSR content

Minimum: 3

Maximum: 255

domain_name

String

Domain name bound to the CSR

Minimum: 1

Maximum: 255

sans

String

Additional domain name bound to the CSR

Minimum: 1

Maximum: 4096

private_key_algo

String

Key algorithm

Minimum: 0

Maximum: 64

usage

String

CSR usage

Minimum: 0

Maximum: 64

company_country

String

Country

Minimum: 1

Maximum: 128

company_province

String

Province

Minimum: 1

Maximum: 255

company_city

String

City

Minimum: 1

Maximum: 32

company_name

String

Company name

Minimum: 1

Maximum: 128

create_time

Long

CSR creation time.

Minimum: 13

Maximum: 20

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for an error request.

Minimum: 3

Maximum: 36

error_msg

String

Error information returned for an error request.

Minimum: 0

Maximum: 1024

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for an error request.

Minimum: 3

Maximum: 36

error_msg

String

Error information returned for an error request.

Minimum: 0

Maximum: 1024

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for an error request.

Minimum: 3

Maximum: 36

error_msg

String

Error information returned for an error request.

Minimum: 0

Maximum: 1024

Example Requests

None

Example Responses

Status code: 200

Normal response.

{
  "csr_list" : [ {
    "id" : "48e392628b0f47769e47d91acc7654a5",
    "name" : "xxxx",
    "domain_name" : "xxx.com",
    "sans" : "",
    "private_key_algo" : "RSA_2048",
    "usage" : "ENTERPRISE",
    "company_country" : "CN",
    "company_province" : "Beijing",
    "company_city" : "Beijing",
    "company_name" : "company",
    "create_time" : 1735804566545,
    "update_time" : 1735804566545
  } ],
  "total" : 1
}

Status code: 401

Authentication failed.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status code: 403

Access denied.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status code: 500

Failed to complete the request because of an internal server error.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code

Description

200

Normal response.

401

Authentication failed.

403

Access denied.

404

Access page not found.

500

Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.