华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 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”。 对于开通企业项目的用户，表示资源处于默认企业项目下。 对于未开通企业项目的用户，表示资源未处于企业项目下。 表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 EncCertInfo 参数 参数类型 描述 enc_serial_number String 加密证书序列号。 最小长度：1 最大长度：64 状态码： 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

示例 { "domain_name": "huawei.com", "domain_email": null, "record_name": "_dnsauth. huawei.com", "record_value": "202305150000002aurxma1tun2fgzz0jbs9h5lsekf8gloq57mbs78m9jist465m", "record_type": "TXT", "domain_method": "DNS", "applicant_email": "huawei@huawei.com", "auto_dns_auth": true}

响应消息 响应参数 参数 是否必选 参数类型 描述 domain_name 是 String 验证 域名 domain_email 是 String 域名邮箱 record_name 是 String 主机记录 record_value 是 String 记录值 record_type 是 String 记录类型 domain_method 是 String 验证类型 applicant_email 是 String 申请邮箱 auto_dns_auth 是 boolean 是否自动验证

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：32 最大长度：2097152 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String CSR名称。 最小长度：0 最大长度：255

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String CSR的ID。 最小长度：16 最大长度：16 name String CSR名称。 最小长度：3 最大长度：63 csr String CSR内容。 最小长度：3 最大长度：255 domain_name String CSR绑定的域名。 最小长度：1 最大长度：255 sans String CSR绑定的附加域名。 最小长度：1 最大长度：4096 private_key_algo String 密钥算法。 最小长度：0 最大长度：64 usage String CSR用途。 最小长度：0 最大长度：64 company_country String 国家。 最小长度：1 最大长度：128 company_province String 省份。 最小长度：1 最大长度：255 company_city String 城市。 最小长度：1 最大长度：32 company_name String 公司名称。 最小长度：1 最大长度：128 create_time Long CSR创建时间。 最小值：13 最大值：20 update_time Long CSR更新时间。 最小值：13 最大值：20 状态码： 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 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024

响应示例 状态码： 200 正常返回。 { "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"}

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

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

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

响应示例 状态码： 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 正常返回。 { "id" : "48e392628b0f47769e47d91acc7654a5", "name" : "xxxx", "csr" : "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"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String CSR的ID。 最小长度：16 最大长度：16 name String CSR名称。 最小长度：3 最大长度：63 csr String CSR内容。 最小长度：3 最大长度：255 domain_name String CSR绑定的域名。 最小长度：1 最大长度：255 sans String CSR绑定的附加域名。 最小长度：1 最大长度：4096 private_key_algo String 密钥算法。 最小长度：0 最大长度：64 usage String CSR用途。 最小长度：0 最大长度：64 company_country String 国家。 最小长度：1 最大长度：128 company_province String 省份。 最小长度：1 最大长度：255 company_city String 城市。 最小长度：1 最大长度：32 company_name String 公司名称。 最小长度：1 最大长度：128 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

响应参数 状态码： 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, "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 请求已成功 { "total_count" : 1, "resources" : [ { "resource_id" : "806064a8-7478-4657-a8b0-2edc90621235" }, { "resource_name" : "test" }, { "resource_detail" : [ { "ca_id" : "806064a8-7478-4657-a8b0-2edc90621235", "create_time" : 1681436805000, "delete_time" : null, "crl_configuration" : { "enabled" : false, "obs_bucket_name" : null, "valid_days" : null, "crl_name" : null, "crl_dis_point" : null }, "distinguished_name" : { "country" : "CN", "state" : "guangdong", "locality" : "shenzhen", "organization" : "TestA", "organizational_unit" : "IT", "common_name" : "TestA IT Root CA" }, "enc_cert_info" : null, "enterprise_project_id" : "57d71362-6a1a-4f51-8fa9-693bc3c07f43", "freeze_flag" : 0, "gen_mode" : "GENERATE", "issuer_id" : null, "issuer_name" : null, "key_algorithm" : "SM2", "not_before" : 1681436805000, "not_after" : 1713059205000, "path_length" : 7, "serial_number" : "202203070322544291829058", "signature_algorithm" : "SM3", "status" : "ACTIVED", "type" : "ROOT" } ] }, { "tags" : [ { "key" : "key1", "value" : "value1" } ] } ]} 状态码： 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/resource-instances/filter{ "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ]}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 最小值：0 最大值：100 resources Array of TagResource objects 资源实例列表，详情请参见TagResource字段数据结构说明。 数组长度：0 - 100 表6 TagResource 参数 参数类型 描述 resource_id String 资源ID。 最小长度：0 最大长度：63 resource_detail Object 资源详情。 tags Array of ResourceTag objects 标签列表，没有标签默认为空数组。 数组长度：0 - 100 resource_name String 资源名称，默认为空字符串。 最小长度：0 最大长度：63 表7 ResourceTag 参数 参数类型 描述 key String 标签键。 可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : = + - @ 最小长度：1 最大长度：128 value String 标签值。 可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : / = + - @ 最小长度：0 最大长度：255 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024

