华为云用户手册

  • 响应示例 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,参见:IAM token获取方法。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of ResourceTag objects 标签列表,key和value键值对的集合。 数组长度:1 - 20 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value 是 String 标签值。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 请求示例 批量删除证书标签,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 DELETE https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificates/4c0e772e-a30c-4029-b929-b7acb04143f7/tags/delete { "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
  • 响应示例 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,参见:IAM token获取方法。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of ResourceTag objects 标签列表,key和value键值对的集合。 数组长度:1 - 20 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value 是 String 标签值。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 quotas Quotas object 证书配额,详情请参见Quotas字段数据结构说明。 表3 Quotas 参数 参数类型 描述 support_hsm_cluster Boolean 是否启用加密机集群加密功能。 true false resources Array of Resources objects 资源配额列表,详情请参见Resources字段数据结构说明。 数组长度:0 - 10 表4 Resources 参数 参数类型 描述 type String 证书类型: CERTIFICATE_AUTHORITY: CA证书; CERTIFICATE: 私有证书。 used Integer 已使用配额数。 quota Integer 配额总数: CERTIFICATE_AUTHORITY: 当前系统指定100; CERTIFICATE: 当前系统指定100000。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: 200 请求已成功 { "quotas" : { "resources" : [ { "type" : "CERTIFICATE_AUTHORITY", "used" : 25, "quota" : 100 } ] } } 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 响应示例 状态码: 200 请求已成功 { "certificate_id" : "ae9a326a-b61e-4446-854d-cda30ffe31f5" } 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 请求示例 申请证书,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificates { "key_algorithm" : "RSA2048", "distinguished_name" : { "country" : "CN", "state" : "Sichuan", "locality" : "Chengdu", "organization" : "Huawei", "organizational_unit" : "CloudBU", "common_name" : "TestCert" }, "subject_alternative_names" : [ { "type" : "IP", "value" : "156.127.116.38" } ], "signature_algorithm" : "SHA256", "validity" : { "type" : "YEAR", "value" : 3 }, "issuer_id" : "2cb2878b-6cd1-460d-bd25-afe655159bdc", "key_usages" : [ "digitalSignature", "nonRepudiation" ] }
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 certificate_id String 当前签发的证书ID。 最小长度:36 最大长度:36 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: 200 请求已成功 { "certificate" : "-----BEGIN CERTIFICATE-----\r\n******\r\n-----END CERTIFICATE-----", "certificate_chain" : "-----BEGIN CERTIFICATE-----\r\n******\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\n******\r\n-----END CERTIFICATE-----", "private_key" : "-----BEGIN RSA PRIVATE KEY-----\r\n******\r\n-----END RSA PRIVATE KEY-----\r\n" } 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 private_key String 私钥内容。 certificate String 证书内容。 certificate_chain String 证书链内容。 enc_certificate String 加密证书内容。 enc_private_key String 加密私钥内容。 enc_sm2_enveloped_key String 加密私钥的国密GMT0009标准规范SM2数字信封。 signed_and_enveloped_data String 加密私钥的国密GMT0010标准规范签名数字信封。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 请求示例 导出证书,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificates/6434f74f-2d13-4e6a-89eb-93ee313f1a43/export { "type" : "other", "is_compressed" : false, "password" : "test" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,参见:IAM token获取方法。 表3 请求Body参数 参数 是否必选 参数类型 描述 is_compressed 是 String 是否压缩。 true false type 是 String 根据服务器类型选择下载证书的形式,支持以下五种类型: APACHE : apache服务器推荐使用此参数; NGINX : nginx服务器推荐使用此参数; IIS : windows服务器推荐使用此参数; TOMCAT : tomcat服务器推荐使用此参数; OTHER : 下载PEM格式证书,推荐使用此参数。 is_sm_standard 否 String 是否国密GMT0009标准规范和国密GMT0010标准规范。当证书算法为SM2时传入才有效,若不传入,则默认为false。 true false password 否 String 设置用于加密私钥的密码。支持使用英文大小写字母、数字、特殊字符(例如,.+-_#)等。最大长度为32字节,若不传入,则默认不使用加密导出。
  • 功能介绍 导出证书。 国际算法 选择是否压缩时,分以下两种情况: is_compressed为true时,返回文件压缩包,命名为:证书名称_type字段小写字母.zip,如”test_apache.zip“。 系统生成密钥签发证书 type = "APACHE"时,压缩包中包含三个文件:server.key(密钥文件,内容为PEM格式,若导出证书时设置密码,则为加密后的私钥)、chain.crt(证书链,内容为PEM格式)、server.crt(证书,内容为PEM格式); type = "IIS"时,压缩包中包含两个文件:keystorePass.txt(keystore口令,若导出证书时设置密码,则无此密码文件)、server.pfx(PFX证书,证书与证书链包含在同一个文件); type = "NGINX"时,压缩包中包含两个文件:server.key(密钥文件,内容为PEM格式,若导出证书时设置密码,则为加密后的私钥)、server.crt(内容为PEM格式,证书与证书链包含在同一个文件); type = "TOMCAT"时,压缩包中包含两个文件:keystorePass.txt(keystore口令,若导出证书时设置密码,则无此密码文件)、server.jks(JKX证书,证书与证书链包含在同一个文件); type = "OTHER"时,压缩包中包含三个文件:server.key(密钥文件,内容为PEM格式,若导出证书时设置密码,则为加密后的私钥)、chain.pem(证书链)、server.pem(证书)。 导入CSR签发证书 type = "APACHE"或"IIS"或"TOMCAT"时,压缩包中包含两个文件:chain.crt(证书链,内容为PEM格式)、server.crt(证书,内容为PEM格式); type = "NGINX"时,压缩包中包含一个文件:server.crt(证书,内容为PEM格式); type = "OTHER"时,压缩包中包含两个文件:chain.pem(证书链,内容为PEM格式)、cert.pem(证书,内容为PEM格式)。 is_compressed为false时,返回json格式,返回的具体参数如下: 系统生成密钥签发证书 type = "APACHE"或"NGINX"或"OTHER"时,返回参数如下: certificate(证书内容,PEM格式); certificate_chain(证书链,PEM格式); private_key(证书私钥,PEM格式,若导出证书时设置密码,则为加密后的私钥); type = "IIS"或"TOMCAT"时,暂时未定义。 导入CSR签发证书 type = "APACHE"或"NGINX"或"IIS"或"TOMCAT"或"OTHER"时,返回参数如下: certificate(证书内容,PEM格式); certificate_chain(证书链,PEM格式); 国密算法(中国站) 选择是否压缩和是否国密标准时,分以下四种情况: is_compressed为true、is_sm_standard为true时,返回文件压缩包,命名为:证书名称_type字段小写字母.zip,如”test_apache.zip“。 系统生成密钥签发证书 type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时,暂时未定义; type = "OTHER"时,压缩包中包含五个文件:chain.pem(证书链,内容为PEM格式)、signCert.key(签名证书密钥文件,内容为PEM格式,若导出证书时设置密码,则为加密后的私钥)、signCert.pem(签名证书,内容为PEM格式)、encSm2EnvelopedKey.key(加密证书的国密GMT0009标准规范数字信封文件,内容为BASE64编码)、signedAndEnvelopedData.key(加密证书的国密GMT0010标准规范数字信封文件,内容为BASE64编码)、encCert.pem(加密证书,内容为PEM格式)。 导入CSR签发证书 type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时,暂时未定义; type = "OTHER"时,压缩包中包含四个文件:chain.pem(证书链,内容为PEM格式)、signCert.pem(签名证书,内容为PEM格式)、encSm2EnvelopedKey.key(加密证书的国密GMT0009标准规范数字信封文件,内容为BASE64编码)、signedAndEnvelopedData.key(加密证书的国密GMT0010标准规范数字信封文件,内容为BASE64编码)、encCert.pem(加密证书,内容为PEM格式)。 is_compressed为true、is_sm_standard为false时,返回文件压缩包,命名为:证书名称_type字段小写字母.zip,如”test_apache.zip“。 系统生成密钥签发证书 type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时,暂时未定义; type = "OTHER"时,压缩包中包含五个文件:chain.pem(证书链,内容为PEM格式)、signCert.key(签名证书密钥文件,内容为PEM格式,若导出证书时设置密码,则为加密后的私钥)、signCert.pem(签名证书,内容为PEM格式)、encCert.key(加密证书密钥文件,内容为PEM格式,若导出证书时设置密码,则为加密后的私钥)、encCert.pem(加密证书,内容为PEM格式)。 导入CSR签发证书 type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时,暂时未定义; type = "OTHER"时,压缩包中包含四个文件:chain.pem(证书链,内容为PEM格式)、signCert.pem(签名证书,内容为PEM格式)、encCert.key(加密证书密钥文件,内容为PEM格式)、encCert.pem(加密证书,内容为PEM格式)。 is_compressed为false、is_sm_standard为true时,返回json格式,返回的具体参数如下: 系统生成密钥签发证书 type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时,暂时未定义; type = "OTHER"时,返回参数如下: certificate_chain(证书链,PEM格式); certificate(签名证书内容,PEM格式); private_key(签名证书私钥,PEM格式,若导出证书时设置密码,则为加密后的私钥); enc_certificate(加密证书内容,PEM格式); enc_sm2_enveloped_key(加密证书的国密GMT0009标准规范数字信封文件,BASE64编码); signed_and_enveloped_data(加密证书的国密GMT0010标准规范数字信封文件,BASE64编码)。 导入CSR签发证书 type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时,暂时未定义; type = "OTHER"时,返回参数如下: certificate_chain(证书链,PEM格式); certificate(签名证书内容,PEM格式); enc_certificate(加密证书内容,PEM格式); enc_sm2_enveloped_key(加密证书的国密GMT0009标准规范数字信封文件,BASE64编码); signed_and_enveloped_data(加密证书的国密GMT0010标准规范数字信封文件,BASE64编码)。 is_compressed为false、is_sm_standard为false时,返回json格式,返回的具体参数如下: 系统生成密钥签发证书 type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时,暂时未定义; type = "OTHER"时,返回参数如下: certificate_chain(证书链,PEM格式); certificate(签名证书内容,PEM格式); private_key(签名证书私钥,PEM格式,若导出证书时设置密码,则为加密后的私钥); enc_certificate(加密证书内容,PEM格式); enc_private_key(加密证书私钥,PEM格式,若导出证书时设置密码,则为加密后的私钥)。 导入CSR签发证书 type = "APACHE"或"IIS"或"NGINX"或"TOMCAT"时,暂时未定义; type = "OTHER"时,返回参数如下: certificate_chain(证书链,PEM格式); certificate(签名证书内容,PEM格式); enc_certificate(加密证书内容,PEM格式); enc_private_key(加密证书私钥,PEM格式)。 只有当证书状态为“已签发”时,可进行导出操作。
  • 响应示例 状态码: 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" }
  • 请求示例 { "name" : "test_cert", "certificate" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE----------BEGIN CERTIFICATE-----**********-----END CERTIFICATE-----", "private_key" : "-----BEGIN RSA PRIVATE KEY-----*********-----END RSA PRIVATE KEY-----" }
  • 请求参数 表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
  • 请求示例 解析CSR,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificates/csr/parse { "csr" : "-----BEGIN CERTIFICATE REQUEST-----\\nMIICyTCCAbECAQAwXjELMAkGA1UEBhMCQ04xEDAOBgNVBAgTB3NpY2hhdW4xEDAO\\nBgNVBAcTB2NoZW5nZHUxCzAJBgNVBAoTAkhXMQswCQYDVQQLEwJJVDERMA8GA1UE\\nAxMIdGVzdC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCZ4q5z\\nxqK/L/FC9x2jESeUW5GB6zS5rVxT0WLTCTv9d1LtWBLsRIinATYTYiP1pNo4/pBq\\nHlM3IiUDkc896CJerYlNzOIjTaV4GjCZvPrxSHU5toJvIDflBsY+gnzbT1ol/y0r\\n3yb9dx7eeF5rPR+U8RTw+Ov/ZNRb+0CY30hrXMdrWjp5dtLGTlr5EFYxlKNOPCkR\\n+6BGyJnC9PWSuqwsykFbgMRkcBaNAxa59dRhMF50pvx2Vs929vFrMi+ofDELUOqz\\n1vyjaEA3pn3AGJGXZgrGNbSfz12ixgGLes4cQD21GCIAWgnBQ7b1ru2V8ImUfyh0\\nyvTEyHJTuFbQ+257AgMBAAGgJjAkBgkqhkiG9w0BCQ4xFzAVMBMGA1UdEQQMMAqC\\nCHRlc3QuY29tMA0GCSqGSIb3DQEBCwUAA4IBAQBKfjZuYsz4s0wb1POIWn41eiAB\\np53qb63QKWILN9z8dLktcdSl3lPfcfPZpXv++QPtn3LR9rJKBawusk6SPXbvOGgS\\n5J+6eM8kVW2O3gHFgoaMcPYVtiO7ekG6o25qx6+Rj84wbFdmpOiCc8AwrLEBwzYV\\np1zaprWQu6PxBulkYPa3FLcntDdi7B67r0YTpxVvo1K7vHYFboDvPz7xG57QIFIM\\nwGd1OegariMT3N8gBOzLZc+jqLpxgo4xoNqBHMo6DEmKLdWdzU4ljpuGK9had99k\\nvQ5vft/Qra3v1uq2lOm/G92b0uA9Y1t2bMHobtAnuXL0HmY9XcLdzpC3f8h8\\n-----END CERTIFICATE REQUEST-----" }
  • 响应示例 状态码: 200 请求已成功 { "distinguished_name" : { "country" : "CN", "state" : "sichuan", "locality" : "chengdu", "organization" : "HW", "organizational_unit" : "IT", "common_name" : "test.com" }, "public_key" : "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAx1EX1JfOXquoFDjVi67T\r\npF4kFwetNnLwC0ZQtOK3fftX4/rkHwdGdsYAalzLz2ltlgbtLJHeKaNnjlqTL8bn\r\n0DVIxww6ZP6VaxpfKXaJ76GxDdvb5kp8yRFUAK8N2YQ0UIcsFoXn2CAx1dOtAaNF\r\nO+HwooRnp6GekZaRSYS2bk4olkQ83/2WkkTGC+tAmjSFG7AIY8jaO5RgX40YGANh\r\nU9UGOo8xCxux8k2dsXRnY+fxRiLWphiT2ij4CYURagETbKuRl9WOI+HFVkmIU/0p\r\n3FWqB0RdrRTEcAC+S5fmW75E85rAMh9f65wa/6eWcM6vlnby4Bbm1mcJdR3olgKJ\r\nUQIDAQAB\r\n-----END PUBLIC KEY-----\r\n", "key_algorithm" : "RSA", "key_algorithm_length" : 2048, "signature_algorithm" : "SHA256withRSA" } 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 key_algorithm String 密钥算法。 key_algorithm_length String 密钥算法长度,单位为bit。 signature_algorithm String 签名算法,带具体的签名与哈希算法,如"SHA256withRSA"。 public_key String 公钥内容。 说明: 其中,换行符已被“\r\n”替代; 最小长度:0 最大长度:4096 distinguished_name DistinguishedName object 证书名称配置,详情请参见DistinguishedName字段数据结构说明。 表4 DistinguishedName 参数 参数类型 描述 common_name String 证书通用名称(CN),名称只能由"-"、"_"、" "、"."、","、"*"、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 country String 国家编码,只能由英文组成,长度为2位字符。 最小长度:2 最大长度:2 state String 省市名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 最小长度:1 最大长度:128 locality String 地区名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 最小长度:1 最大长度:128 organization String 组织名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 organizational_unit String 组织单元名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 quotas Quotas object 证书配额,详情请参见Quotas字段数据结构说明。 表3 Quotas 参数 参数类型 描述 support_hsm_cluster Boolean 是否启用加密机集群加密功能。 true false resources Array of Resources objects 资源配额列表,详情请参见Resources字段数据结构说明。 数组长度:0 - 10 表4 Resources 参数 参数类型 描述 type String 证书类型: CERTIFICATE_AUTHORITY: CA证书; CERTIFICATE: 私有证书。 used Integer 已使用配额数。 quota Integer 配额总数: CERTIFICATE_AUTHORITY: 当前系统指定100; CERTIFICATE: 当前系统指定100000。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: 200 请求已成功 { "quotas" : { "resources" : [ { "type" : "CERTIFICATE", "used" : 25, "quota" : 100000 } ] } } 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 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 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • URI DELETE /v1/private-certificate-authorities/{ca_id} 表1 路径参数 参数 是否必选 参数类型 描述 ca_id 是 String 所要计划删除的CA证书ID。 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 pending_days 否 String 延迟删除时间,单位为”天“, 若用户不输入该字段,默认为30。 最小长度:1 最大长度:2
  • 响应示例 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
共100000条