tencent cloud

All product documents
APIs
DocumentationAPIsTencent Container Security ServiceSecurity Compliance APIsDescribeComplianceAssetPolicyItemList
DescribeComplianceAssetPolicyItemList
Last updated: 2025-03-11 22:55:58
DescribeComplianceAssetPolicyItemList
Last updated: 2025-03-11 22:55:58

1. API Description

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

This API is used to query the list of check items of an asset.

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: DescribeComplianceAssetPolicyItemList.
Version Yes String Common Params. The value used for this API: 2020-11-01.
Region No String Common Params. This parameter is not required.
CustomerAssetId Yes Integer Customer asset ID
Offset No Integer Initial offset. Default value: 0.
Limit No Integer Number of results to be obtained. Default value: 10. Maximum value: 100.
Filters.N No Array of ComplianceFilters Filter list, which is supported by the Name field.
RiskLevel

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of check items, which is 0 if the baseline check is not enabled.
AssetPolicyItemList Array of ComplianceAssetPolicyItem List of check items of an asset
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 Requesting the Asset Detection Item List

This example shows you how to request the asset detection item list.

Input Example

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

{
    "CustomerAssetId": 2202462,
    "Offset": 0,
    "Limit": 3
}

Output Example

{
    "Response": {
        "AssetPolicyItemList": [
            {
                "BasePolicyItemId": 142,
                "BenchmarkStandardId": 1,
                "BenchmarkStandardName": "CIS Docker",
                "Category": "CATEGORY_DOCKER_RUNTIME",
                "CheckResult": "RESULT_PASSED",
                "CheckStatus": "CHECK_FINISHED",
                "CustomerPolicyItemId": 2809,
                "FixSuggestion": "Use --health-cmd and other parameters to run a container, such as docker run -d --health-cmd ='stat /etc/passwd || exit1'nginx.",
                "LastCheckTime": "2024-07-24 11:12:16",
                "Name": "Check the health status of a running container",
                "RiskLevel": "1",
                "VerifyInfo": "e822238a07e0d193a12c0608f2d821812664d3d9cf5871cc9bedc9eab562e602:Healthcheck=null\n",
                "WhitelistId": 0
            },
            {
                "BasePolicyItemId": 141,
                "BenchmarkStandardId": 1,
                "BenchmarkStandardName": "CIS Docker",
                "Category": "CATEGORY_DOCKER_RUNTIME",
                "CheckResult": "RESULT_PASSED",
                "CheckStatus": "CHECK_FINISHED",
                "CustomerPolicyItemId": 2808,
                "FixSuggestion": "Do not use --cgroup-parent to run in docker if there is no need.",
                "LastCheckTime": "2024-07-24 11:12:16",
                "Name": "Ensure the secure use of cgroup",
                "RiskLevel": "1",
                "VerifyInfo": "e822238a07e0d193a12c0608f2d821812664d3d9cf5871cc9bedc9eab562e602:CgroupParent=\n",
                "WhitelistId": 0
            },
            {
                "BasePolicyItemId": 140,
                "BenchmarkStandardId": 1,
                "BenchmarkStandardName": "CIS Docker",
                "Category": "CATEGORY_DOCKER_RUNTIME",
                "CheckResult": "RESULT_PASSED",
                "CheckStatus": "CHECK_FINISHED",
                "CustomerPolicyItemId": 2807,
                "FixSuggestion": "Do not use --privileged in the docker exec command.",
                "LastCheckTime": "2024-07-24 11:12:16",
                "Name": "Ensure no privileged option in the docker exec command",
                "RiskLevel": "2",
                "VerifyInfo": "e822238a07e0d193a12c0608f2d821812664d3d9cf5871cc9bedc9eab562e602:ExecIDs=null\n",
                "WhitelistId": 0
            }
        ],
        "RequestId": "dc08e10e-5ac8-4e94-9321-6c2f89d8ed5c",
        "TotalCount": 24
    }
}

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.
InvalidParameter.MissingParameter The required parameter is missing.
OperationDenied The operation was denied.
RequestLimitExceeded The number of requests exceeds the frequency limit.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon