1. API Description
Domain name for API request: ssl.intl.tencentcloudapi.com.
This API is used to purchase a certificate.
A maximum of 10 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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 Params. The value used for this API: CreateCertificate. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2019-12-05. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| ProductId |
Yes |
Integer |
Certificate product id. 3: securesite ev pro; 4: securesite ev; 5: securesite ov pro; 6: securesite ov; 7: securesite ov wildcard; 8: geotrust ev; 9: geotrust ov; 10: geotrust ov wildcard; 11: trustasia dv multi-domain; 12: trustasia dv wildcard; 13: trustasia ov wildcard d3; 14: trustasia ov d3; 15: trustasia ov multi-domain d3; 16: trustasia ev d3; 17: trustasia ev multi-domain d3; 18: globalsign ov; 19: globalsign ov wildcard; 20: globalsign ev; 21: trustasia ov wildcard multi-domain d3; 22: globalsign ov multi-domain; 23: globalsign ov wildcard multi-domain; 24: globalsign ev multi-domain; 25: wotrus dv; 26: wotrus dv multi-domain; 27: wotrus dv wildcard; 28: wotrus ov; 29: wotrus ov multi-domain; 30: wotrus ov wildcard; 31: wotrus ev; 32: wotrus ev multi-domain; 33: DNSPod sm2 dv; 34: DNSPod sm2 dv multi-domain; 35: DNSPod sm2 dv wildcard; 37: DNSPod sm2 ov; 38: DNSPod sm2 ov multi-domain; 39: DNSPod sm2 ov wildcard; 40: DNSPod sm2 ev; 41: DNSPod sm2 ev multi-domain; 42: trustasia dv wildcard multi-domain; 43: dnspod-ov ssl certificate; 44: dnspod-ov wildcard ssl certificate; 45: dnspod-ov multi-domain ssl certificate; 46: dnspod-ev ssl certificate; 47: dnspod-ev multi-domain ssl certificate; 48: dnspod-dv ssl certificate; 49: dnspod-dv wildcard ssl certificate; 50: dnspod-dv multi-domain ssl certificate; 51: DNSPod (sm2)-ov ssl certificate; 52: DNSPod (sm2)-ov wildcard ssl certificate; 53: DNSPod (sm2)-ov multi-domain ssl certificate; 54: DNSPod (sm2)-dv ssl certificate; 55: DNSPod (sm2)-dv wildcard ssl certificate; 56: DNSPod (sm2)-dv multi-domain ssl certificate; 57: securesite ov pro multi-domain; 58: securesite ov multi-domain; 59: securesite ev pro multi-domain; 60: securesite ev multi-domain; 61: geotrust ev multi-domain. |
| DomainNum |
Yes |
Integer |
Number of domains associated with the certificate |
| TimeSpan |
Yes |
Integer |
Certificate validity period. |
| AutoVoucher |
No |
Integer |
Whether to automatically use vouchers: 1 for yes, 0 for no; the default is 1. |
| Tags.N |
No |
Array of Tags |
Tag, generate tags for certificates. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| CertificateIds |
Array of String |
List of certificate IDs |
| DealIds |
Array of String |
List of order IDs |
| RequestId |
String |
The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Creating a Certificate
Purchase a paid certificate
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCertificate
<Common request parameters>
{
"ProductId": 25,
"DomainNum": 1,
"TimeSpan": 1
}
Output Example
{
"Response": {
"CertificateIds": [
"gf16kv3A"
],
"DealIds": [
"20200923877000003022941"
],
"RequestId": "5a3d8310-3d7e-42d3-923a-b81407fe495e"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
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.CannotGetOrder |
Failed to get order information. Try again later. |
| FailedOperation.InvalidParam |
Incorrect parameters. |
| InternalError |
Internal error. |
| InternalError.BackendResponseError |
An error occurred with the backend service response. |
| InvalidParameter |
The parameter is incorrect. |
| InvalidParameterValue |
Invalid parameter value. |
| MissingParameter |
Missing parameter. |