更新时间:2025-05-29 GMT+08:00

查询CSR列表

功能介绍

查询CSR列表。

URI

GET /v3/scm/csr

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页条目数量,取值如下:

  • 10:每页显示10条证书信息。

  • 20:每页显示20条证书信息。

  • 50:每页显示50条证书信息。

最小值:10

最大值:50

缺省值:10

offset

Integer

偏移量。

最小值:0

最大值:100

缺省值:0

name

String

csr名称。

最小长度:0

最大长度:32

private_key_algo

String

密钥算法的类型。取值如下:

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • EC_P256

  • EC_P384

  • SM2

最小长度:0

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:32

最大长度:2097152

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

csr_list

Array of CSRResponseBody objects

CSR列表,详情请参见CSRResponseBody字段数据结构说明。

数组长度:0 - 1000

total

Integer

CSR数量。

最小值:0

最大值:10000

表4 CSRResponseBody

参数

参数类型

描述

id

String

CSR的ID。

最小长度:16

最大长度:16

name

String

CSR名称。

最小长度:3

最大长度:63

csr

String

CSR内容。

最小长度:3

最大长度:255

domain_name

String

CSR绑定的域名。

最小长度:1

最大长度:255

sans

String

CSR绑定的附加域名。

最小长度:1

最大长度:4096

private_key_algo

String

密钥算法。

最小长度:0

最大长度:64

usage

String

CSR用途。

最小长度:0

最大长度:64

company_country

String

国家。

最小长度:1

最大长度:128

company_province

String

省份。

最小长度:1

最大长度:255

company_city

String

城市。

最小长度:1

最大长度:32

company_name

String

公司名称。

最小长度:1

最大长度:128

create_time

Long

CSR创建时间。

最小值:13

最大值:20

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

请求示例

响应示例

状态码:200

正常返回。

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

状态码:401

认证失败。

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

状态码:403

禁止访问。

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

状态码:500

请求未完成,服务器内部异常。

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

状态码

状态码

描述

200

正常返回。

401

认证失败。

403

禁止访问。

404

访问页面未找到。

500

请求未完成,服务器内部异常。

错误码

请参见错误码