Domain name for API request: ssl.tencentcloudapi.com.
This API is used to apply for a free certificate.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: ApplyCertificate. |
| Version | Yes | String | Common parameter. The value used for this API: 2019-12-05. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| DvAuthMethod | Yes | String | Verification type. DNS_AUTO: automatic DNS verification; DNS: manual DNS verification; FILE: verification by file. |
| DomainName | Yes | String | Domain name. |
| ProjectId | No | Integer | Project ID. |
| PackageType | No | String | Certificate type. Currently, the only supported value is 2, which indicates TrustAsia TLS RSA CA. |
| ContactEmail | No | String | Email address. |
| ContactPhone | No | String | Mobile number. |
| ValidityPeriod | No | String | Validity period. The default value is 12 months, which is the only supported value currently. |
| CsrEncryptAlgo | No | String | Encryption algorithm. Only RSA is supported. |
| CsrKeyParameter | No | String | Key pair parameter. Only the 2048-bit key pair is supported. |
| CsrKeyPassword | No | String | CSR encryption password. |
| Alias | No | String | Alias. |
| OldCertificateId | No | String | Original certificate ID, which is used to apply for a new certificate. |
| Parameter Name | Type | Description |
|---|---|---|
| CertificateId | String | Certificate ID. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://ssl.tencentcloudapi.com/?Action=ApplyCertificate
&DomainName=wgc.red
&DvAuthMethod=DNS_AUTO
&<Common request parameters>{
"Response": {
"CertificateId": "a9TsmZkL",
"RequestId": "0b39eaa4-f938-476d-9b26-19fb07b80936"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.AuthError | You do not have permission to perform this operation. |
| FailedOperation.CancelOrderFailed | Failed to cancel the order. |
| FailedOperation.CannotBeDeletedIssued | Failed to delete the certificate because it has been issued. |
| FailedOperation.CannotBeDeletedWithinHour | Free certificates cannot be deleted within 1 hour after being applied for. |
| FailedOperation.CannotGetOrder | Failed to obtain order information. Try again later. |
| FailedOperation.CertificateInvalid | The certificate is invalid. |
| FailedOperation.CertificateMismatch | The certificate and the private key do not match. |
| FailedOperation.CertificateNotFound | The certificate does not exist. |
| FailedOperation.ExceedsFreeLimit | The number of free certificates exceeds the maximum value. |
| FailedOperation.InvalidCertificateStatusCode | The certificate status is incorrect. |
| FailedOperation.InvalidParam | Incorrect parameters. |
| FailedOperation.NetworkError | The CA system is busy. Try again later. |
| FailedOperation.NoProjectPermission | You do not have the permission to operate on this project. |
| FailedOperation.NoRealNameAuth | You have not completed the identity verification. |
| FailedOperation.OrderAlreadyReplaced | This order has already been replaced. |
| FailedOperation.OrderReplaceFailed | Failed to reissue a certificate. |
| InternalError | Internal error. |
Was this page helpful?