DescribeCertificate

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

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: DescribeCertificate.
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 Name of the certificate 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 String Time when the certificate takes effect.
Note: this field may return null, indicating that no valid values can be obtained.
CertEndTime String 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 String 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.
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.
PackageTypeName 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.
RenewAble Boolean Whether the certificate can be reissued.
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.
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 information

Input Example

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

Output Example

{
  "Response": {
    "From": "trustasia",
    "SubjectAltName": null,
    "VulnerabilityReport": null,
    "StatusName": "approved",
    "CertificateExtra": {
      "OriginCertificateId": null,
      "ReplacedBy": null,
      "ReplacedFor": "a8xHcaIs",
      "DomainNumber": null
    },
    "RenewAble": false,
    "Status": 1,
    "IsDv": true,
    "CertBeginTime": "2020-01-14 16:00:00",
    "IsVulnerability": false,
    "DvAuthDetail": null,
    "VerifyType": "DNS",
    "StatusMsg": null,
    "ProjectId": "0",
    "OwnerUin": "20548499",
    "ProductZhName": "TrustAsia TLS RSA CA",
    "CertEndTime": "2020-02-12 16:00:00",
    "PackageType": "2",
    "RequestId": "6209102a-0f05-411d-a05c-c841431cb636",
    "InsertTime": "2020-01-14 10:54:47",
    "CertificateType": "SVR",
    "IsVip": false,
    "ValidityPeriod": "0",
    "OrderId": "TBD8NHC9J_01",
    "Domain": "wgc.red",
    "CertificateId": "a90XEOtj",
    "Alias": "New order for a8xHcaIs",
    "SubmittedData": null,
    "IsWildcard": false,
    "PackageTypeName": "TrustAsia TLS RSA CA",
    "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.

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

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help