tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeContainerAssetSummary

Last updated: 2023-12-04 17:12:51

    1. API Description

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

    This API is used to query the asset 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: DescribeContainerAssetSummary.
    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
    ContainerTotalCnt Integer Total number of containers
    ContainerRunningCnt Integer Number of running containers
    ContainerPauseCnt Integer Number of suspended containers
    ContainerStopped Integer Number of stopped containers
    ImageCnt Integer Number of local images
    HostCnt Integer Number of server nodes
    HostRunningCnt Integer Number of running nodes on the server
    HostOfflineCnt Integer Number of offline nodes on the server
    ImageRegistryCnt Integer Number of image repositories
    ImageTotalCnt Integer Total number of images
    HostUnInstallCnt Integer Number of servers not installed with the agent
    HostSuperNodeCnt Integer Number of super nodes
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the container assets

    This example shows you how to query the container assets.

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "ContainerTotalCnt": 1,
        "ContainerRunningCnt": 1,
        "ContainerPauseCnt": 1,
        "ContainerStopped": 1,
        "ImageCnt": 1,
        "HostCnt": 1,
        "HostRunningCnt": 1,
        "HostOfflineCnt": 1,
        "ImageRegistryCnt": 1,
        "ImageTotalCnt": 1,
        "HostUnInstallCnt": 1,
        "HostSuperNodeCnt": 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.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy