tencent cloud

All product documents
APIs
DocumentationAPIsSSL CertificatesCertificate APIsDescribeHostUpdateRecordDetail
DescribeHostUpdateRecordDetail
Last updated: 2025-02-27 16:22:00
DescribeHostUpdateRecordDetail
Last updated: 2025-02-27 16:22:00

1. API Description

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

This API is used to query the update record details of certificate cloud resources.

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: DescribeHostUpdateRecordDetail.
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.
DeployRecordId Yes String Deployment record id, which is the record id returned by calling the UpdateCertificateInstance api, or the record id returned by calling the UpdateCertificateRecordRollback rollback api.
Limit No String Number of items per page. the default is 10. the maximum value is 200.
Offset No String Pagination offset, starting from 0. default is 0.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer If the total number cannot be obtained, return 0.
Note: this field may return null, indicating that no valid values can be obtained.
RecordDetailList Array of UpdateRecordDetails Certificate deployment record list; returns an empty array if no value is obtained.
Note: this field may return null, indicating that no valid values can be obtained.
SuccessTotalCount Integer Total number of successes; returns 0 if unavailable.
Note: this field may return null, indicating that no valid values can be obtained.
FailedTotalCount Integer Total number of failures. if it cannot be obtained, return 0.
Note: this field may return null, indicating that no valid values can be obtained.
RunningTotalCount Integer Total number of deployments in progress; returns 0 if unavailable.
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.

4. Example

Example1 Query Certificate Cloud Resource Update Record Information

Input Example

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

