华为云用户手册

  • 响应参数 状态码: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
  • 请求参数 表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 正常返回。 { "cert_id" : "scsxxxx", "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" }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 cert_id String 证书ID。 最小长度:16 最大长度:16 message String 执行结果。取值如下: success:申请成功。 最小长度:0 最大长度: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
  • 响应示例 状态码: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
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 id String CS R的ID。 最小长度:32 最大长度:32 name String 自定义CSR名称。 最小长度:1 最大长度:63 create_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
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义CSR名称。 最小长度:0 最大长度:63 csr 是 String 证书CSR文件。 最小长度:0 最大长度:2555 private_key 否 String 证书私钥文件。 最小长度:0 最大长度:63
  • 响应示例 状态码:200 正常返回。 { "id" : "474a519e2c884c34a2d01033a6493b3c", "name" : "xxxx", "create_time" : 1685325399000 } 状态码: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 正常返回。 { "csr_list" : [ { "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 } ], "total" : 1 } 状态码:401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码:403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码:500 请求未完成,服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • URI GET /v3/scm/csr 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页条目数量,取值如下: 10:每页显示10条证书信息。 20:每页显示20条证书信息。 50:每页显示50条证书信息。 最小值:10 最大值:50 缺省值:10 offset 否 Integer 偏移量。 最小值:0 最大值:100 缺省值:0 name 否 String csr名称。 最小长度:0 最大长度:32 private_key_algo 否 String 密钥算法的类型。取值如下: RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2 最小长度:0 最大长度:64
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 csr_list Array of CSRResponseBody objects CSR列表,详情请参见CSRResponseBody字段数据结构说明。 数组长度:0 - 1000 total Integer CSR数量。 最小值:0 最大值:10000 表4 CSRResponseBody 参数 参数类型 描述 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 正常返回。 { "failure_list" : [ { "resource" : "982b8a6a6ebc43809d82a46ca99aaeb7", "failure_info" : "ELB.8904:certificate 982b8a6a6ebc43809d82a46ca99aaeb7 does not exist" } ] } 状态码: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参数 参数 是否必选 参数类型 描述 project_name 否 String 部署的资源所在的项目名称,若在主项目下,则该值为region id。 最小长度:1 最大长度:255 service_name 是 String 证书推送的目标服务,当前仅支持:CDN、WAF、ELB。 最小长度:1 最大长度:64 resources 是 Array of DeployedResource objects 所要部署的资源列表。 数组长度:1 - 20 表4 DeployedResource 参数 是否必选 参数类型 描述 id 否 String 资源Id,部署WAF与ELB时,必传此字段。 最小长度:0 最大长度:63 type 否 String 资源类型,当前仅部署WAF资源时需传入,即独享模式(premium)与云模式(cloud)。 最小长度:0 最大长度:63 domain_name 否 String 需部署的域名,当前仅部署CDN时需传入,即需加速的域名,域名与证书必须可匹配。 最小长度:0 最大长度:63 enterprise_project_id 否 String 需部署的资源所属的企业项目ID,当前仅部署WAF资源时,需传入。 最小长度:0 最大长度:63
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 failure_list Array of FaiureResource objects 部署失败的资源列表。 数组长度:1 - 20 表6 FaiureResource 参数 参数类型 描述 resource String 部署失败的资源信息,部署WAF与ELB时,此字段为资源ID,部署CDN时,本字段为加速域名。 最小长度:0 最大长度:63 failure_info String 失败原因,一般为目标服务返回的错误码信息。 最小长度:0 最大长度:255 状态码: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 状态码:500 表9 响应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" }
  • 响应参数 状态码: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 表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
  • 请求示例 { "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 证书CSR串,与域名必须匹配。 最小长度: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 正常返回。 { "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
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFG....”,则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可,如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFG....
  • 响应示例 状态码: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
  • 响应示例 状态码:201 正常返回。 { "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" }
  • 响应参数 状态码:201 表3 响应Body参数 参数 参数类型 描述 id String CSR的ID。 最小长度:0 最大长度:63 name String 自定义CSR名称。 最小长度:0 最大长度:63 domain_name String 域名。 最小长度:0 最大长度:63 sans String CSR绑定的附加域名。 最小长度:0 最大长度:255 private_key_algo String 密钥算法的类型。取值如下 RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2 最小长度:0 最大长度:63 usage String CSR用途。取值如下: PERSONAL:个人证书 ENTERPRISE:企业证书 最小长度:0 最大长度:255 company_country String 国家,当“usage”取值为“ENTERPRISE”时,本参数必填。 最小长度:0 最大长度:255 company_province String 省份,当“usage”取值为“ENTERPRISE”时,本参数必填。 最小长度:0 最大长度:255 company_city String 城市,当“usage”取值为“ENTERPRISE”时,本参数必填。 最小长度:0 最大长度:255 company_name String 公司名称,当“usage”取值为“ENTERPRISE”时,本参数必填。 最小长度:0 最大长度:255 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
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义CSR名称。 最小长度:0 最大长度:63 domain_name 是 String CSR绑定的域名。如果您想在提交证书申请时使用该CSR,必须确保证书绑定域名包含此处设置的域名。 最小长度:0 最大长度:63 sans 否 String CSR绑定的附加域名。 最小长度:0 最大长度:255 private_key_algo 是 String 私钥算法。取值如下: RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2 最小长度:0 最大长度:63 usage 是 String CSR用途。取值如下: PERSONAL:个人证书 ENTERPRISE:企业证书 最小长度:0 最大长度:255 company_country 否 String 国家,当“usage”取值为“ENTERPRISE”时,本参数必填。取值示例:CN。 最小长度:0 最大长度:255 company_province 否 String 省份,当“usage”取值为“ENTERPRISE”时,本参数必填。取值示例:北京市。 最小长度:0 最大长度:255 company_city 否 String 城市。当“usage”取值为“ENTERPRISE”时,本参数必填。取值示例:北京市。 最小长度:0 最大长度:255 company_name 否 String 公司名称。当“usage”取值为“ENTERPRISE”时,本参数必填。 最小长度:0 最大长度:255
共100000条
提示

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