tencent cloud

Cloud Security Center

DokumentasiCloud Security CenterAPI DocumentationHost Vulnerability APIsDescribeVulScanPeriodic

DescribeVulScanPeriodic

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-08-11 19:10:25

1. API Description

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

This API is used to obtain vulnerability scanning (period scanning).

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: DescribeVulScanPeriodic.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
MemberId.N No Array of String

Group account member id

3. Output Parameters

Parameter Name Type Description
Status Integer

Period scanning switch (0-off, 1-on)
VulCategory Array of String

Vulnerability type

Enumeration value:

  • LINUX: Linux software vulnerability
  • WINDOWS: Windows system patch
  • WEB_CMS: Web-CMS vulnerability
  • APPLICATION: Application vulnerability
  • EMERGENCY: Emergency vulnerability
Level Array of String

Vulnerability level (INVALID: Invalid, INFO: Notification, LOW: Low risk, MEDIUM: Medium risk, HIGH: High risk, CRITICAL: Critical)
Method String

Scanning method (VersionCompare: version comparison, POC: POC detection, VersionComparePOC: version p comparison+POC detection)
CycleType Integer

Period scanning type

Enumeration value:

  • 1: Daily
  • 2: Weekly
  • 3: Per month
StartTime String

Start time (09:00:00)
EndTime String

End time (18:00:00)
AssetRange Integer

Asset scope (0-All assets, 1-Custom assets, 2-Remove asset)
AssetList Array of String

Asset list (instance_id list)
CycleValue Array of Integer

Period value

Unit: Day of the week or day of the month
Timeout Integer

Timeout duration

Unit: second
AllowSync Integer

Whether to synchronize configuration 0-cannot, 1-permission
EnableSync Integer

Whether the admin account has the automated configuration synchronization switch enabled 0-Off, 1-On
AdminInfo AccountBriefInfo

Which account the configuration message comes from. Being empty indicates set by oneself.
TagIds Array of Integer

tag id
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 Retrieve vulnerability scan configuration (period scanning)

Input Example

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

{}

Output Example

{
    "Response": {
        "AssetList": [
            "1****************************566****"
        ],
        "AssetRange": 0,
        "CycleType": 2,
        "CycleValue": [
            3
        ],
        "EndTime": "03:00",
        "Level": [
            "MEDIUM"
        ],
        "Method": "VersionCompare",
        "StartTime": "01:00",
        "Status": 0,
        "Timeout": 3600,
        "VulCategory": [
            "LINUX"
        ],
        "RequestId": "a9d0215e-0255-4b0a-8406-722d59c62f75"
    }
}

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.
Topik sebelumnya: DescribeVulRiskRelateHostTopik selanjutnya: DescribeVulScanTaskDetail

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan