tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeComplianceTaskPolicyItemSummaryList

Last updated: 2024-07-22 11:03:19

    1. API Description

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

    This API is used to query the list of aggregated information of check items identified in the last task in line with the "check item + asset" two-level structure.

    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: DescribeComplianceTaskPolicyItemSummaryList.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    AssetType No String Asset type, which indicates to only query check items related to the specified asset type.

    ASSET_CONTAINER: Container.

    ASSET_IMAGE: Image.

    ASSET_HOST: Server.

    ASSET_K8S: K8s asset.
    Offset No Integer Initial offset. Default value: 0.
    Limit No Integer Number of results to be returned. Default value: 10. Maximum value: 100.
    Filters.N No Array of ComplianceFilters Filter
    Name - String
    Name. Valid values: ItemType, StandardId, RiskLevel.
    ClusterName is also available for K8s assets.

    3. Output Parameters

    Parameter Name Type Description
    TaskId Integer ID of the last compliance check task, which is the source of the displayed data.
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number of check items
    PolicyItemSummaryList Array of CompliancePolicyItemSummary List of the aggregated information of each check item
    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 list of aggregated information of the check items in the last task

    Input Example

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

{
    "AssetType": "ASSET_CONTAINER"
}

    Output Example

    {
    "Response": {
        "RequestId": "xxxxx",
        "TaskId": 123456,
        "TotalCount": 123,
        "PolicyItemSummaryList": [
            {
                "CustomerPolicyItemId": 10001,
                "BasePolicyItemId": 1,
                "Name": "Docker file and directory audit",
                "Category": "xxx",
                "BenchmarkStandardName": "CIS_Docker",
                "BenchmarkStandardId": 123,
                "RiskLevel": "xx",
                "AssetType": "xxx",
                "LastCheckTime": "2020-09-22 00:00:00",
                "CheckStatus": "CHECK_FINISHED",
                "CheckResult": "xx",
                "PassedAssetCount": 100,
                "FailedAssetCount": 20,
                "WhitelistId": 12345,
                "FixSuggestion": "xxxx"
            }
        ]
    }
}

    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
    AuthFailure A CAM signature/authentication error occurred.
    FailedOperation The operation failed.
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    OperationDenied The operation was denied.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    UnauthorizedOperation The operation is unauthorized.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy