DescribeCompliancePolicyItemAffectedSummary

Download PDF

Last updated: 2024-12-06 15:46:50

Last updated: 2024-12-06 15:46:50

Download PDF

1. API Description

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

This API is used to apply the check item level in 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: DescribeCompliancePolicyItemAffectedSummary.
Version	Yes	String	Common Params. The value used for this API: 2020-11-01.
Region	No	String	Common Params. This parameter is not required.
CustomerPolicyItemId	Yes	Integer	`CustomerPolicyItemId` returned by `DescribeComplianceTaskPolicyItemSummaryList`, which indicates the check item ID.

3. Output Parameters

Parameter Name	Type	Description
PolicyItemSummary	CompliancePolicyItemSummary	Aggregated information of the assets affected by 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 information affected by a check item

Input Example

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

{
    "CustomerPolicyItemId": 12345
}

Output Example

{
    "Response": {
        "RequestId": "xxxxx",
        "PolicyItemSummary": {
            "CustomerPolicyItemId": 10001,
            "BasePolicyItemId": 1,
            "Name": "Docker file and directory audit",
            "Category": "xxx",
            "BenchmarkStandardName": "CIS_Docker",
            "BenchmarkStandardId": 123,
            "RiskLevel": "xx",
            "AssetType": "xxx",
            "CheckStatus": "",
            "CheckResult": "xx",
            "LastCheckTime": "2020-09-22 00:00:00",
            "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

Tencent Cloud CLI 3.0

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud