Purchases, applies for, and issues a domain validated (DV) certificate by using extended certificate services.
Operation description
- You can call this operation to apply for only DV certificates. If you want to apply for an organization validated (OV) or extended validation (EV) certificate, we recommend that you call the CreateCertificateForPackageRequest operation. This operation allows you to apply for certificates of all specifications and specify the method to generate a certificate signing request (CSR) file.
- Before you call this operation, make sure that you have purchased a certificate resource plan of the required specifications. For more information about how to purchase a certificate resource plan, see Purchase a certificate resource plan. You can call the DescribePackageState operation to query the usage of a certificate resource plan of specified specifications, including the total number of certificate resource plans that you purchase, the number of certificate applications that you submit, and the number of certificates that are issued.
- When you call this operation, you can use the ProductCode parameter to specify the specifications of the certificate.
- After you call this operation to submit a certificate application, Certificate Management Service automatically creates a CSR file for your application and consumes the certificate quota in the certificate resource plans of the specified specifications that you purchased. After you call this operation, you also need to call the DescribeCertificateState operation to obtain the information that is required to complete domain name verification, and manually complete the verification. If you use the DNS verification method, you must complete the verification on the management platform of the domain name. If you use the file verification method, you must complete the verification on your DNS server. Then, the certificate authority (CA) will review your certificate application.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
yundun-cert:CreateCertificateRequest | create | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ProductCode | string | No | The specifications of the certificate. Valid values:
| symantec-free-1-free |
Username | string | Yes | The name of the applicant. | Tom |
Phone | string | Yes | The phone number of the applicant. | 1390000**** |
string | Yes | The contact email address of the applicant. | username@example.com | |
Domain | string | Yes | The domain name that you want to bind to the certificate. You can specify only one domain name. Note
The domain name must match the certificate specifications that you specify for the ProductCode parameter. If you apply for a single-domain certificate, you must specify a single domain name for this parameter. If you apply for a wildcard certificate, you must specify a wildcard domain name such as *.aliyundoc.com for this parameter.
| www.aliyundoc.com |
ValidateType | string | Yes | The method to verify the ownership of a domain name. Valid values:
For more information about the verification methods, see Verify the ownership of a domain name. | DNS |
Tags | array<object> | No | The tags. | |
object | No | The tags. | ||
Key | string | No | The tag key of the resource. You can specify up to 20 tag keys. You cannot specify empty strings as tag keys. The key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with Note
You must specify at least one of Tag.N (Tag.N.Key and Tag.N.Value).
| acs:rm:rgId |
Value | string | No | The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value cannot exceed 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with | test |
Response parameters
Examples
Sample success responses
JSON
format
{
"OrderId": 98987582437920960,
"RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-09-20 | API Description Update | View Change Details |