华为云用户手册

  • 响应示例 状态码:401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码:403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码:500 请求未完成,服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 响应参数 状态码:401 表3 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码:403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码:500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 请求示例 { "domain" : "www.test.com", "company_name" : "xx公司", "company_province" : "四川", "company_city" : "成都", "applicant_name" : "xx", "applicant_phone" : "12312345678", "applicant_email" : "example@test.com", "csr" : "", "sans" : "", "country" : "CN", "company_unit" : "IT", "contact_name" : "test", "contact_phone" : "12312345678", "contact_email" : "example@test.com", "auto_dns_auth" : false, "agree_privacy_protection" : true }
  • 响应示例 状态码:200 正常返回。 { "request_info" : "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参数 参数 是否必选 参数类型 描述 domain 是 String 该证书绑定的 域名 。 当购买的证书为“单域名”或“泛域名”类型的证书时,请直接填写单域名或泛域名即可。 当购买的证书为“多域名”类型的证书时,需要选择1个域名作为主域名。 示例:www.example.com 最小长度:0 最大长度:255 sans 否 String 绑定多域名类型证书的附加域名。 当购买的证书为“多域名”类型的证书,且有可增加附加域名的额度时,才需要设置该值。 多个域名需要以“;”隔开。 示例:www.example.com;www.example1.com;www.example2.com 最小长度:0 最大长度:4096 csr 否 String 证书 CS R串,与域名必须匹配。 最小长度:0 最大长度:5120 company_name 否 String 公司名称,OV和EV型证书必填。字符长度为0~63位。 最小长度:0 最大长度:63 company_unit 否 String 部门名称。字符长度为0~63位。 最小长度:0 最大长度:63 company_province 否 String 公司所在省份,OV和EV型证书必填。字符长度为0~63位。 最小长度:0 最大长度:63 company_city 否 String 公司所在市区,OV和EV型证书必填。字符长度为0~63位。 最小长度:0 最大长度:63 country 否 String OV和EV型证书必填,国家编码,需符合正则"[A-Za-z]{2}"。 最小长度:2 最大长度:2 applicant_name 是 String 申请人的姓名。请输入中文、英文字符,下划线,中划线,英文逗号,英文句点,且长度为4到100字节。 最小长度:0 最大长度:63 applicant_phone 是 String 申请人的电话号码。示例:13212345678 最小长度:0 最大长度:63 applicant_email 是 String 申请人的邮箱。示例:example@huawei.com 最小长度:0 最大长度:256 contact_name 否 String 技术联系人的姓名。字符长度为0~63位。 最小长度:0 最大长度:63 contact_phone 否 String 技术联系人的电话号码。示例:13212345678 最小长度:0 最大长度:63 contact_email 否 String 技术联系人的邮箱。示例:example@huawei.com 最小长度:0 最大长度:256 auto_dns_auth 否 Boolean 是否将DNS验证信息推送到华为云解析服务。 true:推送。 false:不推送。 agree_privacy_protection 是 Boolean 是否同意授权隐私协议。此处仅能设置为true才能成功申请证书。 true:同意隐私协议。 false:不同意隐私协议。 domain_method 是 String 域名验证方式。 DNS:DNS验证,指在域名管理平台通过解析指定的DNS记录,验证域名所有权。 FILE:文件验证,指通过在服务器上创建指定文件的方式来验证域名所有权。 EMAIL:邮箱验证,指登录域名管理员邮箱,接收域名确认邮件并根据提示进行操作来验证域名所有权。 DV域名型和DV基础版证书(GeoTrust入门级SSL证书和DigiCert 免费SSL证书 )默认通过“DNS验证”方式进行验证。 纯IP(公网IP)的证书仅支持通过“文件验证”方式进行验证,且仅纯IP证书支持“文件验证”方式验证。 最小长度:0 最大长度:32 key_algorithm 否 String 密钥算法。默认RSA_2048 最小长度:0 最大长度:32
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 request_info String 请求结果。 最小长度:0 最大长度:63 状态码: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 正常返回。 { "results" : [ { "certificate_id" : "scs1665472591541", "total_num" : 1, "deployed_resources" : [ { "service" : "ELB", "resource_num" : 1, "resource_location" : "region", "region_resources" : [ { "region_id" : "cn-north-7", "is_error" : false, "resources" : [ { "resource_id" : "d93c9fe40959468eb2baf32590a1140a", "resource_name" : "xxxx" } ] } ] } ] } ] } 状态码:401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码:403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码:500 请求未完成,服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 表2 请求Body参数 参数 是否必选 参数类型 描述 certificate_ids 是 Array of strings 证书ID列表。 最小长度:16 最大长度:16 数组长度:1 - 50 service_names 是 Array of strings 服务名称列表。 WAF:查询证书关联 Web应用防火墙 的资源。 CDN:查询证书关联内容分发网络的资源。 ELB:查询证书关联弹性负载均衡(经典型)的资源。 ALL:查询证书以上四种服务的资源。 最小长度:0 最大长度:5 数组长度:1 - 50
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 results Array of ResultDetail objects 请求结果列表,详情请参见ResultDetail字段数据结构说明。 数组长度:1 - 50 表4 ResultDetail 参数 参数类型 描述 certificate_id String 证书ID。 最小长度:16 最大长度:16 total_num Integer 当前证书在所查询服务中已部署资源总数。 最小值:0 最大值:1000 deployed_resources Array of DeployedResourceDetail objects 当前证书已部署资源列表,详情请参见DeployedResourceDetail字段数据结构说明。 数组长度:0 - 100 表5 DeployedResourceDetail 参数 参数类型 描述 service String 证书已部署资源服务名称。 WAF:证书关联Web应用防火墙的资源。 CDN:证书关联内容分发网络的资源。 ELB:证书关联弹性负载均衡(经典型)的资源。 最小长度:0 最大长度:5 resource_num Integer 证书在当前服务已部署资源数量。 最小值:0 最大值:1000 resource_location String 全局服务或Region级服务。 最小长度:0 最大长度:63 region_resources Array of RegionResourceDetail objects 局点资源列表,详情请参见RegionResourceDetail字段数据结构说明。 数组长度:0 - 100 表6 RegionResourceDetail 参数 参数类型 描述 region_id String 局点ID。当服务为全局服务时,region_id为global,其余按照IAM的标准命名。 最小长度:0 最大长度:63 is_error Boolean 请求当前region资源信息过程中,响应是否存在异常的标志。 true : 存在异常,当前region所统计数据不准确 false: 无异常,当前region所统计数据准确 resources Array of ResourceDetail objects 资源集合,每个资源的标识:资源ID + “:” + 资源名称,详情请参见ResourceDetail字段数据结构说明。 数组长度:0 - 100 表7 ResourceDetail 参数 参数类型 描述 resource_id String 资源ID。 最小长度:0 最大长度:63 resource_name String 资源名称。 最小长度:0 最大长度:63 状态码: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 状态码:500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应参数 状态码: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" }
  • 请求参数 表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 表5 响应Body参数 参数 参数类型 描述 desc String 请求结果。 最小长度:0 最大长度:63 状态码: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 正常返回。 { "desc" : "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参数 参数 是否必选 参数类型 描述 action 是 String 标签操作标识。 create:创建。 delete:删除。 最小长度:6 最大长度:6 tags 否 Array of ScsResourceTag objects 标签列表,key和value键值对的集合。 数组长度:1 - 20 表4 ScsResourceTag 参数 是否必选 参数类型 描述 key 否 String 标签键。 最小长度:0 最大长度:128 value 否 String 标签值。 最小长度:0 最大长度:255
  • 响应参数 状态码:401 表3 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码:403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码:500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: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 正常返回。 { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ] } 状态码: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 表2 响应Body参数 参数 参数类型 描述 tags Array of ScsTag objects 标签列表,key和value键值对的集合。 数组长度:1 - 20 表3 ScsTag 参数 参数类型 描述 key String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 values Array of strings 标签值列表。 每个值可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:0 最大长度:255 数组长度:1 - 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 正常返回。 { "total_count" : 1, "resources" : [ { "resource_id" : "scs1664525717891" }, { "resource_detail" : [ { "cert_id" : "scs1664525717891", "cert_name" : "scm-e409cb", "auto_deploy_support" : false, "auto_renew_status" : 0, "cert_brand" : "CFCA", "cert_created_time" : null, "cert_des" : null, "cert_issued_time" : 1664528641000, "cert_type" : "OV_SSL_CERT", "domain" : "www.cfca.com", "domain_num" : 6, "domain_type" : "MULTI_DOMAIN", "enterprise_project_id" : "7c0b1c33-491f-4b87-914a-bb708815b51a", "expired_time" : 1696064641000, "fail_reason" : null, "multi_domain_type" : null, "order_status" : "ISSUED", "origin_cert_id" : null, "partner_order_id" : "TA1664528570549_0573", "purchase_period" : 1, "push_support" : false, "remain_cert_number" : 0, "renewal_cert_id" : null, "resource_id" : null, "sans" : "www.test.com;*.test1.com;*.test2.com;www.test3.com;www.test4.com", "signature_algorithm" : null, "unsubscribe_support" : false, "wildcard_number" : 2 } ] }, { "tags" : [ { "key" : "key1", "value" : "value1" } ] }, { "resource_name" : "scm-e409cb" } ] } 状态码: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参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 true false tags 否 Array of ScsTag objects 标签列表。 包含标签,最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 数组长度:1 - 20 tags_any 否 Array of ScsTag objects 标签列表。 包含任意标签,最多包含20个key,每个key下面的value最多20个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回包含标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。 数组长度:1 - 20 not_tags 否 Array of ScsTag objects 标签列表。 不包含标签,最多包含20个key,每个key下面的value最多20个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回不包含标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。 数组长度:1 - 20 not_tags_any 否 Array of ScsTag objects 标签列表。 不包含任意标签,最多包含20个key,每个key下面的value最多20个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回不包含标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。 数组长度:1 - 20 limit 否 Integer 每页条目数量,取值如下: 10:每页显示10条证书信息。 20:每页显示20条证书信息。 50:每页显示50条证书信息。 最小值:10 最大值:50 缺省值:10 offset 否 Integer 索引位置,偏移量,从offset指定的下一条数据开始查询。 最小值:0 缺省值:0 action 否 String 操作标识(可设置为“filter”或者“count”)。 filter:表示过滤。 count:表示查询总条数。 最小长度:5 最大长度:6 matches 否 Array of ScsMatch objects 搜索字段。 key为要匹配的字段,如resource_name等。value为匹配的值。key为固定字典值,不能包含重复的key或不支持的key。 数组长度:0 - 10 表4 ScsTag 参数 是否必选 参数类型 描述 key 否 String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 values 否 Array of strings 标签值列表。 每个值可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:0 最大长度:255 数组长度:1 - 20 表5 ScsMatch 参数 是否必选 参数类型 描述 key 否 String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value 否 String 标签值。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255
  • 响应参数 状态码:200 表6 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 最小值:0 最大值:100 resources Array of TagResource objects 资源实例列表,详情请参见TagResource字段数据结构说明。 数组长度:0 - 100 表7 TagResource 参数 参数类型 描述 resource_id String 证书的资源ID。 最小长度:0 最大长度:63 tags Array of ScsResourceTag objects 标签列表,没有标签默认为空数组。 数组长度:0 - 100 resource_name String 资源名称,默认为空字符串。 最小长度:0 最大长度:63 resource_detail resource_detail object 证书资源详情。 表8 ScsResourceTag 参数 参数类型 描述 key String 标签键。 最小长度:0 最大长度:128 value String 标签值。 最小长度:0 最大长度:255 表9 resource_detail 参数 参数类型 描述 cert_id String 证书ID。 最小长度:16 最大长度:16 cert_name String 证书名称。字符长度为3~63位。 最小长度:3 最大长度:63 domain String 该证书绑定的域名。 当购买的证书为“单域名”或“泛域名”类型的证书时,请直接填写单域名或泛域名即可。 当购买的证书为“多域名”类型的证书时,需要选择1个域名作为主域名。 示例:www.example.com 最小长度:0 最大长度:255 cert_type String 证书类型。 OV_SSL_CERT:企业型SSL证书。 EV_SSL_CERT:增强型SSL证书。 最小长度:0 最大长度:32 cert_brand String 证书品牌。GLOBALSIGN:GlobalSign品牌。 最小长度:0 最大长度:32 domain_type String 域名类型。 SINGLE_DOMAIN:单域名类型。 MULTI_DOMAIN:多域名类型。 WILDCARD:泛域名类型。 最小长度:0 最大长度:32 purchase_period Integer 证书有效期(年)。 最小值:0 最大值:1000 expired_time String 证书到期时间,毫秒级时间戳。 最小长度:0 最大长度:32 order_status String 订单状态。 最小长度:0 最大长度:32 domain_num Integer 域名数量。 当“domain_type”选择的是“SINGLE_DOMAIN”或“WILDCARD”类型的证书时,域名数量取值为“1”。 当“domain_type”选择的是“MULTI_DOMAIN”类型的证书时,域名数量取值范围为“2~250”。 最小值:1 最大值:250 wildcard_number Integer 泛域名数量。 最小值:1 最大值:100 sans String 证书绑定的附加域名信息。 最小长度:0 最大长度:4096 cert_des String 证书描述。 最小长度:0 最大长度:32 signature_algorithm String 签名算法。 最小长度:0 最大长度:32 fail_reason String 失败原因。 最小长度:0 最大长度:255 partner_order_id String 订单流水号。 最小长度:0 最大长度:63 push_support Boolean 证书是否支持推送。 cert_issued_time String 证书签发时间,毫秒级时间戳。 最小长度:0 最大长度:32 resource_id String 资源id。 最小长度:0 最大长度:63 unsubscribe_support Boolean 证书是否支持退订。 enterprise_project_id String 企业项目ID,默认为“0”。 对于开通企业项目的用户,表示资源处于默认企业项目下。 对于未开通企业项目的用户,表示资源未处于企业项目下。 最小长度:0 最大长度:36 origin_cert_id String 初始证书id。 最小长度:0 最大长度:63 renewal_cert_id String 续费购买证书id。 最小长度:0 最大长度:63 auto_renew_status Integer 自动续费状态。 最小值:0 最大值:100 remain_cert_number Integer 剩余证书有效个数。 最小值:0 最大值:100 auto_deploy_support Boolean 证书是否支持自动部署。 状态码: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 状态码:500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码:200 正常返回。 { "id" : "scs1590053258704", "order_id" : "CS20052117270N7V9", "name" : "scm-testing", "type" : "DV_SSL_CERT", "brand" : "SYMANTEC", "push_support" : "OFF", "revoke_reason" : null, "status" : "CHECKING_DOMAIN", "signature_algorithm" : null, "issue_time" : null, "not_before" : null, "not_after" : null, "validity_period" : 12, "validation_method" : "DNS", "domain_type" : "SINGLE_DOMAIN", "multi_domain_type" : null, "domain" : "hosting-******.test.cn", "sans" : null, "domain_count" : 1, "wildcard_count" : 0, "fingerprint" : "185d687de3f44f2249d0e0f084efccb56b7c2cbe", "enterprise_project_id" : "0", "authentification" : [ { "record_name" : "_dnsauth.hosting-****.test.cn", "record_type" : "TXT", "record_value" : "201801040000001ytm4q************cd8p7eg9ktlwfsord", "domain" : "hosting-*****.test.cn" } ] } 状态码: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 证书id。 最小长度:16 最大长度:16 status String 证书状态。取值如下: PAID:证书已支付,待申请证书。 ISSUED:证书已签发。 CHECKING:证书申请审核中。 CANCELCHECKING:取消证书申请审核中。 UNPASSED:证书申请未通过。 EXPIRED:证书已过期。 REVOKING:证书吊销申请审核中。 REVOKED:证书已吊销。 UPLOAD:证书托管中。 SUPPLEMENTCHECKING:多域名证书新增附加域名审核中。 CANCELSUPPLEMENTING:取消新增附加域名审核中。 最小长度:0 最大长度:32 order_id String 订单id。 最小长度:0 最大长度:63 name String 证书名称。 最小长度:3 最大长度:63 type String 证书类型。取值如下: DV_SSL_CERT、DV_SSL_CERT_BASIC、EV_SSL_CERT、 EV_SSL_CERT_PRO、OV_SSL_CERT、OV_SSL_CERT_PRO。 最小长度:0 最大长度:32 brand String 证书品牌。取值如下: GLOBALSIGN、SYMANTEC、GEOTRUST、CFCA。 最小长度:0 最大长度:32 push_support String 证书是否支持推送。 最小长度:0 最大长度:32 revoke_reason String 证书吊销原因。 最小长度:0 最大长度:255 signature_algorithm String 签名算法。 最小长度:0 最大长度:64 issue_time String 证书签发时间,没有获取到有效值时为空。 最小长度:0 最大长度:32 not_before String 证书生效时间,没有获取到有效值时为空。 最小长度:0 最大长度:32 not_after String 证书失效时间,没有获取到有效值时为空。 最小长度:0 最大长度:32 validity_period Integer 证书有效期,按月为单位。 云证书管理服务 提供了一种购买多年有效期证书的解决方案,这种多年有效期证书生效方式为多张有效期为1年的SSL证书叠加生效,例如:有效期为“3年”的证书实际包含3张有效期为1年且规格相同的SSL证书,在第一张证书到期前30天,系统自动以第一张证书的信息申请第二张证书,在第二张证书到期前30天,系统自动以第一张证书的信息申请第三张证书。 最小值:12 最大值:12 validation_method String 域名认证方式,取值如下:DNS、FILE、EMAIL。 最小长度:0 最大长度:32 domain_type String 域名类型,取值如下: SINGLE_DOMAIN:单域名 WILDCARD:通配符 MULTI_DOMAIN:多域名 最小长度:0 最大长度:32 multi_domain_type String 多域名类型,取值如下: primary_single:主单域名 primary_wildcard:主泛域名 最小长度:0 最大长度:32 domain String 证书绑定域名。 最小长度:0 最大长度:255 sans String 证书绑定的附加域名信息。 最小长度:0 最大长度:4096 domain_count Integer 证书可绑定域名个数。 最小值:1 最大值:100 wildcard_count Integer 证书可绑定附加域名个数。 最小值:0 最大值:99 fingerprint String 证书的SHA-1指纹。 最小长度:40 最大长度:40 shared Boolean 是否是共享资源。 application_info application_info object 证书申请信息。 description String 证书的描述。 最小长度:0 最大长度:255 enterprise_project_id String 企业项目ID,默认为“0”。 对于开通企业项目的用户,表示资源处于默认企业项目下。 对于未开通企业项目的用户,表示资源未处于企业项目下。 最小长度:0 最大长度:36 authentification Array of Authentification objects 域名所有权认证信息,详情请参见Authentification字段数据结构说明。 数组长度:0 - 100 表4 application_info 参数 参数类型 描述 country String 国家。 最小长度:0 最大长度:255 company_name String 公司名称。 最小长度:0 最大长度:255 company_province String 公司省份。 最小长度:0 最大长度:255 company_city String 公司所在城市。 最小长度:0 最大长度:255 applicant_name String 申请人名称。 最小长度:0 最大长度:255 applicant_phone String 申请人电话。 最小长度:0 最大长度:255 applicant_email String 申请人邮箱。 最小长度:0 最大长度:255 contact_name String 技术联系人名称。 最小长度:0 最大长度:255 contact_phone String 技术联系人电话。 最小长度:0 最大长度:255 contact_email String 技术联系人邮箱。 最小长度:0 最大长度:255 表5 Authentification 参数 参数类型 描述 record_name String 域名校验值名字。 最小长度:0 最大长度:255 record_type String 域名校验值类型。 最小长度:0 最大长度:255 record_value String 域名校验值。 最小长度:0 最大长度:255 domain 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 正常返回。 { "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 正常返回。 { "entire_certificate" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE----------BEGIN CERTIFICATE---******----END CERTIFICATE-----", "certificate" : "-----BEGIN CERTIFICATE-----*******-----END CERTIFICATE-----", "certificate_chain" : "-----BEGIN CERTIFICATE-----*******-----END CERTIFICATE-----", "private_key" : "-----BEGIN RSA PRIVATE KEY-----******-----END RSA PRIVATE KEY-----" } 状态码: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 国密证书返回,加密证书私钥。 自己生成csr的方式:该字段是加密状态,需要解密。 非自己生成csr的方式:该字段不需要解密。 解密思路如下: 1、从数字信封中获取“对称密钥密文”和“加密私钥密文”; 2、使用签名私钥解密“对称密钥密文”,得到“对称密钥明文”; 3、使用对称密钥解密“加密私钥密文”,得到“加密私钥明文”。 最小长度: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
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 certificates Array of CertificateDetail objects 证书列表,详情请参见CertificateDetail字段数据结构说明。 数组长度:0 - 1000 total_count Integer 证书数量。 最小值:0 最大值:10000 表4 CertificateDetail 参数 参数类型 描述 id String 证书id。 最小长度:16 最大长度:16 name String 证书名称。 最大值:63 最小长度:3 domain String 证书绑定的域名。 最小长度:1 最大长度:255 sans String 多域名证书绑定的附加域名。 最小长度:1 最大长度:4096 signature_algorithm String 签名算法。 最小长度:0 最大长度:64 deploy_support Boolean 是否支持部署。 type String 证书类型。取值如下: DV_SSL_CERT、DV_SSL_CERT_BASIC、EV_SSL_CERT、 EV_SSL_CERT_PRO、OV_SSL_CERT、OV_SSL_CERT_PRO 最小长度:1 最大长度:128 brand String 证书品牌。取值如下:GLOBALSIGN、SYMANTEC、GEOTRUST、CFCA 最小长度:1 最大长度:255 expire_time String 证书过期时间。 最小长度:1 最大长度:32 domain_type String 域名类型。取值如下: SINGLE_DOMAIN:单域名 WILDCARD:通配符 MULTI_DOMAIN:多域名 最小长度:1 最大长度:128 validity_period Integer 证书有效期,按月为单位。 云证书管理 服务提供了一种购买多年有效期证书的解决方案,这种多年有效期证书生效方式为多张有效期为1年的SSL证书叠加生效,例如:有效期为“3年”的证书实际包含3张有效期为1年且规格相同的SSL证书,在第一张证书到期前30天,系统自动以第一张证书的信息申请第二张证书,在第二张证书到期前30天,系统自动以第一张证书的信息申请第三张证书。 最小值:12 最大值:12 status String 证书状态,取值如下: PAID:证书已支付;待申请证书。 ISSUED:证书已签发。 CHECKING:证书申请审核中。 CANCELCHECKING:取消证书申请审核中。 UNPASSED:证书申请未通过。 EXPIRED:证书已过期。 REVOKING:证书吊销申请审核中。 CANCLEREVOKING:证书取消吊销申请审核中。 REVOKED:证书已吊销。 UPLOAD:证书托管中。 SUPPLEMENTCHECKING:多域名证书新增附加域名审核中。 CANCELSUPPLEMENTING:取消新增附加域名审核中。 最小长度:0 最大长度:64 domain_count Integer 证书可绑定域名个数。 最小值:1 最大值:100 wildcard_count Integer 证书可绑定泛域名个数。 最小值:0 最大值:100 description String 证书描述。 最小长度:0 最大长度:255 domain_id String 账号ID。 最小长度:0 最大长度:100 enterprise_project_id String 企业项目ID,默认为“0”。 对于开通企业项目的用户,表示资源处于默认企业项目下。 对于未开通企业项目的用户,表示资源未处于企业项目下。 最小长度:0 最大长度:36 状态码: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
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全