tencent cloud

APIs

DocumentationAPIsCloud Security CenterContainer Asset Management APIsDescribeClusterContainerDetail

DescribeClusterContainerDetail

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:11:03

1. API Description

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

This API is used to query cluster container details. It retrieves basic container info, mirror information, mount information, network info, and associated node information by container ID.

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

Container ID
MemberId.N No Array of String

Group account member id

3. Output Parameters

Parameter Name Type Description
AppID Integer

Primary Account AppID
ContainerId String

Container ID
Cmd String

Container startup CMD
CreateTime Timestamp ISO8601

Container creation time
RunStatus String

Running state
IsolateStatus String

Isolation status
ImageName String

Image name.
ImageId String

Image ID.
ImageSize String

Image size.
ImageCreateTime String

Image creation time
NodeName String

Node name.
NodeInternalIP String

Node private network IP
NodeRunStatus String

Node running status
Mounts Array of ContainerMountItem

Mount information list
NetworkName String

Network name
NetworkMode String

Network mode
NetworkId String

Network ID
EndpointId String

Endpoint ID
Gateway String

Gateway address
IPv4 String

IPv4 address
IPv6 String

IPv6 address
MAC String

MAC address
ContainerName String

Container name
NodeInstanceId String

Node instance ID
NodeType String

Node type of the container associated node
NodeUniqueID String

Unique ID of the node associated with the container
ClusterCaMD5 String

md5 value of the cluster ca certificate of the associated cluster and unique identifier of the cluster
EnableLinkImage Boolean

Whether the container image can be associated with records in the mirror repository
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 1

Input Example

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

{
    "ContainerId": "1ea61132******************a320a93772*****************2fd66091e4d",
    "MemberId": [
        "mem-tencent-********2f66e429"
    ]
}

Output Example

{
    "Response": {
        "AppID": 260083796,
        "ClusterCaMD5": "814fe16************f9129471e26ae",
        "Cmd": "",
        "ContainerId": "1ea611******************efa320a937724ebaca98fb413c6082fd66091e4d",
        "ContainerName": "yunjing-agent",
        "CreateTime": "2026-07-29T11:43:52+08:00",
        "ImageCreateTime": "2026-07-22T20:03:36+08:00",
        "ImageId": "sha256:94cc7bb42e2b7e536778b404262db678f09a4167773cc62ec4834a55dd625645",
        "ImageName": "ccr.ccs.tencentyun.com/yunjing_agent/agent:dev-latest",
        "ImageSize": "36.28MB",
        "IsolateStatus": "NORMAL",
        "Mounts": [],
        "NodeInstanceId": "eks-3pwtyur9",
        "NodeInternalIP": "172.16.0.224",
        "NodeName": "cls-pde9e0s0_np-7i5wo9qa-cwvq7",
        "NodeRunStatus": "Running",
        "NodeType": "WORKER",
        "NodeUniqueID": "ef616f81***************e824b4502",
        "RunStatus": "RUNNING",
        "RequestId": "680bbd5f-8f84-4b47-81fa-f6778b86dccc"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Previous Topic: DescribeClusterContainerPortListNext Topic: DescribeClusterContainerProcessList

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback