更新时间:2024-05-24 GMT+08:00
分享

导入证书

功能介绍

导入证书到SCM服务管理。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v3/scm/certificates/import

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:32

最大长度:2097152

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

证书名称。字符长度为3~63位, 请输入英文字符,数字,下划线,中划线,英文句点。

最小长度:3

最大长度:63

certificate

String

证书内容,可包含中间证书及根证书。若certificate_chain字段传入证书链,则该字段只取证书本身。回车换行需要使用转义字符\n或者\r\n替换。

最小长度:0

最大长度:4096

certificate_chain

String

证书链,非必填,可通过certificate字段传入。回车换行需要使用转义字符\n或者\r\n替换。

最小长度:0

最大长度:8192

private_key

String

证书私钥。 不能上传带有口令保护的私钥,回车换行需要使用转义字符\n或者\r\n替换。

最小长度:0

最大长度:4096

enterprise_project_id

String

企业多项目ID。用户未开通企业多项目时,不需要输入该字段。 用户开通企业多项目时,查询资源可以输入该字段。 若用户不输入该字段,默认查询租户所有有权限的企业多项目下的资源。 此时“enterprise_project_id”取值为“all”。 若用户输入该字段,取值满足以下任一条件.

取值为“all”

取值为“0”

满足正则匹配:“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”

最小长度:0

最大长度:64

enc_certificate

String

可选参数,国密证书的加密证书内容。回车换行需要使用转义字符\n或者\r\n替换。

最小长度:0

最大长度:4096

enc_private_key

String

可选参数,国密证书的加密私钥。 不能上传带有口令保护的私钥,回车换行需要使用转义字符\n或者\r\n替换。

最小长度:0

最大长度:4096

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

certificate_id

String

证书id。

最小长度:16

最大长度:16

状态码: 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" : "test_cert",
  "certificate" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE----------BEGIN CERTIFICATE-----**********-----END CERTIFICATE-----",
  "private_key" : "-----BEGIN RSA PRIVATE KEY-----*********-----END RSA PRIVATE KEY-----"
}

响应示例

状态码: 200

正常返回。

{
  "certificate_id" : "scs1600313391074"
}

状态码: 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

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

错误码

请参见错误码

相关文档