tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAssetSummary

Last updated: 2024-12-06 15:48:24

    1. API Description

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

    This API is used to query the statistics of containers and images under an account.

    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: DescribeAssetSummary.
    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
    AppCnt Integer Number of applications
    ContainerCnt Integer Number of containers
    ContainerPause Integer Number of paused containers
    ContainerRunning Integer Number of running containers
    ContainerStop Integer Number of stopped containers
    CreateTime String Creation time
    DbCnt Integer Number of databases
    ImageCnt Integer Number of images
    HostOnline Integer Number of online servers
    HostCnt Integer Number of servers
    ImageHasRiskInfoCnt Integer Number of images at risk
    ImageHasVirusCnt Integer Number of images with viruses
    ImageHasVulsCnt Integer Number of images with vulnerabilities
    ImageUntrustCnt Integer Number of untrusted images
    ListenPortCnt Integer Number of listened ports
    ProcessCnt Integer Number of processes
    WebServiceCnt Integer Number of web services
    LatestImageScanTime String Last image scan time
    ImageUnsafeCnt Integer Number of images at risk
    HostUnInstallCnt Integer Number of servers not installed with the agent
    SuperNodeCnt Integer Number of super nodes
    SuperNodeRunningCnt Integer Number of running super nodes
    TodayNewImageCnt Integer
    TodayUnsafeImageCnt Integer
    RecommendedFixImageCnt Integer
    ScannedImageCnt Integer
    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 statistics of containers and images under an account

    This example shows you how to query the statistics of containers and images under an account.

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "AppCnt": 1,
        "ContainerCnt": 1,
        "ContainerPause": 1,
        "ContainerRunning": 1,
        "ContainerStop": 1,
        "CreateTime": "abc",
        "DbCnt": 1,
        "ImageCnt": 1,
        "HostOnline": 1,
        "HostCnt": 1,
        "ImageHasRiskInfoCnt": 1,
        "ImageHasVirusCnt": 1,
        "ImageHasVulsCnt": 1,
        "ImageUntrustCnt": 1,
        "ListenPortCnt": 1,
        "ProcessCnt": 1,
        "WebServiceCnt": 1,
        "LatestImageScanTime": "abc",
        "ImageUnsafeCnt": 1,
        "HostUnInstallCnt": 1,
        "SuperNodeCnt": 1,
        "SuperNodeRunningCnt": 1,
        "RequestId": "abc"
    }
}

    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.
    InvalidParameter.ParsingError A parameter parsing error occurred.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy