淘宝开放平台

登录
文档中心 > 容器服务

容器服务

获取主机

更新时间：2016/08/08 访问次数：17000

获取所有主机信息

请求所有主机信息

请求地址

/api/v1/host

请求方法

GET

请求参数

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

返回示例

{
  "code": "0",
  "message": "success",
  "data": [
    {
      "id": 2826,
      "name": "",
      "instanceId": "",
      "internetIp": "",
      "intranetIp": "",
      "status": "WAIT4PAYMENT",
      "connectivity": false,
      "regionId": 7,
      "regionDisplay": "杭州",
      "cpu": 0,
      "memory": 0,
      "diskSize": 0
    },
    {
      "id": 3505,
      "name": "iZ231nj0uyyZ",
      "instanceId": "i-231nj0uyy",
      "internetIp": "xxx.x.xx.xxx",
      "intranetIp": "xxx.xxx.x.xx",
      "status": "OK",
      "connectivity": true,
      "regionId": 3,
      "regionDisplay": "杭州",
      "cpu": 2,
      "cpuUsed": 1,
      "memory": 15631,
      "memUsed": 948,
      "diskSize": 503837,
      "diskUsed": 5521,
      "containerCount": 0
    }
    ...
  ]
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->id Long 主机ID
data->name String 主机名字
data->instanceId String 主机实例ID
data->internetIp String 公网IP
data->intranetIp String 内网IP
data->status String 主机状态：
1. Ok ： 正常
2. ALLOCATING ：分配中
3. ALLOCATED ：已分配
4. STARTING ：启动中
5. STOPPING ：停止中
6. STOPPED ： 已停止
7. DELETING ： 删除中
8. DELETED ： 已删除
9. WAIT4PAYMENT ： 等待支付
data->connectivity Boolean 是否受控
data->regionId Long 区域ID
data->regionDisplay String 区域名字
data->cpu Integer cpu核数
data->cpuUsed Integer 已使用cpu核数
data->memory Integer 内存容量，单位MB
data->memUsed Integer 已使用内存，单位MB
data->diskSize Integer 磁盘大小，单位MB
data->diskUsed Integer 已使用磁盘大小，单位MB
data->containerCount Integer 容器数量

获取指定主机信息

根据指定的{host_id}获取主机信息

请求地址

/api/v1/host/{host_id}

请求方法

GET

请求参数

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

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "id": 3505,
    "name": "iZ231nj0uyyZ",
    "instanceId": "i-231nj0uyy",
    "internetIp": "xxx.xxx.xxx.xxx",
    "intranetIp": "xxx.xxx.xxx.xxx",
    "status": "OK",
    "connectivity": true,
    "regionId": 3,
    "regionDisplay": "杭州",
    "cpu": 2,
    "cpuUsed": 3,
    "memory": 15631,
    "memUsed": 949,
    "diskSize": 503837,
    "diskUsed": 5530,
    "containerCount": 0
  }
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->id Long 主机ID
data->name String 主机名字
data->instanceId String 主机实例ID
data->internetIp String 公网IP
data->intranetIp String 内网IP
data->status String 主机状态：
1. Ok ： 正常
2. ALLOCATING ：分配中
3. ALLOCATED ：已分配
4. STARTING ：启动中
5. STOPPING ：停止中
6. STOPPED ： 已停止
7. DELETING ： 删除中
8. DELETED ： 已删除
9. WAIT4PAYMENT ： 等待支付
data->connectivity Boolean 是否受控
data->regionId Long 区域ID
data->regionDisplay String 区域名字
data->cpu Integer cpu核数
data->cpuUsed Integer 已使用cpu核数
data->memory Integer 内存容量，单位MB
data->memUsed Integer 已使用内存，单位MB
data->diskSize Integer 磁盘大小，单位MB
data->diskUsed Integer 已使用磁盘大小，单位MB
data->containerCount Integer 容器数量

停止与启动主机日志监控

停止或者启动指定主机的日志监控

请求地址

/api/v1/host/{host_id}/monitor/{action}

请求方法

POST

请求参数

参数名 风格 类型 是否必须 示例 描述
host_id 路径（不参与签名计算） Long 是 1234 主机ID
action 路径（不参与签名计算） String 是 enable 停止或者启动主机日志监控(忽略大小写)
1. enable
2 disable
accesskey 参数 String 是 t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 是 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)

返回示例

{
  "code": "0",
  "message": "success"
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息

删除主机

删除指定的主机

请求地址

/api/v1/host/{host_id}/

请求方法

DELETE

请求参数

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

返回示例

{
  "code": "0",
  "message": "success"
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息

FAQ

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