申请证书 - ApplyCertificate
功能介绍
申请证书。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v3/scm/certificates/{certificate_id}/apply
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
certificate_id |
是 |
String |
证书id。 最小长度:16 最大长度:16 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
domain |
是 |
String |
该证书绑定的域名。 示例: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验证信息推送到华为云解析服务。 |
|
agree_privacy_protection |
是 |
Boolean |
是否同意授权隐私协议。此处仅能设置为true才能成功申请证书。 |
|
domain_method |
是 |
String |
域名验证方式。 DV域名型和DV基础版证书(GeoTrust入门级SSL证书和DigiCert免费SSL证书)默认通过“DNS验证”方式进行验证。 纯IP(公网IP)的证书仅支持通过“文件验证”方式进行验证,且仅纯IP证书支持“文件验证”方式验证。 最小长度:0 最大长度:32 |
|
key_algorithm |
否 |
String |
密钥算法。默认RSA_2048 最小长度:0 最大长度:32 |
|
ca_hash_algorithm |
否 |
String |
签名算法。 最小长度:0 最大长度:32 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_info |
String |
请求结果。 最小长度:0 最大长度:63 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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,
"domain_method" : "DNS"
}
响应示例
状态码: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"
}
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.scm.v3.region.ScmRegion; import com.huaweicloud.sdk.scm.v3.*; import com.huaweicloud.sdk.scm.v3.model.*; public class ApplyCertificateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); ScmClient client = ScmClient.newBuilder() .withCredential(auth) .withRegion(ScmRegion.valueOf("<YOUR REGION>")) .build(); ApplyCertificateRequest request = new ApplyCertificateRequest(); request.withCertificateId("{certificate_id}"); ApplyCertificateRequestBody body = new ApplyCertificateRequestBody(); body.withDomainMethod("DNS"); body.withAgreePrivacyProtection(true); body.withAutoDnsAuth(false); body.withContactEmail("example@test.com"); body.withContactPhone("12312345678"); body.withContactName("test"); body.withApplicantEmail("example@test.com"); body.withApplicantPhone("12312345678"); body.withApplicantName("xx"); body.withCountry("CN"); body.withCompanyCity("成都"); body.withCompanyProvince("四川"); body.withCompanyUnit("IT"); body.withCompanyName("xx公司"); body.withCsr(""); body.withSans(""); body.withDomain("www.test.com"); request.withBody(body); try { ApplyCertificateResponse response = client.applyCertificate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkscm.v3.region.scm_region import ScmRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkscm.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = ScmClient.new_builder() \ .with_credentials(credentials) \ .with_region(ScmRegion.value_of("<YOUR REGION>")) \ .build() try: request = ApplyCertificateRequest() request.certificate_id = "{certificate_id}" request.body = ApplyCertificateRequestBody( domain_method="DNS", agree_privacy_protection=True, auto_dns_auth=False, contact_email="example@test.com", contact_phone="12312345678", contact_name="test", applicant_email="example@test.com", applicant_phone="12312345678", applicant_name="xx", country="CN", company_city="成都", company_province="四川", company_unit="IT", company_name="xx公司", csr="", sans="", domain="www.test.com" ) response = client.apply_certificate(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" scm "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := scm.NewScmClient( scm.ScmClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ApplyCertificateRequest{} request.CertificateId = "{certificate_id}" autoDnsAuthApplyCertificateRequestBody:= false contactEmailApplyCertificateRequestBody:= "example@test.com" contactPhoneApplyCertificateRequestBody:= "12312345678" contactNameApplyCertificateRequestBody:= "test" countryApplyCertificateRequestBody:= "CN" companyCityApplyCertificateRequestBody:= "成都" companyProvinceApplyCertificateRequestBody:= "四川" companyUnitApplyCertificateRequestBody:= "IT" companyNameApplyCertificateRequestBody:= "xx公司" csrApplyCertificateRequestBody:= "" sansApplyCertificateRequestBody:= "" request.Body = &model.ApplyCertificateRequestBody{ DomainMethod: "DNS", AgreePrivacyProtection: true, AutoDnsAuth: &autoDnsAuthApplyCertificateRequestBody, ContactEmail: &contactEmailApplyCertificateRequestBody, ContactPhone: &contactPhoneApplyCertificateRequestBody, ContactName: &contactNameApplyCertificateRequestBody, ApplicantEmail: "example@test.com", ApplicantPhone: "12312345678", ApplicantName: "xx", Country: &countryApplyCertificateRequestBody, CompanyCity: &companyCityApplyCertificateRequestBody, CompanyProvince: &companyProvinceApplyCertificateRequestBody, CompanyUnit: &companyUnitApplyCertificateRequestBody, CompanyName: &companyNameApplyCertificateRequestBody, Csr: &csrApplyCertificateRequestBody, Sans: &sansApplyCertificateRequestBody, Domain: "www.test.com", } response, err := client.ApplyCertificate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
正常返回。 |
|
401 |
认证失败。 |
|
403 |
禁止访问。 |
|
404 |
访问页面未找到。 |
|
500 |
请求未完成,服务器内部异常。 |
错误码
请参见错误码。