Call CreateCertificateForPackageRequest to submit a certificate application - Certificate Management Service

Submits a certificate application by using a purchased certificate package quota.

Operation description

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.
After you call this operation to submit a certificate application and the certificate is issued, the certificate quota provided by the resource plan that you purchased is consumed. When you call this operation, you can use the ProductCode parameter to specify the specifications of the certificate that you want to apply for.
After you call this operation to submit a certificate application, you also need to call the DescribeCertificateState operation to obtain the information that is required for domain name ownership verification and manually complete the verification. Then, your certificate application is reviewed by the certificate authority (CA). If you use the Domain Name System (DNS) verification method, you must complete the verification on your DNS service provider system. If you use the file verification method, you must complete the verification on the DNS server.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cert:CreateCertificateForPackageRequest

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Csr	string	No	The content of the certificate signing request (CSR) file that is manually generated by using OpenSSL or Keytool for the domain name. The key algorithm in the CSR file must be Rivest-Shamir-Adleman (RSA) or elliptic-curve cryptography (ECC), and the key length of the RSA algorithm must be greater than or equal to 2,048 characters. For more information about how to create a CSR file, see Create a CSR file. If you do not specify this parameter, Certificate Management Service automatically creates a CSR file. A CSR file contains the information about your server and company. When you apply for a certificate, you must submit the CSR file to the CA. The CA signs the CSR file by using the private key of the root certificate and generates a public key file to issue your certificate. Note The CN field in CSR file specifies the domain name that is bound to the certificate. You must include the field in the parameter value.	-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
ProductCode	string	No	The specifications of the certificate that you want to apply for. Valid values: digicert-free-1-free (default): DigiCert single-domain domain validated (DV) certificate, which is free and valid for 3 months. This value is available only on the China site (aliyun.com). 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. symantec-ov-1-personal: DigiCert single-domain organization validated (OV) certificate. symantec-ov-w-personal: DigiCert wildcard OV certificate. geotrust-dv-1-starter: GeoTrust single-domain DV certificate. geotrust-dv-w-starter: GeoTrust wildcard DV certificate. geotrust-ov-1-personal: GeoTrust single-domain OV certificate. geotrust-ov-w-personal: GeoTrust wildcard OV certificate. globalsign-dv-1-personal: GlobalSign single-domain DV certificate. globalsign-dv-w-advanced: GlobalSign wildcard DV certificate. globalsign-ov-1-personal: GlobalSign single-domain OV certificate. globalsign-ov-w-advanced: GlobalSign wildcard OV certificate. cfca-ov-1-personal: China Financial Certification Authority (CFCA) single-domain OV certificate, available only on the China site (aliyun.com). cfca-ev-w-advanced: CFCA wildcard OV certificate, available only on the China site (aliyun.com).	symantec-free-1-free
Username	string	No	The name of the applicant. If you do not specify this parameter, the information about the most recent contact that is added to the Information Management module is used. For more information about how to add a contact to the Information Management module, see Manage contacts.	Tom
Phone	string	No	The contact phone number of the applicant. CA staff can call the phone number to confirm the information in your certificate application. If you do not specify this parameter, the information about the most recent contact that is added to the Information Management module is used. For more information about how to add a contact to the Information Management module, see Manage contacts.	1390000****
Email	string	No	The email address of the applicant. After the CA receives your certificate application, the CA sends a verification email to the email address that you specify. You must log on to the mailbox, open the mail, and complete the verification of the domain name ownership based on the steps that are described in the email. If you do not specify this parameter, the information about the most recent contact that is added to the Information Management module is used. For more information about how to add a contact to the Information Management module, see Manage contacts.	username@example.com
Domain	string	No	The domain name that you want to bind to the certificate. The domain name must meet the following requirements: The domain name must be a single domain name or a wildcard domain name. Example: `.aliyundoc.com`. You can specify multiple domain names. Separate multiple domain names with commas (,). You can specify a maximum of five domain names. If you specify multiple domain names, the domain names must be only single domain names or only wildcard domain names. You cannot specify both single domain names and wildcard domain names. Note* If you want to bind multiple domain names to the certificate, you must specify this parameter. You must specify at least one of the Domain parameter and the Csr parameter. If you specify both the Domain parameter and the Csr parameter, the value of the CN field in the Csr parameter is used as the domain name that is bound to the certificate.	aliyundoc.com
CompanyName	string	No	The company name of the certificate application. Note This parameter is available only when you apply for OV certificates. For more information, see Manage company profiles. If you want to apply for a DV certificate, you do not need to add a company profile. If you specify a company name, the information about the company that is configured in the Information Management module is used. If you do not specify this parameter, the information about the most recent company that is added to the Information Management module is used.	A company
ValidateType	string	No	The verification method of the domain name ownership. 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
Tags	array<object>	No	A list of tags.
	object	No	The tags.
Key	string	No	The tag key.	runtime
Value	string	No	The tag value.	1

Response elements

Element	Type	Description	Example
	object
OrderId	integer	The ID of the certificate application order. Note You can use the ID to query the status of the certificate application order. For more information, see DescribeCertificateState.	2021010
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	5890029B-938A-589E-98B9-3DEC7BA7C400

Examples

Success response

JSON format

{
  "OrderId": 2021010,
  "RequestId": "5890029B-938A-589E-98B9-3DEC7BA7C400"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.