tencent cloud

文档反馈

DescribeHostUpdateRecordDetail

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

    1. API Description

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

    Query certificate cloud resource update record details list

    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 One-click update record ID
    Limit No String Number per page, 10 by default.
    Offset No String Paging offset, starting from 0

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total count
    Note: This field may return null, indicating that no valid value can be obtained.
    RecordDetailList Array of UpdateRecordDetails Certificate deployment record list
    Note: This field may return null, indicating that no valid value can be obtained.
    SuccessTotalCount Integer Total successful deployments
    Note: This field may return null, indicating that no valid value can be obtained.
    FailedTotalCount Integer Total failed deployments
    Note: This field may return null, indicating that no valid value can be obtained.
    RunningTotalCount Integer Total running deployments
    Note: This field may return null, indicating that no valid value 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 Query Certificate Cloud Resource Update Record Details List

    Query certificate cloud resource update record details list

    Input Example

    POST / HTTP/1.1
    Host: ssl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeHostUpdateRecordDetail
    <Common request parameters>
    
    {
        "DeployRecordId": "abc",
        "Limit": "abc",
        "Offset": "abc"
    }
    

    Output Example

    {
        "Response": {
            "TotalCount": 0,
            "RecordDetailList": [
                {
                    "ResourceType": "abc",
                    "List": [
                        {
                            "Id": 1,
                            "CertId": "abc",
                            "OldCertId": "abc",
                            "Domains": [
                                "abc"
                            ],
                            "ResourceType": "abc",
                            "Region": "abc",
                            "Status": 1,
                            "ErrorMsg": "abc",
                            "CreateTime": "abc",
                            "UpdateTime": "abc",
                            "InstanceId": "abc",
                            "InstanceName": "abc",
                            "ListenerId": "abc",
                            "ListenerName": "abc",
                            "Protocol": "abc",
                            "SniSwitch": 1,
                            "Bucket": "abc",
                            "Port": 0,
                            "Namespace": "abc",
                            "SecretName": "abc",
                            "EnvId": "abc",
                            "TCBType": "abc"
                        }
                    ],
                    "TotalCount": 0
                }
            ],
            "SuccessTotalCount": 0,
            "FailedTotalCount": 0,
            "RunningTotalCount": 0,
            "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.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.