查询容器实例列表

最近更新时间:2018-09-18 16:58:22

1. 接口描述

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

此接口(DescribeContainerInstances)查询容器实例列表

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeContainerInstances
Version String 公共参数,本接口取值:2018-04-08
Offset Integer 偏移量,默认为0
Limit Integer 返回数量,默认为10
Filters.N Array of Filter 过滤条件。
- Zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。
- VpcId - String - 是否必填:否 -(过滤条件)按照VpcId过滤。
- InstanceName - String - 是否必填:否 -(过滤条件)按照容器实例名称做模糊查询。

3. 输出参数

参数名称 类型 描述
ContainerInstanceList Array of ContainerInstance 容器实例列表
TotalCount Integer 容器实例总数
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 查询容器实例列表

输入示例

https://cis.tencentcloudapi.com/?Action=DescribeContainerInstances
&Offset=0&Limit=10
&Filters.0.Name=InstanceName
&Filters.0.ValueList.0=hello
&<公共请求参数>

输出示例

{
  "Response": {
    "ContainerInstanceList": [
      {
        "Containers": [
          {
            "Args": [
              "hello world"
            ],
            "Command": "echo",
            "ContainerId": "7aa85b70a3e1e1856718cbb7f1de0dba236272380da2854f059dd489d4d967cd",
            "Cpu": 0.25,
            "CurrentState": {
              "ExitCode": 0,
              "FinishTime": "2018-05-17 11:16:42",
              "Reason": "Completed",
              "StartTime": "2018-05-17 11:16:42",
              "State": "Terminated"
            },
            "EnvironmentVars": null,
            "Image": "alpine:latest",
            "Memory": 0.25,
            "Name": "helloworld",
            "PreviousState": null,
            "RestartCount": 0,
            "WorkingDir": null
          }
        ],
        "CreateTime": "2018-05-17 11:14:28",
        "InstanceId": "cis-h2ud12sa",
        "InstanceName": "helloworld",
        "LanIp": "10.0.2.11",
        "RestartPolicy": "Never",
        "StartTime": "2018-05-17 11:16:23",
        "State": "Succeeded",
        "SubnetCidr": "10.0.2.0/24",
        "SubnetId": "subnet-r0t1xm4e",
        "SubnetName": "zone4",
        "VpcCidr": "10.0.0.0/16",
        "VpcId": "vpc-3p4hvnmx",
        "VpcName": "ddtest",
        "Zone": "ap-guangzhou-4"
      },
      {
        "Containers": [
          {
            "Args": [
              "hello world"
            ],
            "Command": "echo",
            "ContainerId": "11e66fc00ed8c653e256ede6885a8b428731387443331eeef7f12d7f77ceaf39",
            "Cpu": 0.25,
            "CurrentState": {
              "ExitCode": 0,
              "FinishTime": "2018-05-18 14:41:11",
              "Reason": "Completed",
              "StartTime": "2018-05-18 14:41:11",
              "State": "Terminated"
            },
            "EnvironmentVars": null,
            "Image": "busybox:latest",
            "Memory": 0.25,
            "Name": "echo",
            "PreviousState": null,
            "RestartCount": 0,
            "WorkingDir": null
          }
        ],
        "CreateTime": "2018-05-18 14:40:57",
        "InstanceId": "cis-esmfjhek",
        "InstanceName": "helloworld2",
        "LanIp": "10.0.2.24",
        "RestartPolicy": "Never",
        "StartTime": "2018-05-18 14:40:57",
        "State": "Succeeded",
        "SubnetCidr": "10.0.2.0/24",
        "SubnetId": "subnet-r0t1xm4e",
        "SubnetName": "zone4",
        "VpcCidr": "10.0.0.0/16",
        "VpcId": "vpc-3p4hvnmx",
        "VpcName": "ddtest",
        "Zone": "ap-guangzhou-4"
      }
    ],
    "RequestId": "7695ee56-77d2-43b1-bc7d-d85f411d44c6",
    "TotalCount": 2
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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