tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBaselineStrategyDetail

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

1. API Description

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

This API is used to query policy details by baseline policy 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: DescribeBaselineStrategyDetail.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
StrategyId Yes Integer User baseline policy ID

3. Output Parameters

Parameter Name Type Description
PassRate Integer Policy scan pass rate
Note: This field may return null, indicating that no valid values can be obtained.
StrategyName String Policy name
Note: This field may return null, indicating that no valid values can be obtained.
ScanCycle String policy scan cycle (days)
Note: This field may return null, indicating that no valid values can be obtained.
ScanAt String Regular scan time. The scan task is triggered at this time.
Note: This field may return null, indicating that no valid values can be obtained.
IsGlobal Integer Whether all hosts are scanned. 1: yes; 0: no. If the value is 1, all Pro Edition hosts are scanned.Note: This field may return null, indicating that no valid values can be obtained.
MachineType String Machine type:
cvm: Tencent Cloud Virtual Machine
bm: BM
ecm: Edge Computing Machine
lh: Lighthouse
other: Hybrid Cloud Machine
Note: This field may return null, indicating that no valid values can be obtained.
Region String Host region
Note: This field may return null, indicating that no valid values can be obtained.
Quuids Array of String IDs of all user hosts involved in this policy
Note: This field may return null, indicating that no valid values can be obtained.
CategoryIds Array of String IDs of all user baselines involved in this policy
Note: This field may return null, indicating that no valid values can be obtained.
IfScanned Integer 1: scanned; 0: not scanned.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 Policy Details

This example shows you how to query details of a policy by policy ID.

Input Example

https://cwp.intl.tencentcloudapi.com/?Action=DescribeBaselineStrategyDetail
&StrategyId=1
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "req-566234234",
        "PassRate": 50,
        "StrategyName": "Policy of level-1 classified protection of cyber security",
        "ScanCycle": 1,
        "ScanAt": "00:00:00",
        "IsGlobal": 1,
        "IfScanned": 1,
        "MachineType": "cvm",
        "Region": "ap-bj",
        "Quuids": [
            "2001",
            "2002",
            "2003"
        ],
        "CategoryIds": [
            1,
            2,
            3
        ]
    }
}

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.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy