帮你快速理解、总结文档立即下载

创建Pod关联容器列表导出任务

最近更新时间:2026-08-20 01:44:04
我的收藏

1. 接口描述

接口请求域名: csip.tencentcloudapi.com 。

创建Pod关联容器列表导出任务。导出字段包含容器ID、容器名称、运行状态、节点ID、节点类型、镜像ID、镜像名称、隔离状态。支持Filter过滤。导出通过异步任务实现,返回JobId后前端轮询查询导出任务状态。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreatePodContainerListExportJob。
Version String 公共参数,本接口取值:2022-11-21。
Region String 公共参数,此参数为可选参数。
MemberId.N Array of String

集团账号的成员id


示例值:["mem-tencent-6f5795752f66e429"]
PodUniqueID String

Pod唯一ID


示例值:pod-unique-id-12345
ClusterCaMD5 String

集群CA证书MD5(用于查节点信息)


示例值:a1b2c3d4e5f6789012345678901234ab
Filter Filter

通用过滤条件列表。支持的过滤字段:
ContainerId:容器ID,精确匹配。
ContainerName:容器名称,模糊匹配。
RunStatus:容器运行状态,精确匹配。取值:RUNNING、PAUSED、STOPPED、CREATED、DESTROYED、RESTARTING、REMOVING、DEAD、UNKNOWN。
ImageId:镜像ID,精确匹配。
ImageName:镜像名称,模糊匹配。
IsolateStatus:隔离状态,精确匹配。取值:NORMAL(未隔离)、ISOLATED(已隔离)、ISOLATING(隔离中)、ISOLATE_FAILED(隔离失败)、RESTORING(解除隔离中)、RESTORE_FAILED(解除隔离失败)。
NodeUniqueId:所属节点唯一ID,精确匹配(NodeAssetId 为等价别名)。
UUID:主机UUID,精确匹配。

ExportFields.N Array of String

导出字段列表(不传则导出全部字段)
枚举值:
ContainerId:容器ID
ContainerName:容器名称
RunStatus:运行状态
NodeId:节点ID
NodeType:节点类型
ImageId:镜像ID
ImageName:镜像名称
IsolateStatus:隔离状态


示例值:["ContainerId","ContainerName","RunStatus"]

3. 输出参数

参数名称 类型 描述
JobId String

导出任务ID
取值参考:前端轮询导出任务状态时使用


示例值:export-job-67890
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建Pod关联容器列表导出任务示例

输入示例

POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePodContainerListExportJob
<公共请求参数>

{
    "ClusterCaMD5": "a1b2c3d4e5f6789012345678901234ab",
    "PodUniqueID": "pod-unique-id-12345",
    "Filter": {
        "Filters": [
            {
                "Name": "RunStatus",
                "Values": [
                    "Running"
                ]
            }
        ]
    },
    "ExportFields": [
        "ContainerId",
        "ContainerName",
        "RunStatus",
        "NodeId",
        "NodeType",
        "ImageId",
        "ImageName",
        "IsolateStatus"
    ]
}

输出示例

{
    "Response": {
        "JobId": "export-job-67890",
        "RequestId": "5cd96106-1d72-466c-9bcf-9876543210ab"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。