华为云用户手册

响应参数 状态码： 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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：32 最大长度：2097152 表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

请求示例 批量删除证书标签，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。 DELETE https://{Endpoint}/v1/private-certificates/4c0e772e-a30c-4029-b929-b7acb04143f7/tags/delete { "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 agency_id String 创建OBS委托，由IAM返回的授权ID。 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 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 状态码： 404 表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 请求已成功 { "agency_id" : "078ade0fc20010004f8fc0034fad529d" } 状态码： 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 表2 响应Body参数 参数 参数类型 描述 agency_id String 创建OBS委托，由IAM返回的授权ID。 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 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 状态码： 404 表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 请求已成功 { "agency_id" : "078ade0fc20010004f8fc0034fad529d" } 状态码： 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 表2 响应Body参数 参数 参数类型 描述 agency_granted String OBS当前的授权结果。 true false 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 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 状态码： 404 表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 请求已成功 { "agency_granted" : "true" } 状态码： 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 请求参数有误。 { "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 表3 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 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 状态码： 404 表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 请求已成功 { "total" : 2, "certificates" : [ { "signature_algorithm" : "SHA256", "issuer_id" : "ef5d84d1-4f52-47d2-b1c8-a91a672487a0", "issuer_name" : "12", "not_after" : 1665539214000, "not_before" : 1634295475000, "status" : "ISSUED", "freeze_flag" : 0, "gen_mode" : "GENERATE", "serial_number" : "202110151057541266081861", "distinguished_name" : { "country" : "cn", "state" : "guizhou", "locality" : "guiyang", "organization" : "TestA", "organizational_unit" : "IT", "common_name" : "test.test.com" }, "key_algorithm" : "RSA4096", "create_time" : 1634295475000, "delete_time" : null, "certificate_id" : "6434f74f-2d13-4e6a-89eb-93ee313f1a43", "enc_cert_info" : { "enc_serial_number" : "2ad6c3e393a95bf13f95" } }, { "signature_algorithm" : "SHA256", "issuer_id" : "ef5d84d1-4f52-47d2-b1c8-a91a672487a0", "issuer_name" : "12", "not_after" : 1665539214000, "not_before" : 1634110315000, "status" : "ISSUED", "freeze_flag" : 0, "gen_mode" : "GENERATE", "serial_number" : "202110130731541908887138", "distinguished_name" : { "country" : "cn", "state" : "sichuan", "locality" : "chengdu", "organization" : "TestA", "organizational_unit" : "HR", "common_name" : "hr.test.com" }, "key_algorithm" : "RSA4096", "create_time" : 1634110316000, "delete_time" : null, "certificate_id" : "1cbb5a52-806b-469c-b182-7446e1851a1c", "enc_cert_info" : { "enc_serial_number" : "448ad305b90e0a266e9" } } ] } 状态码： 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参数 参数 参数类型 描述 total Integer 私有证书总数。 最小值：0 最大值：1000000 certificates Array of Certificates objects 证书列表，详情请参见Certificates字段数据结构说明。 数组长度：0 - 1000 表4 Certificates 参数 参数类型 描述 certificate_id String 私有证书ID。 最小长度：36 最大长度：36 status String 证书状态： ISSUED : 已签发； EXPIRED : 已过期； REVOKED : 已吊销。 issuer_id String 父CA证书ID。 最小长度：36 最大长度：36 issuer_name String 父CA证书名称。 最小长度：1 最大长度：64 key_algorithm String 密钥算法。 signature_algorithm String 签名算法。 freeze_flag Integer 冻结标识: 0 : 非冻结状态； 其它值 : 冻结状态，当前预留。 gen_mode String 证书生成方式： GENERATE : PCA系统生成； IMPORT : 外部导入； CS R : 外部提供CSR，内部CA进行签发，即私钥不在PCA进行托管。 serial_number String 序列号。 最小长度：1 最大长度：64 create_time Long 证书创建时间，格式为时间戳（毫秒级）。 delete_time Long 证书删除时间，格式为时间戳（毫秒级）。 not_before Long 证书创建时间，格式为时间戳（毫秒级）。 not_after Long 证书到期时间，格式为时间戳（毫秒级）。 distinguished_name DistinguishedName object 证书名称配置，详情请参见DistinguishedName字段数据结构说明。 enc_cert_info EncCertInfo object 加密证书信息，详情请参见EncCertInfo字段数据结构说明。 enterprise_project_id String 企业项目ID，默认为“0”。 对于开通企业项目的用户，表示资源处于默认企业项目下。 对于未开通企业项目的用户，表示资源未处于企业项目下。 表5 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 表6 EncCertInfo 参数 参数类型 描述 enc_serial_number String 加密证书序列号。 最小长度：1 最大长度：64 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024

