Domain name for API request: ssl.intl.tencentcloudapi.com.
This API is used to get certificate details.
A maximum of 10 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 Params. The value used for this API: DescribeCertificateDetail. |
| 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 | Certificate ID |
| Parameter Name | Type | Description |
|---|---|---|
| OwnerUin | String | Certificate belonging to user main account uin. Note: this field may return null, indicating that no valid values can be obtained. |
| ProjectId | String | Project ID Note: this field may return null, indicating that no valid values can be obtained. |
| From | String | Certificate source:. trustAsia. upload. wosign. sheca. Note: this field may return null, indicating that no valid values can be obtained. |
| CertificateType | String | Certificate type. CA: client certificate; SVR: server certificateNote: this field may return null, indicating that no valid values can be obtained. |
| PackageType | String | Certificate package type:. null: user uploads a certificate (no package type),. 2: trustasia tls rsa ca,. 3: securesite enhanced enterprise version (ev pro),. 4: securesite enhanced (ev),. 5: securesite enterprise pro (ov pro). 6: securesite enterprise (ov). 7: securesite enterprise (ov) wildcard. 8: geotrust enhanced (ev). 9: geotrust enterprise (ov). 10: geotrust enterprise (ov) wildcard cert. 11: trustasia domain name-based multiple domain names ssl certificate. 12: trustasia domain name-based (dv) wildcard cert. 13: trustasia enterprise wildcard (ov) ssl certificate (d3). 14: trustasia enterprise (ov) ssl certificate (d3). 15: trustasia enterprise multiple domain names (ov) ssl certificate (d3). 16: trustasia enhanced (ev) ssl certificate (d3). 17: trustasia enhanced multiple domain names (ev) ssl certificate (d3). 18: globalsign enterprise (ov) ssl certificate. 19: globalsign enterprise wildcard (ov) ssl certificate. 20: globalsign enhanced (ev) ssl certificate. 21: trustasia enterprise wildcard multiple domain names (ov) ssl certificate (d3). 22: globalsign enterprise multiple domain names (ov) ssl certificate. 23: globalsign enterprise wildcard multiple domain names (ov) ssl certificate. 24: globalsign enhanced multiple domain names (ev) ssl certificate. 25: wotrus domain cert. 26: wotrus multi-domain cert. 27: wotrus wildcard cert. 28: wotrus enterprise cert. 29: wotrus enterprise multi-domain cert. 30: wotrus enterprise wildcard certificate. 31: wotrus enhanced certificate. 32: wotrus enhanced multi-domain name certificate. 33: wotrus-national cryptography domain name certificate. 34: wotrus-national cryptography domain name certificate (multiple domain names). 35: wotrus-national cryptography wildcard certificate. 37: wotrus-national cryptography enterprise certificate. 38: wotrus-national cryptography enterprise certificate (multiple domain names). 39: wotrus-national cryptography enterprise certificate (wildcard). 40: wotrus-national cryptography enhanced certificate. 41: wotrus - national cryptography enhanced certificate (multiple domain names). 42: trustasia - domain name certificate (wildcard multiple domain names). 43: DNSPod - enterprise (ov) ssl certificate. 44: DNSPod - enterprise (ov) wildcard ssl certificate. 45: DNSPod - enterprise (ov) multiple domain names ssl certificate. 46: dnspod-enhanced (ev) ssl certificate. 47: dnspod-enhanced (ev) multiple domain names ssl certificate. 48: dnspod-domain name-based (dv) ssl certificate. 49: dnspod-domain name-based (dv) wildcard ssl certificate. 50: dnspod-domain name-based (dv) multiple domain names ssl certificate. 51: DNSPod (national cryptography) - enterprise (ov) ssl certificate. 52: DNSPod (national cryptography) - enterprise (ov) wildcard ssl certificate. 53: DNSPod (national cryptography) - enterprise (ov) multiple domain names ssl certificate. 54: DNSPod (national cryptography) - domain name-based (dv) ssl certificate. 55: DNSPod (national cryptography) - domain name-based (dv) wildcard ssl certificate. 56: DNSPod (national cryptography) - domain name-based (dv) multiple domain names ssl certificate. 57: securesite enterprise professional version multiple domain names (ov pro). 58: securesite enterprise multiple domain names (ov). 59: securesite enhanced professional version multiple domain names (ev pro). 60: securesite enhanced multiple domain names (ev). 61: geotrust enhanced multiple domain names (ev). 75: securesite enterprise (ov). 76: securesite enterprise (ov) wildcard. 77: securesite enhanced (ev). 78: geotrust enterprise (ov). 79: geotrust enterprise (ov) wildcard. 80: geotrust enhanced (ev). 81: globalsign enterprise (ov) ssl certificate. 82: globalsign enterprise wildcard (ov) ssl certificate. 83: trustasia c1 dv free. 85: globalsign enhanced (ev) ssl certificate. 88: globalsign enterprise wildcard multiple domain names (ov) ssl certificate. 89: globalsign enterprise multiple domain names (ov) ssl certificate. 90: globalsign enhanced multiple domain names (ev) ssl certificate. 91: geotrust enhanced multiple domain names (ev). 92: securesite enterprise ov pro for multiple domain names. 93: securesite enterprise for multiple domain names (ov). 94: securesite ev pro for multiple domain names. 95: securesite ev for multiple domain names. 96: securesite ev pro. 97: securesite enterprise professional edition (ov pro). 98: cfca enterprise (ov) ssl certificate. 99: cfca enterprise multiple domain names (ov) ssl certificate. 100: cfca enterprise wildcard (ov) ssl certificate. 101: cfca enhanced (ev) ssl certificate. Note: this field may return null, indicating that no valid values can be obtained. |
| ProductZhName | String | Certificate product name. Note: this field may return null, indicating that no valid values can be obtained. |
| Domain | String | Certificate binds to a common name domain. Note: this field may return null, indicating that no valid values can be obtained. |
| Alias | String | Alias Note: this field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Certificate status: 0 = under review, 1 = approved, 2 = review failed, 3 = expired, 4 = automatically added dns records, 5 = enterprise certificate, pending document submission, 6 = order cancellation in progress, 7 = canceled, 8 = documents submitted, pending upload of confirmation letter, 9 = certificate revocation in progress, 10 = revoked, 11 = reissue in progress, 12 = pending upload of revocation confirmation letter, 13 = free certificate pending document submission, 14 = certificate has been refunded, 15 = certificate migration in progress. Note: this field may return null, indicating that no valid values can be obtained. |
| StatusMsg | String | Status information. valid values:. //Common status information. PRE-REVIEWING: in prereview. LEGAL-REVIEWING: in legal review. CA-REVIEWING: in ca review. PENDING-DCV: in domain verification. WAIT-ISSUE: waiting for issue (domain verification passed). Certificate review failure status information. 1. order review failed. 2. ca review failed, and the domain name did not pass the security review. 3. domain name verification timed out, and the order was automatically closed. please reapply for the certificate. 4. the certificate information did not pass the review of the certificate ca agency. the reviewer will call the contact information reserved for the certificate. please pay attention to the incoming call. subsequently, you can resubmit the information through "modify information". To be continuously improved. Note: this field may return null, indicating that no valid values can be obtained. |
| VerifyType | String | Validation type. DNS_AUTO: automatic DNS validation; DNS: manual DNS validation; FILE: file validation; EMAIL: email validationNote: this field may return null, indicating that no valid values can be obtained. |
| VulnerabilityStatus | String | Vulnerability scanning status Note: this field may return null, indicating that no valid values can be obtained. |
| CertBeginTime | Timestamp | Time when the certificate takes effect Note: this field may return null, indicating that no valid values can be obtained. |
| CertEndTime | Timestamp | Time when the certificate expires Note: this field may return null, indicating that no valid values can be obtained. |
| ValidityPeriod | String | Validity period of the certificate, in months Note: this field may return null, indicating that no valid values can be obtained. |
| InsertTime | Timestamp | Certificate application time. Note: this field may return null, indicating that no valid values can be obtained. |
| OrderId | String | CA order id. Note: this field may return null, indicating that no valid values can be obtained. |
| CertificateExtra | CertificateExtra | Extended information of the certificate Note: this field may return null, indicating that no valid values can be obtained. |
| CertificatePrivateKey | String | Private key certificate; for Chinese SM certificates, it refers to the private key certificate in the signature certificate. Note: this field may return null, indicating that no valid values can be obtained. |
| CertificatePublicKey | String | Public key certificate; for Chinese SM certificate, it refers to the public key certificate in the signature certificate. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuthDetail | DvAuthDetail | Certificate domain name verification information. Note: this field may return null, indicating that no valid values can be obtained. |
| VulnerabilityReport | String | Vulnerability scanning assessment report Note: this field may return null, indicating that no valid values can be obtained. |
| CertificateId | String | Certificate ID Note: this field may return null, indicating that no valid values can be obtained. |
| TypeName | String | Certificate type name Note: this field may return null, indicating that no valid values can be obtained. |
| StatusName | String | Status description Note: this field may return null, indicating that no valid values can be obtained. |
| SubjectAltName | Array of String | Multiple domain names included in the certificate (excluding the primary domain name, which uses the Domain field)Note: This field may return null, indicating that no valid values can be obtained. |
| IsVip | Boolean | Whether the certificate is a paid one. Note: This field may return null, indicating that no valid values can be obtained. |
| IsWildcard | Boolean | Whether the certificate is a wildcard certificate Note: this field may return null, indicating that no valid values can be obtained. |
| IsDv | Boolean | Whether the certificate is a DV certificate Note: this field may return null, indicating that no valid values can be obtained. |
| IsVulnerability | Boolean | Whether the vulnerability scanning feature is enabled Note: this field may return null, indicating that no valid values can be obtained. |
| SubmittedData | SubmittedData | Profile information submitted for paid certificates. Note: this field may return null, indicating that no valid values can be obtained. |
| RenewAble | Boolean | Whether the certificate can be renewed. Note: This field may return null, indicating that no valid values can be obtained. |
| Deployable | Boolean | Whether the certificate can be deployed Note: this field may return null, indicating that no valid values can be obtained. |
| Tags | Array of Tags | List of associated tags Note: this field may return null, indicating that no valid values can be obtained. |
| RootCert | RootCertificates | Root certificate. Note: This field may return null, indicating that no valid values can be obtained. |
| EncryptCert | String | Chinese SM certificate public key, only has value for national cryptography certificates. Note: this field may return null, indicating that no valid values can be obtained. |
| EncryptPrivateKey | String | Chinese SM certificate private key certificate, only has value for national cryptography certificates. Note: this field may return null, indicating that no valid values can be obtained. |
| CertFingerprint | String | SHA1 fingerprint of the signature certificate Note: This field may return null, indicating that no valid values can be obtained. |
| EncryptCertFingerprint | String | SHA1 fingerprint of the encryption certificate (for Chinese SM certificates only) Note: This field may return null, indicating that no valid values can be obtained. |
| EncryptAlgorithm | String | Certificate encryption algorithm (or Chinese SM certificates only). Note: this field may return null, indicating that no valid values can be obtained. |
| DvRevokeAuthDetail | Array of DvAuths | The authentication value for DV certificate revocation. Note: This field may return null, indicating that no valid values can be obtained. |
| CertChainInfo | Array of CertBasicInfo | Certificate chain information. Note: this field may return null, indicating that no valid values can be obtained. |
| 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. |
Obtain the details of the certificate under review
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificateDetail
<Common request parameters>
{
"CertificateId": "aClRkC90"
}{
"Response": {
"OwnerUin": "815836472",
"ProjectId": "0",
"From": "trustasia",
"OrderId": "u1hD8*****mXue",
"CertificateType": "SVR",
"PackageType": "48",
"ProductZhName": "DNSPod - domain name-based (DV) SSL certificate"
"Domain": "ninghhuang.online",
"Alias": "",
"Status": 4,
"StatusMsg": "CA-REVIEWING",
"VulnerabilityStatus": "INACTIVE",
"RootCert": {
"Sign": null,
"Encrypt": null,
"Standard": null
},
"EncryptCert": null,
"EncryptPrivateKey": null,
"CertificatePrivateKey": "*******",
"CertificatePublicKey": null,
"CertBeginTime": null,
"CertEndTime": null,
"ValidityPeriod": "12",
"InsertTime": "2024-12-02 19:12:46",
"VulnerabilityReport": null,
"CertificateId": "K33dxkOk",
"TypeName": "DNSPod - domain name-based (DV) SSL certificate"
"StatusName": "to be validated"
"CertificateExtra": {
"SMCert": 0,
"ReplacedBy": null,
"OriginCertificateId": null,
"ReplacedFor": null,
"RenewOrder": null,
"DomainNumber": "1",
"CompanyType": 2
},
"DvAuthDetail": {
"DvAuths": [
{
"DvAuthKey": "_875bed25cf9e03596931d91cb0a52bd9.ninghhuang.online",
"DvAuthValue": "a3108492878a2d989949fa50522dd2b0.cc7346307ff022fcfa68e025f6dbf6ad.cmcdpcwca5iljv.trust-provider.com",
"DvAuthDomain": "ninghhuang.online",
"DvAuthPath": null,
"DvAuthSubDomain": "_875bed25cf9e03596931d91cb0a52bd9",
"DvAuthVerifyType": "CNAME"
}
],
"DvAuthKey": "_875bed25cf9e03596931d91cb0a52bd9.ninghhuang.online",
"DvAuthValue": "a3108492878a2d989949fa50522dd2b0.cc7346307ff022fcfa68e025f6dbf6ad.cmcdpcwca5iljv.trust-provider.com",
"DvAuthDomain": "ni****ang.online",
"DvAuthPath": null,
"DvAuthKeySubDomain": "_875bed25cf9e03596931d91cb0a52bd9"
},
"VerifyType": "DNS_AUTO",
"DvRevokeAuthDetail": [],
"SubjectAltName": [],
"IsVip": true,
"IsWildcard": false,
"IsDv": true,
"IsVulnerability": false,
"SubmittedData": null,
"RenewAble": false,
"Deployable": true,
"Tags": [],
"CertFingerprint": null,
"EncryptCertFingerprint": null,
"EncryptAlgorithm": "RSA 2048",
"CertChainInfo": null,
"RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
}
}Obtain the details of the certificate that has been approved
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificateDetail
<Common request parameters>
{
"CertificateId": "aCMEQWHt"
}{
"Response": {
"OwnerUin": "815836472",
"ProjectId": "0",
"From": "trustasia",
"OrderId": "PVpvxIN2_E*****pvjw",
"CertificateType": "SVR",
"PackageType": "43",
"ProductZhName": "DNSPod - organization-validated (OV) SSL certificate"
"Domain": "ninghhuang.online",
"Alias": "",
"Status": 4,
"StatusMsg": "PRE-REVIEWING",
"VulnerabilityStatus": "INACTIVE",
"RootCert": {
"Sign": null,
"Encrypt": null,
"Standard": null
},
"EncryptCert": null,
"EncryptPrivateKey": null,
"CertificatePrivateKey": "*****",
"CertificatePublicKey": null,
"CertBeginTime": null,
"CertEndTime": null,
"ValidityPeriod": "12",
"InsertTime": "2024-11-27 20:06:51",
"VulnerabilityReport": null,
"CertificateId": "Jv8u7beI",
"TypeName": "DNSPod - organization-validated (OV) SSL certificate"
"StatusName": "to be validated"
"CertificateExtra": {
"SMCert": 0,
"ReplacedBy": null,
"OriginCertificateId": null,
"ReplacedFor": null,
"RenewOrder": null,
"DomainNumber": "1",
"CompanyType": 2
},
"DvAuthDetail": {
"DvAuths": [
{
"DvAuthKey": "_882a77cde28ffe49e5764ab3afb75849.ninghhuang.online",
"DvAuthValue": "97f80ec4c7947178cec6b5a093ed34b0.a5cd7986aaaffdfd37437c9c6de1dd30.cmcopc2ncmbffy.trust-provider.com",
"DvAuthDomain": "ninghhuang.online",
"DvAuthPath": null,
"DvAuthSubDomain": "_882a77cde28ffe49e5764ab3afb75849",
"DvAuthVerifyType": "CNAME"
}
],
"DvAuthKey": "_882a77cde28ffe49e5764ab3afb75849.ninghhuang.online",
"DvAuthValue": "97f80ec4c7947178cec6b5a093ed34b0.a5cd7986aaaffdfd37437c9c6de1dd30.cmcopc2ncmbffy.trust-provider.com",
"DvAuthDomain": "ninghhuang.online",
"DvAuthPath": null,
"DvAuthKeySubDomain": "_882a77cde28ffe49e5764ab3afb75849"
},
"VerifyType": "DNS_AUTO",
"DvRevokeAuthDetail": [],
"SubjectAltName": [],
"IsVip": true,
"IsWildcard": false,
"IsDv": false,
"IsVulnerability": false,
"SubmittedData": null,
"RenewAble": false,
"Deployable": true,
"Tags": [],
"CertFingerprint": null,
"EncryptCertFingerprint": null,
"EncryptAlgorithm": "RSA 2048",
"CertChainInfo": null,
"RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
}
}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 | Operation failed. |
| FailedOperation.AuthError | You do not have permission to perform this operation. |
| FailedOperation.CannotGetOrder | Failed to get order information. Try again later. |
| FailedOperation.CertificateInvalid | The certificate is invalid. |
| FailedOperation.CertificateNotFound | The certificate does not exist. |
| 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. |
| InternalError.BackendResponseEmpty | The backend service response is empty. |
| LimitExceeded.RateLimitExceeded | The API rate limit is reached. |
| ResourceNotFound.Manager | The manager of the company does not exist. |
文档反馈