All Products
Search

This Product

    Certificate Management Service:CreateCertificateRequest

    Document Center

    Certificate Management Service:CreateCertificateRequest

    Last Updated:Jul 31, 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

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    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

    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.