容器服务查询容器实例-弹性容器实例相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： tke.tencentcloudapi.com 。

查询容器实例

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeEKSContainerInstances。
Version	是	String	公共参数，本接口取值：2018-05-25。
Region	是	String	公共参数，详见产品支持的地域列表。
Limit	否	Integer	限定此次返回资源的数量。如果不设定，默认返回20，最大不能超过100 示例值：20
Offset	否	Integer	偏移量,默认0 示例值：0
Filters.N	否	Array of Filter	过滤条件，可条件： (1)实例名称 KeyName: eks-ci-name 类型：String (2)实例状态 KeyName: status 类型：String 可选值："Pending", "Running", "Succeeded", "Failed" (3)内网ip KeyName: private-ip 类型：String (4)EIP地址 KeyName: eip-address 类型：String (5)VpcId KeyName: vpc-id 类型：String
EksCiIds.N	否	Array of String	容器实例 ID 数组示例值：["eksci-1cghhuuu"]

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	容器组总数示例值：20
EksCis	Array of EksCi	容器组列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询容器实例

输入示例

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

{
    "EksCiIds": [
        "eksci-6mr3o7eu"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "34d9ea5a-6e9e-4384-88da-84229e133412",
        "TotalCount": 1,
        "EksCis": [
            {
                "EksCiId": "eksci-iu09upos",
                "EksCiName": "未命名",
                "Memory": 2,
                "Cpu": 1,
                "SecurityGroupIds": [
                    "sg-1cghduvc"
                ],
                "RestartPolicy": "Always",
                "VpcId": "vpc-1cghduvc",
                "SubnetId": "subnet-1cghduvc",
                "Status": "Running",
                "CreationTime": "2021-06-24 03:32:02 +0000 UTC",
                "SucceededTime": "2021-06-24 11:32:21 +0000 UTC",
                "Containers": [
                    {
                        "Image": "ccr.ccs.tencentyun.com/ploto/cputest:1.4",
                        "Name": "simple-cputest",
                        "Cpu": 0,
                        "Memory": 0,
                        "Commands": [
                            "sleep"
                        ],
                        "Args": [
                            "100000"
                        ],
                        "EnvironmentVars": [],
                        "CurrentState": {
                            "StartTime": "2021-06-24 03:32:43.420750215 +0000 UTC",
                            "State": "running",
                            "FinishTime": "0001-01-01 00:00:00 +0000 UTC",
                            "ExitCode": 0,
                            "Reason": "",
                            "Message": "",
                            "RestartCount": 0
                        },
                        "RestartCount": 0,
                        "WorkingDir": "",
                        "ReadinessProbe": null,
                        "VolumeMounts": null,
                        "GpuLimit": null,
                        "LivenessProbe": null,
                        "SecurityContext": null
                    }
                ],
                "InitContainers": null,
                "EksCiVolume": {
                    "CbsVolumes": null,
                    "NfsVolumes": null
                },
                "SecurityContext": null,
                "PrivateIp": "10.1.0.1",
                "EipAddress": "",
                "CpuType": "amd,intel",
                "GpuType": "",
                "GpuCount": 0,
                "CamRoleName": "",
                "AutoCreatedEipId": "eni-l6gtb5p0",
                "PersistStatus": false
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.RBACForbidden	子账户RBAC权限不足。
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceNotFound	资源不存在。