tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBaselineRule

Last updated: 2024-12-06 15:41:26

1. API Description

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

This API is used to query the information on corresponding check items based on baseline ID.

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: DescribeBaselineRule.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
BaselineId Yes Integer Baseline ID
Limit Yes Integer Pagination limit, with the maximum value being 100.
Offset Yes Integer Pagination parameter
Level.N No Array of Integer Severity level
Status No Integer Status
Quuid No String Host QUUID
Uuid No String Host UUID

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of pagination query records
BaselineRuleList Array of BaselineRuleInfo Baseline check item list
Note: This field may return null, indicating that no valid values can be obtained.
ShowRuleRemark Boolean Whether to display the description column. True: yes; false: no.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 Baseline Detection Item Information

This example shows you how to query baseline detection item information based on the baseline ID and conditions.

Input Example

https://cwp.intl.tencentcloudapi.com/?Action=DescribeBaselineRule
&BaselineId=100441
&Level.0=1
&Status=0
&Quuid="8c8a-69e3ab73aa8a"
&Uuid="asdasd123-124sfas"
&Limit=10
&Offset=0
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "TotalCount": 21,
        "ShowRuleRemark": true,
        "BaselineRuleList": [
            {
                "RuleName": "Security detection item 1",
                "Description": "Security detection item 1 description",
                "FixMessage": "Restart the service",
                "Level": 1,
                "Status": 0,
                "RuleId": 1,
                "LastScanAt": "2020-09-16 : 00:00:00",
                "EventId": 1,
                "Uuid": "Uuid"
            }
        ]
    }
}

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
InvalidParameter Incorrect parameter.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy