DescribeComplianceScanFailedAssetList

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

1. API Description

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

This API is used to query the aggregate information of the pass rate at the asset level, the first level in the "asset + check item" 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: DescribeComplianceScanFailedAssetList.
Version	Yes	String	Common Params. The value used for this API: 2020-11-01.
Region	No	String	Common Params. This parameter is not required.
AssetTypeSet.N	No	Array of String	List of asset types `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. Default value: `10`. Maximum value: `100`.
Filters.N	No	Array of ComplianceFilters	Query filter

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of assets that failed the check
ScanFailedAssetList	Array of ComplianceScanFailedAsset	List of aggregated information of each type of asset that failed the check 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 the list of assets that failed the last check

Input Example

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

{
    "AssetTypeSet": [
        "ASSET_CONTAINER"
    ],
    "Offset": 0,
    "Limit": 10
}

Output Example

{
    "Response": {
        "RequestId": "xxxxx",
        "TotalCount": 1,
        "ScanFailedAssetList": [
            {
                "CustomerAssetId": 123456789,
                "AssetType": "ASSET_CONTAINDER",
                "AssetName": "happy-jenkins",
                "CheckStatus": "CHECK_FINISHED",
                "CheckTime": "2021-04-02 16:42:00",
                "FailureReason": "Something unexpected happened",
                "Suggestion": "Try again"
            }
        ]
    }
}

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.

tencent cloud

Recent Pages