URI GET /v1/private-certificates 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定查询返回记录条数，默认值10。 最小值：0 最大值：1000 name 否 String 私有证书名称，返回名称带有name字段的证书集合。 最小长度：1 最大长度：64 offset 否 Integer 索引位置，从offset指定的下一条数据开始查询。 最小值：0 status 否 String 私有证书状态，通过状态过滤证书集合。 ISSUED : 已签发； REVOKED : 已吊销； EXPIRED : 已过期。 sort_key 否 String 排序属性，目前支持以下属性： create_time : 证书创建时间（默认） common_name : 证书名称 issuer_name : 签发CA名称 not_after : 证书到期时间 sort_dir 否 String 排序方向，支持以下值： DESC : 降序（默认） ASC : 升序

响应示例 状态码： 200 请求已成功 { "signature_algorithm" : "SHA384", "issuer_id" : "928bd666-e879-448a-ab54-82f6ae3d81e0", "issuer_name" : "IT Root CA", "not_after" : 1647567892000, "not_before" : 1645148632000, "status" : "ACTIVED", "freeze_flag" : 0, "gen_mode" : "CSR", "serial_number" : "202202180143522338893611", "distinguished_name" : { "country" : "CN", "state" : "guangdong", "locality" : "shenzhen", "organization" : "TestA", "organizational_unit" : "IT", "common_name" : "IT Root CA" }, "key_algorithm" : "RSA", "create_time" : 1645148633000, "delete_time" : null, "ca_id" : "4c0e772e-a30c-4029-b929-b7acb04143f7", "type" : "SUBORDINATE", "path_length" : 0, "crl_configuration" : { "enabled" : false, "obs_bucket_name" : null, "valid_days" : null, "crl_name" : null, "crl_dis_point" : null } } 状态码： 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参数 参数 参数类型 描述 ca_id String CA证书ID。 最小长度：36 最大长度：36 type String CA类型: ROOT: 根CA SUBORDINATE: 从属CA status String CA证书状态： PENDING : 待激活，此状态下，不可用于签发证书； ACTIVED : 已激活，此状态下，可用于签发证书； DISABLED : 已禁用，此状态下，不可用于签发证书； DELETED : 计划删除，此状态下，不可用于签发证书； EXPIRED : 已过期，此状态下，不可用于签发证书。 path_length Integer CA路径长度。 说明： 注：生成的根CA证书，其路径长度不做限制，但本字段在数据库中统一置为7。从属CA的路径长度在创建时由用户指定，缺省值为0。 最小值：0 最大值：6 issuer_id String 父CA证书ID，即签发此证书的CA证书ID。根CA中，此参数为null。 最小长度：36 最大长度：36 issuer_name String 父CA证书名称。根CA中，此参数为null。 最小长度：1 最大长度：64 key_algorithm String 密钥算法。 signature_algorithm String 签名哈希算法。 freeze_flag Integer 冻结标识: 0 : 非冻结状态； 其它值 : 冻结状态，当前预留。 gen_mode String 证书生成方式： GENERATE : PCA系统生成； IMPORT : 外部导入； CSR : 外部提供CSR，内部CA进行签发，即私钥不在PCA进行托管。 serial_number String 证书序列号。 最小长度：1 最大长度：64 create_time Long 证书创建时间，格式为时间戳（毫秒级）。 delete_time Long 证书删除时间，格式为时间戳（毫秒级）。 not_before Long 证书创建时间，格式为时间戳（毫秒级）。 not_after Long 证书到期时间，格式为时间戳（毫秒级）。 distinguished_name DistinguishedName object 证书名称配置，详情请参见DistinguishedName字段数据结构说明。 crl_configuration ListCrlConfiguration object 证书CRL配置，详情请参见ListCrlConfiguration字段数据结构说明。 enterprise_project_id String 企业项目ID，默认为“0”。 对于开通企业项目的用户，表示资源处于默认企业项目下。 对于未开通企业项目的用户，表示资源未处于企业项目下。 free_quota Integer 免费证书配额。 charging_mode Integer 计费模式: 0 : 包周期； 1 : 按需。 表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 表5 ListCrlConfiguration 参数 参数类型 描述 enabled Boolean 是否启用CRL发布功能。 true false crl_name String 吊销列表文件名称。 说明： 若用户不指定，系统将默认采用当前证书的父CA ID。 obs_bucket_name String OBS桶名称。 valid_days Integer CRL更新周期，单位为"天"。当启用CRL发布功能，为必填项。 最小值：7 最大值：30 crl_dis_point String 吊销列表分发地址，即对应的OBS桶中的CRL文件地址。 说明： 本参数由程序根据crl_name、obs_bucket_name以及OBS地址进行拼接而成。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 unsubscribe_results String 退订结果。 最小长度：0 最大长度：63 状态码： 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

