tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTcssSummary

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

    1. API Description

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

    This API is used to query the TCSS overview.

    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: DescribeTcssSummary.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.

    3. Output Parameters

    Parameter Name Type Description
    ImageCnt Integer Total number of images
    ScannedImageCnt Integer Number of scanned images
    UnScannedImageCnt Integer Number of images to be scanned
    LocalImageCnt Integer Number of local images
    RepositoryImageCnt Integer Number of repository images
    RiskLocalImageCnt Integer Number of local images at risk
    RiskRepositoryImageCnt Integer Number of repository images at risk
    ContainerCnt Integer Number of containers
    RiskContainerCnt Integer Number of containers at risk
    ClusterCnt Integer Number of clusters
    RiskClusterCnt Integer Number of clusters at risk
    UnScannedVulCnt Integer Number of vulnerabilities to be scanned
    RiskVulCnt Integer Number of risk vulnerabilities
    UnScannedBaseLineCnt Integer Number of security baseline items to be scanned
    RiskBaseLineCnt Integer Number of security baseline risks
    RuntimeUnhandleEventCnt Integer Number of pending (high-risk) events at runtime
    UnScannedClusterCnt Integer Number of clusters to be scanned
    ScanImageStatus Boolean Whether images are scanned
    ScanClusterStatus Boolean Whether clusters are scanned
    ScanBaseLineStatus Boolean Whether baseline items are scanned
    ScanVulStatus Boolean Whether vulnerabilities are scanned for
    VulRiskImageCnt Integer Number of images affected by vulnerabilities
    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 TCSS overview

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "RiskLocalImageCnt": 1,
        "RiskRepositoryImageCnt": 1,
        "RuntimeUnhandleEventCnt": 1,
        "RiskBaseLineCnt": 1,
        "ScannedImageCnt": 1,
        "RiskVulCnt": 1,
        "RiskContainerCnt": 1,
        "ImageCnt": 1,
        "ContainerCnt": 1,
        "UnScannedVulCnt": 1,
        "UnScannedBaseLineCnt": 1,
        "RiskClusterCnt": 1,
        "ClusterCnt": 1,
        "UnScannedImageCnt": 1,
        "LocalImageCnt": 1,
        "RepositoryImageCnt": 1,
        "UnScannedClusterCnt": 1,
        "ScanImageStatus": true,
        "ScanClusterStatus": true,
        "ScanBaseLineStatus": true,
        "ScanVulStatus": true,
        "VulRiskImageCnt": 10,
        "RequestId": "29b37d86-f63d-43d1-b21a-640e82965198"
    }
}

    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
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy