Documentation|Tencent Cloud

Recent Pages

Documentation

DescribeCertificateDetail

Last updated: 2020-06-08 16:16:04

1. API Description

Domain name for API request: ssl.tencentcloudapi.com.

This API is used to obtain certificate details.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

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: DescribeCertificateDetail.
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.
CertificateId	Yes	String	Certificate ID.

3. Output Parameters

Parameter Name	Type	Description
OwnerUin	String	User 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: TrustAsia; upload: certificate uploaded by users. Note: this field may return null, indicating that no valid values can be obtained.
CertificateType	String	Certificate type. CA: client certificate; SVR: server certificate. Note: this field may return null, indicating that no valid values can be obtained.
PackageType	String	Certificate package type. 1: GeoTrust DV SSL CA - G3; 2: TrustAsia TLS RSA CA; 3: Secure Site EV Pro; 4: Secure Site EV; 5: Secure Site OV Pro; 6: Secure Site OV; 7: Secure Site OV wildcard SSL certificate; 8: GeoTrust EV; 9: GeoTrust OV; 10: GeoTrust OV wildcard SSL certificate; 11: TrustAsia DV multi-domain SSL certificate; 12: TrustAsia DV wildcard SSL certificate; 13: TrustAsia OV wildcard SSL certificate (D3); 14: TrustAsia OV SSL certificate (D3); 15: TrustAsia OV multi-domain SSL certificate (D3); 16: TrustAsia EV SSL certificate (D3); 17: TrustAsia EV multi-domain SSL certificate (D3); 18: GlobalSign OV SSL certificate; 19: GlobalSign OV wildcard SSL certificate; 20: GlobalSign EV SSL certificate; 21: TrustAsia OV multi-domain wildcard SSL certificate (D3); 22: GlobalSign OV multi-domain SSL certificate; 23: GlobalSign OV multi-domain wildcard SSL certificate; 24: GlobalSign EV multi-domain SSL certificate. Note: this field may return null, indicating that no valid values can be obtained.
ProductZhName	String	Issuer. Note: this field may return null, indicating that no valid values can be obtained.
Domain	String	Domain name. 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: being reviewed; 1: approved; 2: not approved; 3: expired; 4: DNS record added; 5: OV certificate, to be submitted; 6: order being canceled; 7: cancelled; 8: information submitted, confirmation letter to be uploaded; 9: certificate being revoked; 10: revoked; 11: reissuing; 12: revocation confirmation letter to be uploaded. Note: this field may return null, indicating that no valid values can be obtained.
StatusMsg	String	Status information. Note: this field may return null, indicating that no valid values can be obtained.
VerifyType	String	Verification type. DNS_AUTO: automatic DNS verification; DNS: manual DNS verification; FILE: verification by file; EMAIL: verification by email. Note: 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 (unit: month). Note: this field may return null, indicating that no valid values can be obtained.
InsertTime	Timestamp	Application time. Note: this field may return null, indicating that no valid values can be obtained.
OrderId	String	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 of the certificate. Note: this field may return null, indicating that no valid values can be obtained.
CertificatePublicKey	String	Public key of the certificate. Note: this field may return null, indicating that no valid values can be obtained.
DvAuthDetail	DvAuthDetail	DV authentication 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	Domain names associated with the certificate (including the primary domain name). Note: this field may return null, indicating that no valid values can be obtained.
IsVip	Boolean	Whether the customer is a VIP customer. 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	Submitted data. Note: this field may return null, indicating that no valid values can be obtained.
RenewAble	Boolean	Whether the certificate can be reissued. 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.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining certificate details

This example shows you how to obtain the details of a certificate which is being reviewed.

Input Example

https://ssl.tencentcloudapi.com/?Action=DescribeCertificateDetail
&CertificateId=aClRkC90
&<Common request parameters>

Output Example

