All Products
Search
Document Center

Certificate Management Service:CreateCertificateRequest

Last Updated:Dec 23, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cert:CreateCertificateRequestcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductCodestringNo

The specifications of the certificate. Valid values:

  • digicert-free-1-free (default): DigiCert single-domain DV certificate, which is free and valid for 3 months.
  • symantec-free-1-free: DigiCert single-domain DV certificate, which is free and valid for 1 year. This value is available only on the China site (aliyun.com).
  • symantec-dv-1-starter: DigiCert wildcard DV certificate.
  • geotrust-dv-1-starter: GeoTrust single-domain DV certificate.
  • geotrust-dv-w-starter: GeoTrust wildcard DV certificate.
  • globalsign-dv-1-personal: GlobalSign single-domain DV certificate.
  • globalsign-dv-w-advanced: GlobalSign wildcard DV certificate.
symantec-free-1-free
UsernamestringYes

The name of the applicant.

Tom
PhonestringYes

The phone number of the applicant.

1390000****
EmailstringYes

The contact email address of the applicant.

username@example.com
DomainstringYes

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
ValidateTypestringYes

The method to verify the ownership of a domain name. Valid values:

  • DNS: DNS verification. If you use this method, you must add a TXT record to the DNS records of the domain name in the management platform of the domain name. You must have operation permissions on domain name resolution to verify the ownership of the domain name.
  • FILE: file verification. If you use this method, you must create a specified file on the DNS server. You must have administrative rights on the DNS server to verify the ownership of the domain name.

For more information about the verification methods, see Verify the ownership of a domain name.

DNS
Tagsarray<object>No

The tags.

objectNo

The tags.

KeystringNo

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 aliyun or acs:. The key cannot contain http:// or https://.

Note You must specify at least one of Tag.N (Tag.N.Key and Tag.N.Value).
acs:rm:rgId
ValuestringNo

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 aliyun or acs:. The key cannot contain http:// or https://.

test

Response parameters

ParameterTypeDescriptionExample
object
OrderIdlong

The ID of the certificate application order.

Note You can use the ID to query the status of the certificate application. For more information, see DescribeCertificateState .
98987582437920968
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

Examples

Sample success responses

JSONformat

{
  "OrderId": 98987582437920960,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-20API Description UpdateView Change Details