{
    "DeployRecordId": "193752",
    "Limit": "10",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "TotalCount": 27,
        "SuccessTotalCount": 27,
        "FailedTotalCount": 0,
        "RunningTotalCount": 0,
        "RecordDetailList": [
            {
                "ResourceType": "cdn",
                "List": [
                    {
                        "Id": 193752,
                        "CertId": "B7OXLIdj",
                        "OldCertId": "AN1Gys3l",
                        "Domains": [
                            "cdn.tencent.com"
                        ],
                        "ResourceType": "cdn",
                        "Region": "",
                        "Status": 1,
                        "ErrorMsg": "",
                        "CreateTime": "2024-08-23T01:34:43.000000Z",
                        "UpdateTime": "2024-08-23T01:36:20.000000Z",
                        "InstanceId": "",
                        "InstanceName": "",
                        "ListenerId": "",
                        "ListenerName": "",
                        "Protocol": "",
                        "SniSwitch": 0,
                        "Bucket": "",
                        "Port": 0,
                        "Namespace": "",
                        "SecretName": "",
                        "EnvId": "",
                        "TCBType": ""
                    }
                ],
                "TotalCount": 11
            },
            {
                "ResourceType": "clb",
                "List": [
                    {
                        "Id": 193763,
                        "CertId": "B7OXLIdj",
                        "OldCertId": "AN1Gys3l",
                        "Status": 1,
                        "ErrorMsg": "",
                        "CreateTime": "2024-08-23T01:34:44.000000Z",
                        "UpdateTime": "2024-08-23T01:36:08.000000Z",
                        "InstanceId": "lb-o47f78kg",
                        "InstanceName": "CLB Test"
                        "ListenerId": "lbl-mua8dxt8",
                        "ListenerName": "ni",
                        "Domains": [
                            "clb.tencent.com"
                        ],
                        "Protocol": "HTTPS",
                        "SniSwitch": 1,
                        "ResourceType": "clb",
                        "Region": "ap-guangzhou",
                        "Bucket": "",
                        "Namespace": "",
                        "SecretName": "",
                        "Port": 0,
                        "EnvId": "",
                        "TCBType": "",
                        "Url": "/index"
                    }
                ],
                "TotalCount": 3
            },
            {
                "ResourceType": "tke",
                "List": [
                    {
                        "Id": 193766,
                        "CertId": "B7OXLIdj",
                        "OldCertId": "AN1Gys3l",
                        "Status": 1,
                        "ErrorMsg": "",
                        "CreateTime": "2024-08-23T01:35:19.000000Z",
                        "UpdateTime": "2024-08-23T01:35:55.000000Z",
                        "InstanceId": "cls-j8cfpj7c",
                        "InstanceName": "ssltest",
                        "Namespace": "default",
                        "SecretName": "hathlim-b2cgngoq",
                        "ListenerId": "",
                        "ListenerName": "",
                        "Protocol": "",
                        "SniSwitch": 0,
                        "Bucket": "",
                        "Domains": [],
                        "ResourceType": "tke",
                        "Region": "ap-guangzhou",
                        "Port": 0,
                        "EnvId": "",
                        "TCBType": ""
                    }
                ],
                "TotalCount": 1
            },
            {
                "ResourceType": "vod",
                "List": [
                    {
                        "Id": 193767,
                        "CertId": "B7OXLIdj",
                        "OldCertId": "AN1Gys3l",
                        "Domains": [
                            "vod.tencent.com"
                        ],
                        "ResourceType": "vod",
                        "Region": "",
                        "Status": 1,
                        "ErrorMsg": "",
                        "CreateTime": "2024-08-23T01:35:26.000000Z",
                        "UpdateTime": "2024-08-23T01:35:57.000000Z",
                        "InstanceId": "",
                        "InstanceName": "",
                        "ListenerId": "",
                        "ListenerName": "",
                        "Protocol": "",
                        "SniSwitch": 0,
                        "Bucket": "",
                        "Port": 0,
                        "Namespace": "",
                        "SecretName": "",
                        "EnvId": "",
                        "TCBType": ""
                    }
                ],
                "TotalCount": 4
            },
            {
                "ResourceType": "apigateway",
                "List": [
                    {
                        "Id": 193771,
                        "CertId": "B7OXLIdj",
                        "OldCertId": "AN1Gys3l",
                        "Domains": [
                            "apigw.tencent.com"
                        ],
                        "ResourceType": "apigateway",
                        "Region": "ap-shanghai",
                        "Status": 1,
                        "ErrorMsg": "",
                        "CreateTime": "2024-08-23T01:35:27.000000Z",
                        "UpdateTime": "2024-08-23T01:36:04.000000Z",
                        "InstanceId": "service-8sk7cqmd",
                        "InstanceName": "ninghhuang",
                        "ListenerId": "",
                        "ListenerName": "",
                        "Protocol": "http&https",
                        "SniSwitch": 0,
                        "Bucket": "",
                        "Port": 0,
                        "Namespace": "",
                        "SecretName": "",
                        "EnvId": "",
                        "TCBType": ""
                    }
                ],
                "TotalCount": 5
            },
            {
                "ResourceType": "live",
                "List": [
                    {
                        "Id": 193776,
                        "CertId": "B7OXLIdj",
                        "OldCertId": "AN1Gys3l",
                        "Domains": [
                            "live.tencent.com"
                        ],
                        "ResourceType": "live",
                        "Region": "",
                        "Status": 1,
                        "ErrorMsg": "",
                        "CreateTime": "2024-08-23T01:35:32.000000Z",
                        "UpdateTime": "2024-08-23T01:36:07.000000Z",
                        "InstanceId": "",
                        "InstanceName": "",
                        "ListenerId": "",
                        "ListenerName": "",
                        "Protocol": "",
                        "SniSwitch": 0,
                        "Bucket": "",
                        "Port": 0,
                        "Namespace": "",
                        "SecretName": "",
                        "EnvId": "",
                        "TCBType": ""
                    }
                ],
                "TotalCount": 3
            }
        ],
        "RequestId": "79b4dae4-51a7-4345-9b2b-0c6a29f69291"
    }
}

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.CertificateDeployNotExist The certificate deployment record does not exist.
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.
LimitExceeded.RateLimitExceeded The API rate limit is reached.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon