tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SyncBaselineDetectSummary

Last updated: 2024-08-27 11:41:24

1. API Description

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

This API is used to sync the summary of baseline detection 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: SyncBaselineDetectSummary.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
TaskIds.N No Array of Integer IDs for calculating the progress of ongoing check tasks. Generally, this parameter is not required.

3. Output Parameters

Parameter Name Type Description
ProgressRate Integer Processing progress
NotPassPolicyCount Integer Total number of failed policies
HostCount Integer Total number of hosts
StartTime String Start time
EndTime String End time
WillFirstScan Integer 1: first scan about to start; 0: already scanned.
DetectingTaskIds Array of Integer ID of ongoing detection task
LeftMins Integer Remaining scanning time (minutes)
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 Syncing Detection Overview

Input Example

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

{}

Output Example

{
    "Response": {
        "DetectingTaskIds": [
            2379
        ],
        "EndTime": "",
        "HostCount": 1,
        "LeftMins": 3,
        "NotPassPolicyCount": 19,
        "ProgressRate": 20,
        "RequestId": "69fce851-ee60-44ac-8ab1-62c2c7856051",
        "StartTime": "2022-08-23 15:07:02",
        "WillFirstScan": 0
    }
}

Example2 Obtaining the Summary of the Specified Task ID

This example shows you how to obtain the summary of the specified task ID.

Input Example

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

{
    "TaskIds": [
        299,
        298
    ]
}

Output Example

{
    "Response": {
        "DetectingTaskIds": [],
        "EndTime": "2023-12-25 12:05:27",
        "HostCount": 31,
        "LeftMins": 0,
        "NotPassPolicyCount": 1,
        "ProgressRate": 100,
        "RequestId": "5f862bd8-6931-45ee-a5d9-0fe2c4ea30d7",
        "StartTime": "2023-12-25 09:36:00",
        "WillFirstScan": 0
    }
}

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.
InternalError Internal error
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy