1. API Description
Domain name for API request: ssl.intl.tencentcloudapi.com.
Submit documentation for paid certificates; This API does not maintain new features, and you can use the new API to submit documentation. CertificateInfoSubmit.
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: SubmitCertificateInformation. |
| 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. |
| CertificateId |
Yes |
String |
Paid certificate id of materials to be submitted. |
| CsrType |
No |
String |
This field is required. Generation method of CSR, valid values are:
online: tencent cloud generates the CSR and private key based on the submitted parameter information and stores them encryptedly.
parse: generate the CSR and private key by itself, and apply for a certificate by uploading the CSR. |
| CsrContent |
No |
String |
The content of the uploaded csr.
If CsrType is parse, this field is required. |
| CertificateDomain |
No |
String |
The common name bound to the certificate. if a CSR is uploaded, the domain name must be consistent with the common name resolved from the CSR. |
| DomainList.N |
No |
Array of String |
Other domain names bound to the certificate. not required for single domain and wildcard domain certificates. required for multiple domain names and multiple wildcard domain names. |
| KeyPassword |
No |
String |
Private key password, which is currently only used for the password when generating jks and pfx format certificates; other formats of private key certificates are not encrypted. |
| OrganizationName |
No |
String |
This field is required. Company name. |
| OrganizationDivision |
No |
String |
This field is required. Department name. |
| OrganizationAddress |
No |
String |
This field is required. Company's detailed address. |
| OrganizationCountry |
No |
String |
This field is required.Country name such as CN. |
| OrganizationCity |
No |
String |
This field is required, which specifies the city where the company is located. |
| OrganizationRegion |
No |
String |
This field is required, specifying the province where the company is located. |
| PostalCode |
No |
String |
Postal code of the organization |
| PhoneAreaCode |
No |
String |
This field is required, the company's fixed-line phone area code. |
| PhoneNumber |
No |
String |
This field is required, the company's landline number. |
| VerifyType |
No |
String |
Certificate validation method. Validation types: DNS_AUTO = Automatic DNS validation (only supported for domains resolved by Tencent Cloud DNS with a normal resolution status), DNS = Manual DNS validation, FILE = File validation. |
| AdminFirstName |
No |
String |
This field is required, manager name. |
| AdminLastName |
No |
String |
This field is required, the manager's surname. |
| AdminPhoneNum |
No |
String |
This field is required, the manager's mobile phone number. |
| AdminEmail |
No |
String |
This field is required, the manager's email address. |
| AdminPosition |
No |
String |
This field is required, the manager position. |
| ContactFirstName |
No |
String |
This field is required, the contact person name. |
| ContactLastName |
No |
String |
This field is required, the contact person's surname. |
| ContactEmail |
No |
String |
This field is required, the contact person's email address. |
| ContactNumber |
No |
String |
This field is required, the contact person's mobile phone number. |
| ContactPosition |
No |
String |
This field is required, the contact person position. |
| IsDV |
No |
Boolean |
Indicates whether it is a dv certificate. default value is false. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| CertificateId |
String |
Certificate ID |
| 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 Payment Certificate Submission Materials
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitCertificateInformation
<Common request parameters>
{
"CertificateId": "abcb1234",
"CsrType": "online",
"CertificateDomain": "*.test-dq342da.com",
"OrganizationName": "Tencent",
"OrganizationDivision": "Qcloud",
OrganizationAddress: "No. 1000, Tencent Building, Nanshan District"
"OrganizationCountry": "CN",
"OrganizationCity": "Shenzhen"
"OrganizationRegion": "Guangdong Province"
"PhoneAreaCode": "0755",
"PhoneNumber": "86013388",
"AdminFirstName": "luke",
"AdminLastName": "sky",
"AdminPhoneNum": "12345678901",
"AdminEmail": "test@tencent.com",
"AdminPosition": "developer",
"ContactFirstName": "luke",
"ContactLastName": "sky",
"ContactEmail": "test@tencent.com",
"ContactNumber": "12345678901",
"ContactPosition": "developer"
}
Output Example
{
"Response": {
"CertificateId": "heys**hsj",
"RequestId": "9b397ac6-7d01-4fbc-8acc-52dd6ff0877b"
}
}
Example2 Upload CSR For Pay-As-You-Go Certificate Submission
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitCertificateInformation
<Common request parameters>
{
"CertificateId": "LrmeMvQr",
"CsrType": "parse",
"CsrContent": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC5zCCAc8CAQAweTELMAkGA1UEBhMCQ04xEjAQBgNVBAgMCea5luWNl+ecgTES\nMBAGA1UEBwwJ6ZW/5rKZ5biCMRswGQYDVQQKDBLohb7orq/kupFTU0zor4HkuaYx\nDzANBgNVBAsMBueglOWPkTEUMBIGA1UEAxMLdGVuY2VudC5jb20wggEiMA0GCSqG\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDWACnWh6gA1dGDi/pJtGZtp/Wp4ou6//JM\nEu4OpXQ5t/afvX4xPGm7laWE4aFItZpfhXc1SGVwOBwWsOArw9xwmdCDFY3Icbu9\n8O1mIAIYfMDuc8bWL5lQfuyBeGJw+9i++E/1SkYnx3sRD+vMNlJdkaueWW4qXVo+\nZnE7FX/6Mqi1PE53ccXU55iviLHAaSnztpmUmF4vcKIVbDTsI2TF1raHwdnmvQFx\nvifh7h49xRz3Jj3QWCJqdtGKAktFzofDCYPKcIKT4A52u7WsoBspLIds1H93dITD\nVxnZaE3oe4sHfQpnlHRbO72Cz1QEgGBQeOW/wH8/WygFiRIWHwZpAgMBAAGgKTAn\nBgkqhkiG9w0BCQ4xGjAYMBYGA1UdEQQPMA2CC3RlbmNlbnQuY29tMA0GCSqGSIb3\nDQEBCwUAA4IBAQAcr+Wy3uqr+PL+uUMwd1scB7x27/j2JDXTKBdZnsLnaEFCzz2f\ny4aqN7hWLHNEoqGGNSg5luKO6DCFXOnzu6/bI4Ziy/w003RD1wMPinpo0C0YIzwM\nW99sDPoI1qIxAoNEVLOP11EnPPdlq/D7T4UOMjPxjYSo4Ge2BcG5Bk1zTu/O8She\nxHc6lEWniExaYomIboULnLTdSI1Dx0g7segNMvhLGUjRyump3/0jANfk7qbS0Nnz\n6Q/i0NmiqUiA38iTdIBY57QAJBbXiJJ3HRF5wZyJESobTr9dHPuZH4ebJvfSaNBp\n4KqzUxjAe5GZJs/z5EuJkG/LC/h1L3rFT7AS\n-----END CERTIFICATE REQUEST-----\n",
"CertificateDomain": "tencent.com",
"OrganizationName": "Tencent Cloud SSL Certificate Test"
"OrganizationDivision": "Qcloud",
OrganizationAddress: "No. 1000, Tencent Building, Nanshan District"
"OrganizationCountry": "CN",
"OrganizationCity": "Shenzhen"
"OrganizationRegion": "Guangdong Province"
"PhoneAreaCode": "0755",
"PhoneNumber": "86013388",
"AdminFirstName": "luke",
"AdminLastName": "sky",
"AdminPhoneNum": "12345678901",
"AdminEmail": "test@tencent.com",
"AdminPosition": "developer",
"ContactFirstName": "luke",
"ContactLastName": "sky",
"ContactEmail": "test@tencent.com",
"ContactNumber": "12345678901",
"ContactPosition": "developer"
}
Output Example
{
"Response": {
"CertificateId": "jhsy**jsj",
"RequestId": "9b397ac6-7d01-4fbc-8acc-52dd6ff0877b"
}
}
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.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.NoProjectPermission |
You do not have the permission to operate on this project. |
| FailedOperation.NoRealNameAuth |
You have not completed the identity verification. |
| InternalError |
Internal error. |