tencent cloud

APIs

DocumentationAPIsCloud Security CenterContainer Asset Management APIsDescribePodContainerList

DescribePodContainerList

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

1. API Description

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

Query the container list associated with a Pod

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

Group account member id
PodUniqueID No String

Pod unique ID
Filter No Filter

List of common filter criteria. Supported filter fields:
ContainerId: container ID, exact match.
ContainerName: container name, fuzzy match.
RunStatus: container running status, exact match. Values: RUNNING, PAUSED, STOPPED, CREATED, DESTROYED, RESTARTING, REMOVING, DEAD, UNKNOWN.
ImageId: image ID, exact match.
ImageName: image name, fuzzy match.
IsolateStatus: isolation status, exact match. Values: NORMAL (unisolated), ISOLATED (isolated), ISOLATING (being isolated), ISOLATE_FAILED (isolation failed), RESTORING (restoring isolation), RESTORE_FAILED (isolation removal failed).
NodeUniqueId: unique ID of the node it belongs to, exact match (NodeAssetId is an equivalent alias).
UUID: host UUID, exact match.
NodeId: instance ID of the node it belongs to, exact match.
NodeType: node type, exact match. Values: SUPER, MASTER, WORKER.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

Total number of query results
List Array of ClusterContainerListItem

Result list
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 Query the container list associated with a Pod

Input Example

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

{
    "PodUniqueID": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
    "Filter": {
        "Limit": 10,
        "Offset": 0
    }
}

Output Example

{
    "Response": {
        "TotalCount": 100,
        "List": [
            {
                "AppID": 1300448058,
                "AssetId": "",
                "ContainerId": "container-abc123",
                "ContainerName": "nginx",
                "RunStatus": "RUNNING",
                "NodeId": "ins-x08b",
                "NodeType": "CVM",
                "PodUid": "pod-uid-001",
                "PodName": "nginx-pod",
                "ImageId": "sha256:abc",
                "ImageName": "nginx:latest"
            }
        ],
        "RequestId": "12345cef-0bf7-4020-a6e8-b1f1ae4de7e2"
    }
}

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: UpdateClusterOwnerNext Topic: DescribeClusterPodDetail

Help and Support

Was this page helpful?

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

Feedback