tencent cloud

APIs

DescribeSkillScanAlertList

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:18:50

1. API Description

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

Queries the Skill security detection alarm list with pagination, filtering, and sorting supported.

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: DescribeSkillScanAlertList.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
Offset No Integer Pagination offset.
Valid values: [0, +∞)
Default value: 0
Limit No Integer Number of results per page
Valid values: [1, 200]
Default value: 10
Filters.N No Array of Filters Filter criteria list. Supported filter fields: BelongAssetType (asset type ownership: HOST/CONTAINER, defaults to HOST if not specified), ContainerId (container ID, takes effect only for container alarms), RiskLevel (risk level, exact match), Status (processing status, exact match), SkillName (Skill name, fuzzy matching), UUID (host UUID, exact match), Level (alarm level, exact match), ContentHash (file SHA256, exact match), InstanceID (instance ID, exact match), InstanceName (instance name, fuzzy matching), SkillPath (Skill path, fuzzy matching)
Order No String Sorting method.
Enumeration values:
ASC: Ascending
DESC: descending order
Default value: DESC
By No String Sorting field.
Enumeration values:
CreateTime: first detection time
SecurityScore: Security score
UpdateTime: Update time
Default value: CreateTime
MemberId.N No Array of String Group account member id

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of eligible alarms
AlertList Array of SkillScanAlertItem Alarm list
RuleCatalog Array of SkillRuleCatalogItem Complete set of fusion rule directories (rule_id → rule_name). The frontend translates AlertList[].HitRules[].RuleID accordingly. Language is switched via the common cloud API parameter Language.
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 Querying the Alarm List

Input Example

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

{
    "Offset": 0,
    "Limit": 10,
    "Filters": [
        {
            "Name": "RiskLevel",
            "Values": [
                "malicious"
            ]
        }
    ],
    "Order": "DESC",
    "By": "CreateTime"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "AlertList": [
            {
                "ID": 10001,
                "UUID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                "HostIP": "10.0.1.100",
                "InstanceID": "ins-a1b2c3d4",
                "BelongAssetType": "HOST",
                "SkillName": "code-review-assistant",
                "SkillPath": "/home/user/.local/share/skills/code-review-assistant",
                "Scope": "user",
                "Version": "1.2.3",
                "ContentHash": "sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
                "RiskLevel": "malicious",
                "SecurityScore": 35,
                "PrimaryRuleID": "90001",
                "EngineVersion": 3,
                "Status": 0,
                "Level": "high",
                "CreateTime": "2026-06-20T10:30:00Z",
                "UpdateTime": "2026-06-21T14:15:00Z"
            }
        ],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback