Apply for a certificate.

Function

This API is used to apply for a certificate.

URI

POST /v3/scm/certificates/{certificate_id}/apply

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
certificate_id	Yes	String	Certificate ID. Minimum: 16 Maximum: 16

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 32 Maximum: 2097152

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
domain	Yes	String	Domain name bound to a certificate. If you purchase a single-domain or wildcard-domain certificate, enter a single domain name or wildcard domain name. If you purchase a multi-domain certificate, you need to select a domain name as the primary domain name. Example: www.example.com Minimum: 0 Maximum: 255
sans	No	String	Additional domain name associated with a multi-domain certificate. This value is required only when the purchased certificate is a multi-domain certificate and the quota of additional domain names can be increased. Use semicolons (;) to separate multiple domain names. Example: www.example.com;www.example1.com;www.example2.com Minimum: 0 Maximum: 4096
csr	No	String	Certificate CSR string, which must match the domain name. Minimum: 0 Maximum: 5120
company_name	No	String	Company name. This parameter is mandatory for OV and EV certificates. The value contains 0 to 63 characters. Minimum: 0 Maximum: 63
company_unit	No	String	Department name. The value contains 0 to 63 characters. Minimum: 0 Maximum: 63
company_province	No	String	Province where the company is located. This parameter is mandatory for OV and EV certificates. The value contains 0 to 63 characters. Minimum: 0 Maximum: 63
company_city	No	String	City where the company is located. This parameter is mandatory for OV and EV certificates. The value contains 0 to 63 characters. Minimum: 0 Maximum: 63
country	No	String	Country code, which is mandatory for OV and EV certificates. The value must comply with the regular expression [A-Za-z]{2}. Minimum: 2 Maximum: 2
applicant_name	Yes	String	Applicant name. Enter 4 to 100 characters. Only letters, digits, underscores (_), hyphens (-), periods (.), brackets, spaces, and commas (,) are allowed. Minimum: 0 Maximum: 63
applicant_phone	Yes	String	Phone number of an applicant. Example: 13212345678 Minimum: 0 Maximum: 63
applicant_email	Yes	String	Email of an applicant. Example: example@huawei.com Minimum: 0 Maximum: 256
contact_name	No	String	Technical contact name. The value contains 0 to 63 characters. Minimum: 0 Maximum: 63
contact_phone	No	String	Phone number of the technical contact. Example: 13212345678 Minimum: 0 Maximum: 63
contact_email	No	String	Email of a technical contact. Example: example@huawei.com Minimum: 0 Maximum: 256
auto_dns_auth	No	Boolean	Whether to push DNS authentication information to Huawei Cloud DNS. true: Push false: No push
agree_privacy_protection	Yes	Boolean	Whether to agree with the privacy agreement. You can submit your certificate application only when this parameter is set to true. true: Agree to the privacy agreement. false: Disagree with the privacy agreement.
domain_method	Yes	String	Domain name verification method. DNS: You need to verify the domain ownership by resolving a specific DNS record on the domain name management platform. File: You need to create a specified file on the server to verify your ownership of the domain. Email: You can click the link and follow the directions in the email to verify ownership of the domain. For DV and basic DV certificates (GeoTrust entry-level SSL certificates and DigiCert free SSL certificates), DNS is supported for verification by default. IP address (public IP address) certificates can be verified only by files. File verification is supported by only IP address certificates. Minimum: 0 Maximum: 32
key_algorithm	No	String	Key algorithm. The default value is RSA_2048. Minimum: 0 Maximum: 32

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_info	String	Request result. Minimum: 0 Maximum: 63

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code returned for an error request. Minimum: 3 Maximum: 36
error_msg	String	Error information returned for an error request. Minimum: 0 Maximum: 1024

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code returned for an error request. Minimum: 3 Maximum: 36
error_msg	String	Error information returned for an error request. Minimum: 0 Maximum: 1024

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code returned for an error request. Minimum: 3 Maximum: 36
error_msg	String	Error information returned for an error request. Minimum: 0 Maximum: 1024

Example Requests

{
  "domain" : "www.test.com",
  "company_name" : "Company XX",
  "company_province" : "Sichuan",
  "company_city" : "Chengdu",
  "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
}

Example Responses

Status code: 200

Normal response.

{
  "request_info" : "success"
}

Status code: 401

Authentication failed.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status code: 403

Access denied.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status code: 500

Failed to complete the request because of an internal server error.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code	Description
200	Normal response.
401	Authentication failed.
403	Access denied.
404	Access page not found.
500	Failed to complete the request because of an internal server error.