{
  "Response": {
    "From": "trustasia",
    "SubjectAltName": null,
    "VulnerabilityReport": null,
    "CertificatePrivateKey": "-----BEGIN RSA PRIVATE KEY-----......-----END RSA PRIVATE KEY-----",
    "CertificatePublicKey": null,
    "CertificateExtra": {
      "OriginCertificateId": null,
      "ReplacedBy": null,
      "ReplacedFor": null,
      "DomainNumber": "3",
      "RenewOrder": null
    },
    "RenewAble": false,
    "Status": 5,
    "IsDv": false,
    "IsVulnerability": false,
    "CertBeginTime": null,
    "TypeName": "Secure Site OV",
    "DvAuthDetail": null,
    "VerifyType": null,
    "StatusMsg": null,
    "StatusName": "OV certificate, to be submitted",
    "ProjectId": "0",
    "OwnerUin": "779000108",
    "ProductZhName": "Secure Site OV",
    "CertEndTime": null,
    "PackageType": "6",
    "RequestId": "330979e0-fd50-4b33-86b0-c2e264d8ff52",
    "InsertTime": "2020-01-16 19:26:20",
    "CertificateType": "SVR",
    "IsVip": true,
    "ValidityPeriod": "12",
    "OrderId": null,
    "Domain": "",
    "CertificateId": "aClRkC90",
    "Alias": "",
    "SubmittedData": {
      "OrganizationCity": "Shenzhen",
      "CsrContent": "",
      "OrganizationName": "Tencent",
      "CertificateDomain": "test-dawd2143e21.com",
      "AdminPhoneNum": "12345678901",
      "AdminPosition": "developer",
      "OrganizationDivision": "Qcloud",
      "DomainList": [
        "test-11111111111111.com",
        "test-222222222222.com"
      ],
      "AdminFirstName": "test",
      "ContactLastName": "test",
      "ContactEmail": "test@tencent.com",
      "ContactNumber": "12345678901",
      "CsrType": "online",
      "PhoneAreaCode": "0755",
      "VerifyType": "",
      "AdminLastName": "test",
      "ContactFirstName": "test",
      "OrganizationCountry": "CN",
      "ContactPosition": "developer",
      "OrganizationRegion": "Guangdong",
      "PhoneNumber": "86013388",
      "PostalCode": "",
      "AdminEmail": "test@tencent.com",
      "KeyPassword": "",
      "OrganizationAddress": "Tencent Building, No. 10000 Shennan Road, Nanshan District"
    },
    "IsWildcard": false,
    "Deployable": false,
    "VulnerabilityStatus": "INACTIVE"
  }
}

Example2 Obtaining certificate details-2

This example shows you how to obtain the details of a certificate which has been approved.

Input Example

https://ssl.tencentcloudapi.com/?Action=DescribeCertificateDetail
&CertificateId=aCMEQWHt
&<Common request parameters>

Output Example

{
  "Response": {
    "From": "trustasia",
    "SubjectAltName": [
      "test-ev-dawe23r243qfa.com"
    ],
    "VulnerabilityReport": null,
    "CertificatePrivateKey": "-----BEGIN RSA PRIVATE KEY-----......-----END RSA PRIVATE KEY-----",
    "CertificateExtra": {
      "OriginCertificateId": null,
      "ReplacedBy": null,
      "ReplacedFor": null,
      "DomainNumber": "2",
      "RenewOrder": null
    },
    "RenewAble": true,
    "Status": 1,
    "IsDv": false,
    "IsVulnerability": true,
    "CertBeginTime": "2020-01-16 16:00:00",
    "TypeName": "Secure Site EV",
    "DvAuthDetail": null,
    "VerifyType": null,
    "StatusMsg": null,
    "StatusName": "approved",
    "ProjectId": "0",
    "OwnerUin": "779000108",
    "ProductZhName": "Secure Site EV",
    "CertEndTime": "2020-02-14 16:00:00",
    "PackageType": "4",
    "RequestId": "658b9da1-b5e6-46b3-803c-d59a2cb60277",
    "InsertTime": "2020-01-16 13:19:10",
    "CertificateType": "SVR",
    "IsVip": true,
    "ValidityPeriod": "12",
    "OrderId": "SE8PUhGU",
    "Domain": "test-ev-dae23r32fd.com",
    "CertificateId": "aCMEQWHt",
    "Alias": "",
    "SubmittedData": null,
    "IsWildcard": false,
    "Deployable": true,
    "VulnerabilityStatus": "INACTIVE"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.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.

Was this page helpful?

Confirm

Was this page helpful?

Not at all
Not very helpful
Somewhat helpful
Very helpful
Extremely helpful

Send Feedback

Hide

Submit a Ticket Contact sales

Help

Documentation

Sign Up

Log in

Recent Pages

DescribeCertificateDetail

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Obtaining certificate details

Input Example

Output Example

Example2 Obtaining certificate details-2

Input Example

Output Example

5. Developer Resources

API Explorer

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?