淘宝开放平台

登录
文档中心 > 容器服务

容器服务

获取容器信息

更新时间：2018/04/19 访问次数：14958

获取所有容器信息

请求所有的容器信息

请求地址

/api/v1/container

请求方法

GET

请求参数

参数名 风格 类型 是否必须 示例 描述
accesskey 参数 String 是 t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 是 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)

返回示例

{
  "code": "0",
  "message": "success",
  "data": [
    {
      "id": 2529,
      "nodeId": 1418,
      "status": "ALLOCATED",
      "createTime": "2016-01-28 14:22:35",
      "startTime": "",
      "stopTime": "",
      "hostId": 301,
      "cpu": 0,
      "mem": 1024,
      "disk": 10240,
      "health": ""
    },
    {
      "id": 2577,
      "nodeId": 1462,
      "status": "RUNNING",
      "createTime": "2016-01-29 13:09:07",
      "startTime": "2016-01-29 13:58:58",
      "stopTime": "",
      "hostId": 301,
      "cpu": 0,
      "mem": 1024,
      "disk": 10240,
      "health": ""
    }
    ...
  ]
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->id Long 容器ID
data->nodeId Long 容器所在节点ID
data->status String 容器状态：
1. ALLOCATING ： 主机的资源还在分配中
2. ALLOCATED ：已分配
3. STARTING ：启动中
4. RUNNING 运行中
5. FAIL ：
6. RUNFAILED ： 启动失败, docker进程存在
7. STARTFAILED ： 启动失败, docker进程也不存在
8. STOPPING ： 停止中
9. STOPPED ： 已停止
10. LOGIN ： 登录
11. STOPFAILED ： 停止失败
data->createTime String 容器创建时间
data->startTime String 容器启动时间
data->stopTime String 容器停止时间
data->hostId Long 容器所在主机ID
data->cpu Integer 容器使用的CPU核数, -1表示共享
data->mem Integer 容器使用的内存大小, 单位MB
data->disk Integer 容器使用的磁盘大小, 单位MB
data->health String 容器健康状态

获取所有容器信息

请求某一个容器的信息

请求地址

/api/v1/container/{container_id}

请求方法

GET

请求参数

参数名 风格 类型 是否必须 示例 描述
container_id 路径（不参与签名计算） Long 是 242 容器ID
accesskey 参数 String 是 t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 是 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "id": 2529,
    "nodeId": 1418,
    "status": "ALLOCATED",
    "createTime": "2016-01-28 14:22:35",
    "startTime": "",
    "stopTime": "",
    "hostId": 301,
    "cpu": 0,
    "mem": 1024,
    "disk": 10240,
    "health": ""
  }
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->id Long 容器ID
data->nodeId Long 容器所在节点ID
data->status String 容器状态：
1. ALLOCATING ： 主机的资源还在分配中
2. ALLOCATED ：已分配
3. STARTING ：启动中
4. RUNNING 运行中
5. FAIL ：
6. RUNFAILED ： 启动失败, docker进程存在
7. STARTFAILED ： 启动失败, docker进程也不存在
8. STOPPING ： 停止中
9. STOPPED ： 已停止
10. LOGIN ： 登录
11. STOPFAILED ： 停止失败
data->createTime String 容器创建时间
data->startTime String 容器启动时间
data->stopTime String 容器停止时间
data->hostId Long 容器所在主机ID
data->cpu Integer 容器使用的CPU核数, -1表示共享
data->mem Integer 容器使用的内存大小, 单位MB
data->disk Integer 容器使用的磁盘大小, 单位MB
data->health String 容器健康状态

启动容器

启动指定的容器

请求地址

/api/v1/container/{container_id}/start

请求方法

POST

请求参数

参数名 风格 类型 是否必须 示例 描述
container_id 路径（不参与签名计算） Long 是 242 容器ID
accesskey 参数 String 是 t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 是 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "commandId": "ec8364b4-6c58-4c42-b410-c77d3aa0a5fe",
    "name": "container_start",
    "status": "CREATED",
    "result": "",
    "resultMsg": "",
    "createTime": "2016-06-27 11:04:44",
    "endTime": "",
    "activitys": []
  }
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->commandId String 指令ID
data->name String 指令名字
data->status String 指令状态：
1. CREATED ： 已经写入但还没有发布指令
2. PUBLISHED ：发布指令成功
3. PUBLISH_FAILED ： 发布指令失败
4. RUNNING ：指令运行中
5. DONE ：运行结束
data->result String 指定执行结果，200表示成功
data->resultMsg String 指令执行结果消息
data->createTime String 指令创建时间
data->endTime String 指令执行时间
data->activitys 指令的一系列执行活动，需要使用当前指令ID,调用Command API获取指令执行信息

停止容器

停止指定的容器

请求地址

/api/v1/container/{container_id}/stop

请求方法

POST

请求参数

参数名 风格 类型 是否必须 示例 描述
container_id 路径（不参与签名计算） Long 是 242 容器ID
accesskey 参数 String 是 t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 是 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "commandId": "ddee2904-a0a9-46b3-9c23-82ebd4f2db6e",
    "name": "container_stop",
    "status": "CREATED",
    "result": "",
    "resultMsg": "",
    "createTime": "2016-06-27 11:02:15",
    "endTime": "",
    "activitys": []
  }
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->commandId String 指令ID
data->name String 指令名字
data->status String 指令状态：
1. CREATED ： 已经写入但还没有发布指令
2. PUBLISHED ：发布指令成功
3. PUBLISH_FAILED ： 发布指令失败
4. RUNNING ：指令运行中
5. DONE ：运行结束
data->result String 指定执行结果，200表示成功
data->resultMsg String 指令执行结果消息
data->createTime String 指令创建时间
data->endTime String 指令执行时间
data->activitys 指令的一系列执行活动，需要使用当前指令ID,调用Command API获取指令执行信息

删除容器

删除指定的容器

请求地址

/api/v1/container/{container_id}

请求方法

DELETE

请求参数

参数名 风格 类型 是否必须 示例 描述
container_id 路径（不参与签名计算） Long 是 242 容器ID
accesskey 参数 String 是 t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 是 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "commandId": "f3bdc169-6243-40ed-a95d-92a8ceaa9836",
    "name": "container_delete",
    "status": "CREATED",
    "result": "",
    "resultMsg": "",
    "createTime": "2016-06-27 11:07:17",
    "endTime": "",
    "activitys": []
  }
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->commandId String 指令ID
data->name String 指令名字
data->status String 指令状态：
1. CREATED ： 已经写入但还没有发布指令
2. PUBLISHED ：发布指令成功
3. PUBLISH_FAILED ： 发布指令失败
4. RUNNING ：指令运行中
5. DONE ：运行结束
data->result String 指定执行结果，200表示成功
data->resultMsg String 指令执行结果消息
data->createTime String 指令创建时间
data->endTime String 指令执行时间
data->activitys 指令的一系列执行活动，需要使用当前指令ID,调用Command API获取指令执行信息

FAQ

关于此文档暂时还没有FAQ
有用(0) 我要提问
返回
顶部