tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeVulFixStatus

Last updated: 2024-08-27 11:36:56

1. API Description

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

This API is used to check the host vulnerability fixing progress.

A maximum of 20 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: DescribeVulFixStatus.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
FixId No Integer Task ID. This parameter can be left blank if VulId is specified.
VulId No Integer Vulnerability ID. This parameter can be left blank if FixId is specified.
Quuid No String Host QUUID. This parameter can be used together with VulId to query the details of the last fixing task on a specific host.

3. Output Parameters

Parameter Name Type Description
FixStartTime String Fixing start time
Note: This field may return null, indicating that no valid values can be obtained.
FixEndTime String Fixing end time. If this parameter is left blank, fixing is not ended.
Note: This field may return null, indicating that no valid values can be obtained.
FixSuccessCnt Integer Number of successfully fixed hosts
Note: This field may return null, indicating that no valid values can be obtained.
FixFailCnt Integer Number of hosts failed to be fixed
HostCnt Integer Total number of hosts
FixId Integer Fixing task ID
SnapshotList Array of VulFixStatusSnapshotInfo Status list of snapshots to be fixed
Note: This field may return null, indicating that no valid values can be obtained.
VulFixList Array of VulFixStatusInfo Details list of vulnerabilities to be fixed
Note: This field may return null, indicating that no valid values can be obtained.
SnapshotProgress Integer Snapshot creation progress (0-100)
FixProgress Integer Fixing progress (0-100)
RemainingTime Integer Estimated remaining time (seconds)
IsRetrySnapshot Integer Whether the snapshot is retried. 0: no; 1: yes.
SnapshotFailCnt Integer Number of snapshots failed to be created
Note: This field may return null, indicating that no valid values can be obtained.
IsAllowRetry Integer Whether retry is allowed. 0: not allowed; 1: allowed.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 Vulnerability Repair - Querying the Progress of Fixing Host Vulnerabilities

Input Example

https://cwp.tencentcloudapi.com/?Action=DescribeVulFixStatus
&FixId=1
&<Common request parameters>

Output Example

{
    "Response": {
        "FixEndTime": "xx",
        "SnapshotFailCnt": 1,
        "SnapshotList": [
            {
                "Status": 1,
                "SnapshotName": "xx",
                "HostName": "xx",
                "FailReason": "xx",
                "Quuid": "xx",
                "ModifyTime": "xx",
                "SnapshotId": "xx",
                "HostIp": "xx",
                "Id": 1
            }
        ],
        "FixSuccessCnt": 1,
        "FixProgress": 1,
        "FixStartTime": "xx",
        "IsRetrySnapshot": 1,
        "RemainingTime": 1,
        "IsAllowRetry": 1,
        "HostCnt": 1,
        "SnapshotProgress": 1,
        "FixId": 1,
        "FixFailCnt": 1,
        "VulFixList": [
            {
                "VulName": "xx",
                "FixSuccessCnt": 1,
                "HostList": [
                    {
                        "Status": 1,
                        "ModifyTime": "xx",
                        "HostName": "xx",
                        "FailReason": "xx",
                        "Quuid": "xx",
                        "HostIp": "xx"
                    }
                ],
                "FailCnt": 1,
                "VulId": 1,
                "Progress": 1
            }
        ],
        "RequestId": "c741a4fd-776f-499b-85a2-7bc70fd5b92s"
    }
}

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
InternalError Internal error
InternalError.MainDBFail Failed to manipulate the data.
InvalidParameter Incorrect parameter.
InvalidParameter.InvalidFormat Incorrect parameter format.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy