tencent cloud

APIs

DescribeComplianceTaskPolicyItemSummaryList

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-06-10 17:03:57

1. API Description

Domain name for API request: tcss.intl.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 Filtering conditions.
  • Name string Detection item name.
  • ItemType string Detection item type.
  • RiskLevel string Risk level.
  • IsOpen int Enabling status.
  • 3. Output Parameters

    Parameter Name Type Description
    TaskId Integer Return the ID of the last compliance check task. This task is the source of the data display this time.
    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 Check Item Summary List of the Last Task

    Input Example

    POST / HTTP/1.1
    Host: tcss.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeComplianceTaskPolicyItemSummaryList
    <Common request parameters>
    
    {
        "Offset": 0,
        "Limit": 10,
        "Filters": [
            {
                "Name": "RiskLevel",
                "Values": [
                    "3",
                    "2",
                    "1",
                    "0"
                ],
                "ExactMatch": true
            },
            {
                "Name": "ItemType",
                "Values": [
                    "CATEGORY_DOCKER_RUNTIME"
                ],
                "ExactMatch": true
            }
        ],
        "AssetType": "ASSET_CONTAINER"
    }
    

    Output Example

    {
        "Response": {
            "PolicyItemSummaryList": [
                {
                    "ApplicableVersion": "docker 1.11-1.13, 17.12-20.10.2",
                    "AssetType": "ASSET_CONTAINER",
    "AuditProcedure": "Run the following command to perform checks\ndocker ps --quiet --all | xargs docker inspect --format '{{ .Id }}: Privileged={{ .HostConfig.Privileged }}'"
                    "BasePolicyItemId": 1,
                    "BenchmarkStandardId": 1,
                    "BenchmarkStandardName": "CIS Docker",
                    "Category": "CATEGORY_DOCKER_RUNTIME",
                    "CheckResult": "RESULT_FAILED",
                    "CheckStatus": "CHECK_FINISHED",
                    "CustomerPolicyItemId": 6190,
    "Description": "Enabling privileged permissions allows the container to possess most permissions of the underlying host. You should not use the parameter during container creation."
                    "FailedAssetCount": 29,
    "FixSuggestion": "Do not run containers with the --privileged flag. For example, do not start the following container: docker run --interactive --tty --privileged centos/bin/bash."
                    "IsEnable": 1,
                    "LastCheckTime": "2024-10-30 02:02:27",
    "Name": "Underwrite non-use of privilege container"
                    "PassedAssetCount": 210,
                    "RiskLevel": "3",
                    "WhitelistId": 0
                }
            ],
            "RequestId": "a9aae028-b4f8-4ec3-8f77-5c102c4b5fcf",
            "TaskId": 0,
            "TotalCount": 33
        }
    }
    

    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.

    Ajuda e Suporte

    Esta página foi útil?

    comentários