华为云用户手册

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

请求示例 导入CA证书，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。 POST https://{Endpoint}/v1/private-certificate-authorities/4c0e772e-a30c-4029-b929-b7acb04143f7/import { "certificate" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE-----", "certificate_chain" : "-----BEGIN CERTIFICATE-----**********-----END CERTIFICATE-----" }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：32 最大长度：2097152 表3 请求Body参数 参数 是否必选 参数类型 描述 certificate 是 String 证书内容。 最小长度：1 最大长度：32768 certificate_chain 否 String 证书链内容。 最小长度：0 最大长度：2097152

响应示例 状态码： 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 请求已成功 { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "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" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 tags Array of DomainTags objects 标签列表。 数组长度：1 - 20 表3 DomainTags 参数 参数类型 描述 key String 标签键。可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : = + - @ 最小长度：1 最大长度：128 values Array of strings 标签值列表。每个值可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : = + - @ 最小长度：0 最大长度：255 数组长度：1 - 20 状态码： 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

响应示例 状态码： 200 请求已成功 { "total" : 2, "obs_buckets" : [ { "create_time" : 1554867690718, "bucket_name" : "admin1" }, { "create_time" : 1554949519646, "bucket_name" : "admin3" } ] } 状态码： 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参数 参数 参数类型 描述 total Integer OBS桶总数。 obs_buckets Array of ObsBuckets objects OBS桶列表，详情请参见ObsBuckets字段数据结构说明。 数组长度：0 - 256 表3 ObsBuckets 参数 参数类型 描述 bucket_name String 桶名称。 最小长度：3 最大长度：63 create_time Long 创建时间,格式为时间戳（毫秒级）。 状态码： 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

响应示例 状态码： 200 请求已成功 { "total" : 2, "certificate_authorities" : [ { "signature_algorithm" : "SHA384", "issuer_id" : null, "issuer_name" : null, "not_after" : 1678159435000, "not_before" : 1646623375000, "status" : "ACTIVED", "freeze_flag" : 0, "gen_mode" : "GENERATE", "serial_number" : "202203070322544291829058", "distinguished_name" : { "country" : "cn", "state" : "shanghai", "locality" : "shanghai", "organization" : "shanghai", "organizational_unit" : "shanghai", "common_name" : " CS R_123" }, "key_algorithm" : "EC384", "create_time" : 1646623375000, "delete_time" : null, "ca_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcbe", "type" : "ROOT", "path_length" : 7, "crl_configuration" : { "enabled" : false, "obs_bucket_name" : null, "valid_days" : null, "crl_name" : null, "crl_dis_point" : null } }, { "signature_algorithm" : "SHA256", "issuer_id" : null, "issuer_name" : null, "not_after" : 1727492412000, "not_before" : 1632797952000, "status" : "ACTIVED", "freeze_flag" : 0, "gen_mode" : "GENERATE", "serial_number" : "202109280259122080649087", "distinguished_name" : { "country" : "CN", "state" : "Sichuan", "locality" : "Chengdu", "organization" : "TestA", "organizational_unit" : "CloudBU", "common_name" : "pca-ca" }, "key_algorithm" : "RSA2048", "create_time" : 1632797953000, "delete_time" : null, "ca_id" : "fb7bd6a6-6a11-4a58-8710-a3c0a620aedc", "type" : "ROOT", "path_length" : 7, "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参数 参数 参数类型 描述 total Integer CA证书总数。 certificate_authorities Array of CertificateAuthorities objects CA列表，详情请参见CertificateAuthorities字段数据结构说明。 表4 CertificateAuthorities 参数 参数类型 描述 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 : 按需。 表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 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 表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-certificate-authorities 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定查询返回记录条数，默认值10。 最小值：0 最大值：1000 name 否 String CA证书名称（CN）过滤值，用于获取名称中带有特定值的CA证书集合。 最小长度：1 最大长度：64 offset 否 Integer 索引位置，从offset指定的下一条数据开始查询。默认值为0。 最小值：0 status 否 String CA证书状态，通过状态过滤证书集合： PENDING : 待激活，此状态下，不可用于签发证书； ACTIVED : 已激活，此状态下，可用于签发证书； DISABLED : 已禁用，此状态下，不可用于签发证书； DELETED : 计划删除，此状态下，不可用于签发证书； EXPIRED : 已过期，此状态下，不可用于签发证书。 type 否 String CA证书类型： ROOT : 根CA证书 SUBORDINATE : 从属CA证书 sort_key 否 String 排序属性，目前支持以下属性： create_time : 证书创建时间（默认） common_name : 证书名称 type : CA证书类型 not_after : 证书到期时间 sort_dir 否 String 排序方向，支持以下值： DESC : 降序（默认） ASC : 升序

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

请求示例 解析CSR，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。 POST https://{Endpoint}/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" : "TestA", "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" }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：32 最大长度：2097152 表2 请求Body参数 参数 是否必选 参数类型 描述 csr 是 String 证书签名请求。请使用“\r\n”或“\n”替代证书签名请求中的换行符，若通过console端请求此接口，则无需做符号转换。 最大长度：5120

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：32 最大长度：2097152 表3 请求Body参数 参数 是否必选 参数类型 描述 reason 否 String 吊销理由，支持以下选项： UNSPECIFIED : 吊销时未指定吊销原因，为默认值； KEY_COMPROMISE : 证书密钥材料泄露； CERTIFICATE_AUTHORITY_COMPROMISE : 颁发路径上，可能存在CA密钥材料泄露； AFFILIATION_CHANGED : 证书中的主体或其他信息已经被改变； SUPERSEDED : 此证书已被取代； CES SATION_OF_OPERATION : 此证书或颁发路径中的实体已停止运营； CERTIFICATE_HOLD : 该证书当前不应被视为有效，预计将来可能会生效； PRIVILEGE_WITHDRAWN : 此证书不再具备其声明的属性的权限； ATTRIBUTE_AUTHORITY_COMPROMISE : 担保此证书属性的机构可能已受到损害。 说明： 当不想填写吊销理由时，请求body体请置为"{}"，否则将会报异常，默认值为UNSPECIFIED。

响应示例 状态码： 200 请求已成功 { "csr" : "-----BEGIN CERTIFICATE REQUEST-----\r\nMIIBUDCB2AIBADBZMRAwDgYDVQQDDAdDU1IsMTIzMQswCQYDVQQGEwJjbjERMA8G\r\nA1UECAwIc2hhbmdoYWkxETAPBgNVBAcMCHNoYW5naGFpMRIwEAYDVQQKDAlzaGFu\r\nZyxoYWkwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQl9M7bK+vys5x9mnfG3783aPRh\r\nP/xqLPKVsRsqniC3vPZvIz9E7SasMfZLrXVK37QWhtAEtgNG7NrQnwiOye0/8VZL\r\nVX7ildM6CZY4SlJYSa6TBUsXyGjOs514fjxbuT6gADAKBggqhkjOPQQDAgNnADBk\r\nAjBlQiPXU7TDDDwxrh+JfZEYgmr61cIQdE5GMozPDYime30zcuMnVrb9i3o/2BW+\r\n0lECMG0QWbAYh0LoqnmAYqlgTKK8nKsxm0xFuTRyfxynWi8BpCvAGx803Qpa8EJV\r\nJTTjcw==\r\n-----END CERTIFICATE REQUEST-----" } 状态码： 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参数 参数 参数类型 描述 csr String 证书签名请求内容，有以下两种情况： 通过API请求本接口，证书签名请求中换行符已使用"\r\n"代替； 通过console端导出证书签名请求，将得到标准的PEM格式的证书签名请求文件。 最小长度：1 最大长度：4096 状态码： 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" }

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

请求示例 根据标签查询CA数量，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。 POST https://{Endpoint}/v1/private-certificate-authorities/resource-instances/count { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }

响应示例 状态码： 200 请求已成功 { "total_count" : 1 } 状态码： 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" }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：32 最大长度：2097152 表2 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of DomainTags objects 标签列表。 最多包含20个key，每个key下面的value最多20个，每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key中values不能重复。结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 数组长度：1 - 20 limit 否 Integer 每页条目数量，取值如下： 10：每页显示10条资源信息。 20：每页显示20条资源信息。 50：每页显示50条资源信息。 最小值：10 最大值：50 缺省值：10 offset 否 Integer 索引位置，偏移量，从offset指定的下一条数据开始查询。 最小值：0 缺省值：0 matches 否 Array of ResourceTag objects 搜索字段。 key为要匹配的字段，如resource_name等。value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。 数组长度：0 - 20 表3 DomainTags 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : = + - @ 最小长度：1 最大长度：128 values 是 Array of strings 标签值列表。 每个值可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : = + - @ 最小长度：0 最大长度：255 数组长度：1 - 20 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : = + - @ 最小长度：1 最大长度：128 value 是 String 标签值。 可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : / = + - @ 最小长度：0 最大长度：255

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 最小值：0 最大值：100 状态码： 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