tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeCertificateDetail

最后更新时间：2023-12-01 16:21:32

    1. API Description

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

    This API is used to get certificate details.

    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.

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

    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 plan type. null: User-uploaded certificate (no plan type); 1: GeoTrust DV SSL CA - G3; 2: TrustAsia TLS RSA CA; 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.
    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: reviewing; 1: approved; 2: unapproved; 3: expired; 4: DNS record added; 5: enterprise-grade certificate, pending submission; 6: canceling order; 7: canceled; 8: information submitted, pending confirmation letter upload; 9: revoking certificate; 10: revoked; 11: reissuing; 12: pending revocation confirmation letter upload
    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 Validation type. DNS_AUTO: automatic DNS validation; DNS: manual DNS validation; FILE: file validation; EMAIL: email validation
    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, in months
    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 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 Submitted data
    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 encryption certificate
    Note: This field may return null, indicating that no valid values can be obtained.
    EncryptPrivateKey String Private key of Chinese SM encryption
    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 algorithm
    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.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the details of a certificate under review

    This example shows you how to query the details of a certificate under review.

    Input Example

    POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificateDetail
<Common request parameters>

{
    "CertificateId": "aClRkC90"
}

    Output Example

    {
    "Response": {
        "OwnerUin": "abc",
        "ProjectId": "abc",
        "From": "abc",
        "CertificateType": "abc",
        "PackageType": "abc",
        "ProductZhName": "abc",
        "Domain": "abc",
        "Alias": "abc",
        "Status": 1,
        "StatusMsg": "abc",
        "VerifyType": "abc",
        "VulnerabilityStatus": "abc",
        "CertBeginTime": "2020-09-22 00:00:00",
        "CertEndTime": "2020-09-22 00:00:00",
        "ValidityPeriod": "abc",
        "InsertTime": "2020-09-22 00:00:00",
        "OrderId": "abc",
        "CertificateExtra": {
            "DomainNumber": "abc",
            "OriginCertificateId": "abc",
            "ReplacedBy": "abc",
            "ReplacedFor": "abc",
            "RenewOrder": "abc",
            "SMCert": 0
        },
        "CertificatePrivateKey": "abc",
        "CertificatePublicKey": "abc",
        "DvAuthDetail": {
            "DvAuthKey": "abc",
            "DvAuthValue": "abc",
            "DvAuthDomain": "abc",
            "DvAuthPath": "abc",
            "DvAuthKeySubDomain": "abc",
            "DvAuths": [
                {
                    "DvAuthKey": "abc",
                    "DvAuthValue": "abc",
                    "DvAuthDomain": "abc",
                    "DvAuthPath": "abc",
                    "DvAuthSubDomain": "abc",
                    "DvAuthVerifyType": "abc"
                }
            ]
        },
        "VulnerabilityReport": "abc",
        "CertificateId": "abc",
        "TypeName": "abc",
        "StatusName": "abc",
        "SubjectAltName": [
            "abc"
        ],
        "IsVip": true,
        "IsWildcard": true,
        "IsDv": true,
        "IsVulnerability": true,
        "SubmittedData": {
            "CsrType": "abc",
            "CsrContent": "abc",
            "CertificateDomain": "abc",
            "DomainList": [
                "abc"
            ],
            "KeyPassword": "abc",
            "OrganizationName": "abc",
            "OrganizationDivision": "abc",
            "OrganizationAddress": "abc",
            "OrganizationCountry": "abc",
            "OrganizationCity": "abc",
            "OrganizationRegion": "abc",
            "PostalCode": "abc",
            "PhoneAreaCode": "abc",
            "PhoneNumber": "abc",
            "AdminFirstName": "abc",
            "AdminLastName": "abc",
            "AdminPhoneNum": "abc",
            "AdminEmail": "abc",
            "AdminPosition": "abc",
            "ContactFirstName": "abc",
            "ContactLastName": "abc",
            "ContactNumber": "abc",
            "ContactEmail": "abc",
            "ContactPosition": "abc",
            "VerifyType": "abc"
        },
        "RenewAble": true,
        "Deployable": true,
        "Tags": [
            {
                "TagKey": "abc",
                "TagValue": "abc"
            }
        ],
        "RootCert": {
            "Sign": "abc",
            "Encrypt": "abc",
            "Standard": "abc"
        },
        "EncryptCert": "abc",
        "EncryptPrivateKey": "abc",
        "CertFingerprint": "abc",
        "EncryptCertFingerprint": "abc",
        "EncryptAlgorithm": "abc",
        "DvRevokeAuthDetail": [
            {
                "DvAuthKey": "abc",
                "DvAuthValue": "abc",
                "DvAuthDomain": "abc",
                "DvAuthPath": "abc",
                "DvAuthSubDomain": "abc",
                "DvAuthVerifyType": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

    Example2 Querying the details of an approved certificate - 2

    This example shows you how to query the details of an approved certificate.

    Input Example

    POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificateDetail
<Common request parameters>

{
    "CertificateId": "aCMEQWHt"
}

    Output Example

    {
    "Response": {
        "OwnerUin": "abc",
        "ProjectId": "abc",
        "From": "abc",
        "CertificateType": "abc",
        "PackageType": "abc",
        "ProductZhName": "abc",
        "Domain": "abc",
        "Alias": "abc",
        "Status": 1,
        "StatusMsg": "abc",
        "VerifyType": "abc",
        "VulnerabilityStatus": "abc",
        "CertBeginTime": "2020-09-22 00:00:00",
        "CertEndTime": "2020-09-22 00:00:00",
        "ValidityPeriod": "abc",
        "InsertTime": "2020-09-22 00:00:00",
        "OrderId": "abc",
        "CertificateExtra": {
            "DomainNumber": "abc",
            "OriginCertificateId": "abc",
            "ReplacedBy": "abc",
            "ReplacedFor": "abc",
            "RenewOrder": "abc",
            "SMCert": 0
        },
        "CertificatePrivateKey": "abc",
        "CertificatePublicKey": "abc",
        "DvAuthDetail": {
            "DvAuthKey": "abc",
            "DvAuthValue": "abc",
            "DvAuthDomain": "abc",
            "DvAuthPath": "abc",
            "DvAuthKeySubDomain": "abc",
            "DvAuths": [
                {
                    "DvAuthKey": "abc",
                    "DvAuthValue": "abc",
                    "DvAuthDomain": "abc",
                    "DvAuthPath": "abc",
                    "DvAuthSubDomain": "abc",
                    "DvAuthVerifyType": "abc"
                }
            ]
        },
        "VulnerabilityReport": "abc",
        "CertificateId": "abc",
        "TypeName": "abc",
        "StatusName": "abc",
        "SubjectAltName": [
            "abc"
        ],
        "IsVip": true,
        "IsWildcard": true,
        "IsDv": true,
        "IsVulnerability": true,
        "SubmittedData": {
            "CsrType": "abc",
            "CsrContent": "abc",
            "CertificateDomain": "abc",
            "DomainList": [
                "abc"
            ],
            "KeyPassword": "abc",
            "OrganizationName": "abc",
            "OrganizationDivision": "abc",
            "OrganizationAddress": "abc",
            "OrganizationCountry": "abc",
            "OrganizationCity": "abc",
            "OrganizationRegion": "abc",
            "PostalCode": "abc",
            "PhoneAreaCode": "abc",
            "PhoneNumber": "abc",
            "AdminFirstName": "abc",
            "AdminLastName": "abc",
            "AdminPhoneNum": "abc",
            "AdminEmail": "abc",
            "AdminPosition": "abc",
            "ContactFirstName": "abc",
            "ContactLastName": "abc",
            "ContactNumber": "abc",
            "ContactEmail": "abc",
            "ContactPosition": "abc",
            "VerifyType": "abc"
        },
        "RenewAble": true,
        "Deployable": true,
        "Tags": [
            {
                "TagKey": "abc",
                "TagValue": "abc"
            }
        ],
        "RootCert": {
            "Sign": "abc",
            "Encrypt": "abc",
            "Standard": "abc"
        },
        "EncryptCert": "abc",
        "EncryptPrivateKey": "abc",
        "CertFingerprint": "abc",
        "EncryptCertFingerprint": "abc",
        "EncryptAlgorithm": "abc",
        "DvRevokeAuthDetail": [
            {
                "DvAuthKey": "abc",
                "DvAuthValue": "abc",
                "DvAuthDomain": "abc",
                "DvAuthPath": "abc",
                "DvAuthSubDomain": "abc",
                "DvAuthVerifyType": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

    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 Operation failed.
    FailedOperation.AuthError You do not have permission to perform this operation.
    FailedOperation.CannotGetOrder Failed to get order information. Try again later.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款