tencent cloud

文档反馈

DescribeBaselineTop

最后更新时间:2024-08-27 11:42:58

1. API Description

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

This API is used to query TOP baseline detection items based on policy IDs.

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: DescribeBaselineTop.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Top Yes Integer Dynamic top value
StrategyId Yes Integer Policy ID

3. Output Parameters

Parameter Name Type Description
RuleTopList Array of BaselineRuleTopInfo List of top check items
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 Querying Top Baseline Check Items

This example shows you how to query top baseline check items based on policy ID.

Input Example

https://cwp.tencentcloudapi.com/?Action=DescribeBaselineTop
&StrategyId=1
&Top=5
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "f1dd9f5e-4ac0-48a7-9410-c86d24656d9a",
        "RuleTopList": [
            {
                "RuleName": "Check item name 1",
                "Level": 1,
                "EventCount": 4000,
                "RuleId": 1
            },
            {
                "RuleName": "Check item name 2",
                "Level": 2,
                "EventCount": 4000,
                "RuleId": 2
            }
        ]
    }
}

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.NoProfessionHost No Pro Edition host.
InternalError Internal error
InvalidParameter Incorrect parameter.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.