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

创建CSR

功能介绍

创建CSR。

URI

POST /v3/scm/csr

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

最小长度:32

最大长度:2097152

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

自定义CSR名称。

最小长度:0

最大长度:63

domain_name

String

CSR绑定的域名。如果您想在提交证书申请时使用该CSR,必须确保证书绑定域名包含此处设置的域名。

最小长度:0

最大长度:63

sans

String

CSR绑定的附加域名。

最小长度:0

最大长度:255

private_key_algo

String

私钥算法。取值如下:

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • EC_P256

  • EC_P384

  • SM2

最小长度:0

最大长度:63

usage

String

CSR用途。取值如下:

  • PERSONAL:个人证书

  • ENTERPRISE:企业证书

最小长度:0

最大长度:255

company_country

String

国家,当“usage”取值为“ENTERPRISE”时,本参数必填。取值示例:CN。

最小长度:0

最大长度:255

company_province

String

省份,当“usage”取值为“ENTERPRISE”时,本参数必填。取值示例:北京市。

最小长度:0

最大长度:255

company_city

String

城市。当“usage”取值为“ENTERPRISE”时,本参数必填。取值示例:北京市。

最小长度:0

最大长度:255

company_name

String

公司名称。当“usage”取值为“ENTERPRISE”时,本参数必填。

最小长度:0

最大长度:255

响应参数

状态码:201

表3 响应Body参数

参数

参数类型

描述

id

String

CSR的ID。

最小长度:0

最大长度:63

name

String

自定义CSR名称。

最小长度:0

最大长度:63

domain_name

String

域名。

最小长度:0

最大长度:63

sans

String

CSR绑定的附加域名。

最小长度:0

最大长度:255

private_key_algo

String

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

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • EC_P256

  • EC_P384

  • SM2

最小长度:0

最大长度:63

usage

String

CSR用途。取值如下:

  • PERSONAL:个人证书

  • ENTERPRISE:企业证书

最小长度:0

最大长度:255

company_country

String

国家,当“usage”取值为“ENTERPRISE”时,本参数必填。

最小长度:0

最大长度:255

company_province

String

省份,当“usage”取值为“ENTERPRISE”时,本参数必填。

最小长度:0

最大长度:255

company_city

String

城市,当“usage”取值为“ENTERPRISE”时,本参数必填。

最小长度:0

最大长度:255

company_name

String

公司名称,当“usage”取值为“ENTERPRISE”时,本参数必填。

最小长度:0

最大长度:255

create_time

Long

CSR创建时间。

最小值:13

最大值:20

update_time

Long

CSR更新时间。

最小值:13

最大值:20

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

请求示例

{
  "name" : "CSRxxxx",
  "domain_name" : "xxx.com",
  "private_key_algo" : "RSA_2048",
  "usage" : "ENTERPRISE"
}

响应示例

状态码:201

正常返回。

{
  "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
}

状态码:401

认证失败。

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

状态码:403

禁止访问。

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

状态码:500

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

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

状态码

状态码

描述

201

正常返回。

401

认证失败。

403

禁止访问。

404

访问页面未找到。

500

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

错误码

请参见错误码