响应示例 状态码： 200 正常返回。 { "unsubscribe_results" : "SUC CES S" } 状态码： 401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码： 403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码： 500 请求未完成，服务器内部异常。 { "error_code" : "SCM.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

请求示例 启用CRL，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。 POST https://{Endpoint}/v1/private-certificate-authorities/4c0e772e-a30c-4029-b929-b7acb04143f7/crl/enable { "crl_name" : "test", "obs_bucket_name" : "test", "valid_days" : 7 }

响应示例 状态码： 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" : "-----BEGIN CERTIFICATE-----\r\nMIIDczCCAlugAwIBAgIKKsxppf9kUcq6dDANBgkqhkiG9w0BAQsFADBOMQowCAYD\r\nVQQDDAE3MQswCQYDVQQGEwJDTjEQMA4GA1UECAwHU2ljaHVhbjEQMA4GA1UEBwwH\r\nQ2hlbmdkdTEPMA0GA1UECgwGSHVhd2VpMB4XDTIxMTAxNDA4NDMxMVoXDTIyMTAx\r\nNDA4NDQxMVowPjELMAkGA1UEAwwCWVUxCzAJBgNVBAYTAmNuMQowCAYDVQQIDAEz\r\nMQowCAYDVQQHDAE0MQowCAYDVQQKDAE1MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A\r\nMIIBCgKCAQEA1NZyv9qhA711c/99lNO80/uSXjoL1kEjljBtJVB7vqkDf0Ejs20A\r\nfQoHEVTuHams9XLvrllu+YTws4QO8hjbnLI9mmerRRJK0pp+tBmCS3ZFoC23c5vz\r\ny+l0t+Yc2JYhvaOFr823Yo0WC2+NB065nIKH6/duoONfD+3c5Ynkib0nBNyDV+DB\r\nhdKM0nrlqI07cNpYDWpfX5IiDL+4Oh+kY1xGLZCObgsXl34zTf6E7bxJ1/iDZjwJ\r\ndpf6OUQONmIcT49993YCrMDisjJ2OwW9e41S7D2xy/1xmPwWwnid1WHOkTfK4cyl\r\n2PHaHh3FTXIGYjVSg3yKfujauVOFpZ9bTwIDAQABo2MwYTAfBgNVHSMEGDAWgBTu\r\nY36JXjwX7XiLcwKtUto8RZa52DAdBgNVHQ4EFgQUyuAS2HonxOWDIPOgPIMFQ9rr\r\nGiMwEgYDVR0TAQH/BAgwBgEB/wIBADALBgNVHQ8EBAMCAYYwDQYJKoZIhvcNAQEL\r\nBQADggEBALea9Hf5iGCfKLpjf30KCBelEgj3ZxLSBOgsn8UkulB62FyUgnne4AmY\r\nuWHY0xjbamIs8Dgt1GtQrfh3kKq2rfjdasFvrQnAQkjn61O16nbCbWS2H+sqy7Ae\r\nTJZWefx1eIAv8XH7g491C5Rb5TGykk/bFm7RvGhr35ri+nIcqiDmjO44zHr1aPvm\r\ns4vA06UQFvlWFY2wiynZ6f+PuvsPraL7kjQVJqsel8TYpZjMWl/hc3VkXEX6gqPm\r\nbzTypaxa63FCETXtXNlsdid/QWX7l/pUtQ2U57mHi+xJNkA8/Spf1y4zH1rANkmw\r\ntBjeKGRphA4LKir3wsbdXRYbBe7POZo=\r\n-----END CERTIFICATE-----", "certificate_chain" : "-----BEGIN CERTIFICATE-----\r\nMIIDczCCAlugAwIBAgIKKsxpOVE4imyq4zANBgkqhkiG9w0BAQsFADBOMQowCAYD\r\nVQQDDAE3MQswCQYDVQQGEwJDTjEQMA4GA1UECAwHU2ljaHVhbjEQMA4GA1UEBwwH\r\nQ2hlbmdkdTEPMA0GA1UECgwGSHVhd2VpMB4XDTIxMTAxMTAyNTIzMVoXDTIyMTAx\r\nMTAyNTMzMVowTjEKMAgGA1UEAwwBNzELMAkGA1UEBhMCQ04xEDAOBgNVBAgMB1Np\r\nY2h1YW4xEDAOBgNVBAcMB0NoZW5nZHUxDzANBgNVBAoMBkh1YXdlaTCCASIwDQYJ\r\nKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMH7+ovgT/xbBfbLAG0yBs9QERnfgdLL\r\n5BFlgjJNP0Ashw2k5EaWq1qDfY6o4AqGfJHjPd2kLy5ZW7Cq6vuqTD3Uj3tX98N2\r\n6T2Na/s1JGmlExX7Udsikv6hsoKmAjrGdDBEs2Jl/2FRnxO8uFnOuSLqvPUvlR7c\r\ndIoDq4WqVyI4sXAoUq7xB8GoTsGLANn8eYHVNsZcSZ9E0qEiWx3WqhPh9Ncto949\r\nVuDVqkQ9QjjFo/yEO6+KhxqyVDWQwdI3UsyzjqGtFzKQksLUQ0AUec4IsK/VWypG\r\nu34jEkaWGv72CmFGoJEK/K/WoXyzKyCmnS3Wcz4ETliRG5fb7aqP56sCAwEAAaNT\r\nMFEwHwYDVR0jBBgwFoAU7mN+iV48F+14i3MCrVLaPEWWudgwHQYDVR0OBBYEFO5j\r\nfolePBfteItzAq1S2jxFlrnYMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQEL\r\nBQADggEBACHJruSBkb8gA0VajkTZWN7QOvUoJPA2TdOmIlnkzxyR5sXkOmsllHLp\r\njzze9LBKbkMl4/ZfWvLUde7wKJJzV208E1c3mf0iZFqRJ0Ms+o/DStVw/ap+98ML\r\n4oevJk2y/bn7IQTL2bvnEi/+iSzmz1CIlnRUyfEWBW2aVFgjrm/ZaFTiEb5jIdzm\r\ns75YNCvIvn3eKp+yOQ8fyG7mKvvn3nlRKfMTv++bLLUh9or/e/phWkUj0gtSyDEn\r\nyOnVuhxyveLwoag27U8THe5E4Ygrrg98v2eGNFyGMmtsXXKNgFSf5FBqvyED9d61\r\nZ86vYp/N2dbauF7uUUaX5RbtFANYFU0=\r\n-----END CERTIFICATE-----" } 状态码： 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://{Endpoint}/v1/private-certificates { "key_algorithm" : "RSA2048", "distinguished_name" : { "country" : "CN", "state" : "Sichuan", "locality" : "Chengdu", "organization" : "TestA", "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 表4 响应Body参数 参数 参数类型 描述 results Array of results objects 部署结果。 数组长度：1 - 10 表5 results 参数 参数类型 描述 project_name String 推送区 域名 称，如cn-north-7。 最小长度：0 最大长度：63 cert_id String 目标证书ID。 最小长度：0 最大长度：255 message String 推送结果。 最小长度：0 最大长度：255 状态码： 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 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024

响应示例 状态码： 200 正常返回。 { "results" : [ { "project_name" : "cn-north-7", "cert_id" : "scs16751254852691", "message" : "success" } ] } 状态码： 401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码： 403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码： 500 请求未完成，服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：32 最大长度：2097152 表3 请求Body参数 参数 是否必选 参数类型 描述 target_projects 是 Array of strings 推送到的目标服务所在的区域，CDN、ELB、WAF。 最小长度：1 最大长度：32 数组长度：1 - 10 target_service 是 String 证书推送的目标服务，当前仅支持：CDN、WAF、ELB。 最小长度：1 最大长度：64

请求示例 导出证书，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。 POST https://{Endpoint}/v1/private-certificates/6434f74f-2d13-4e6a-89eb-93ee313f1a43/export { "type" : "other", "is_compressed" : false, "password" : "test" }

响应示例 状态码： 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" }