请求参数 表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 resources Array of TagResource objects 资源实例列表，详情请参见TagResource字段数据结构说明。 数组长度：0 - 100 表6 TagResource 参数 参数类型 描述 resource_id String 资源ID。 最小长度：0 最大长度：63 resource_detail Object 资源详情。 tags Array of ResourceTag objects 标签列表，没有标签默认为空数组。 数组长度：0 - 100 resource_name String 资源名称，默认为空字符串。 最小长度：0 最大长度：63 表7 ResourceTag 参数 参数类型 描述 key String 标签键。 可用 UTF-8 格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : = + - @ 最小长度：1 最大长度：128 value String 标签值。 可用 UTF-8 格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : / = + - @ 最小长度：0 最大长度：255 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024

响应示例 状态码： 200 请求已成功 { "total_count" : 1, "resources" : [ { "resource_id" : "61e1f947-8794-4574-82bd-14fd0cd3af67" }, { "resource_name" : "test" }, { "resource_detail" : [ { "certificate_id" : "61e1f947-8794-4574-82bd-14fd0cd3af67", "create_time" : 1681436805000, "delete_time" : null, "distinguished_name" : { "country" : "CN", "state" : "guangdong", "locality" : "shenzhen", "organization" : "TestA", "organizational_unit" : "IT", "common_name" : "TestA IT Root CA" }, "enc_cert_info" : null, "enterprise_project_id" : "0", "freeze_flag" : 0, "gen_mode" : "GENERATE", "issuer_id" : "93fcdaf2-c094-4f39-9cbc-bcacd0baac48", "issuer_name" : "test", "key_algorithm" : "RSA2048", "not_before" : 1681436805000, "not_after" : 1713059205000, "path_length" : 7, "serial_number" : "202203070322544291829058", "signature_algorithm" : "SHA256", "status" : "ISSUED" } ] }, { "tags" : [ { "key" : "key1", "value" : "value1" } ] } ]} 状态码： 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/resource-instances/filter{ "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ]}

请求参数 表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

示例 如下以上传名称test的证书为例。 请求样例 { "cert_name":"test", "cert":"-----BEGIN CERTIFICATE----- *** -----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY----- *** -----END RSA PRIVATEKEY-----"} 响应样例 { "cert_id": " scs1481110651012"} 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }

请求示例 { "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 duplicate_check 否 Boolean 是否允许上传相同证书。 true：同意上传相同证书议。 false：不同意上传相同证书。 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

响应示例 状态码： 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 表3 响应Body参数 参数 参数类型 描述 entire_certificate String 证书及证书链。 最小长度：1 最大长度：12288 certificate String 证书内容，不包含证书链。 最小长度：1 最大长度：4096 certificate_chain String 证书链。 最小长度：1 最大长度：8192 private_key String 证书私钥。 最小长度：1 最大长度：4096 enc_certificate String 国密证书返回，加密证书内容。 最小长度：1 最大长度：4096 enc_private_key String 国密证书返回，加密证书私钥。 最小长度：1 最大长度：4096 状态码： 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