注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > 云服务(EWS)说明

获取节点信息

更新时间:2016/07/26 访问次数:9789

获取所有节点信息

请求获取所有节点信息

请求地址

/api/v1/node

请求方法

GET

请求参数

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

返回示例

{
  "code": "0",
  "message": "success",
  "data": [
    {
      "id": 610474,
      "name": "正式环境",
      "imageName": "registry.acs.aliyun.com/open/tomcat7:3.0.0",
      "status": "RUNNING",
      "serviceId": 12209,
      "createTime": "2016-06-23 17:56:00",
      "containers": [
        {
          "id": 16634,
          "nodeId": 610474,
          "status": "RUNNING",
          "createTime": "2016-06-23 17:56:01",
          "startTime": "2016-06-23 17:57:55",
          "stopTime": "",
          "hostId": 3505,
          "cpu": 0,
          "mem": 1024,
          "disk": 10240,
          "health": ""
        },
        {
          "id": 16636,
          "nodeId": 610474,
          "status": "RUNNING",
          "createTime": "2016-06-23 18:29:00",
          "startTime": "2016-06-23 18:57:58",
          "stopTime": "2016-06-23 18:37:39",
          "hostId": 3505,
          "cpu": 0,
          "mem": 1024,
          "disk": 10240,
          "health": ""
        }
      ]
    }
    ...
  ]
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->id Long 节点ID
data->name Long 节点名字,节点主要分为线下,预发,线上
data->imageName Long 节点镜像名字,和服务镜像名字相同
data->status String 节点状态:
1. CREATED : 已创建
2. RUNNING :运行中
3. STOPPED : 已停止
4. DELETING :删除中
data->serviceId Long 节点所在服务ID
data->createTime String 节点创建时间
data->containers->id Long 容器ID
data->containers->nodeId Long 容器所在节点ID
data->containers->status String 容器状态:
1. ALLOCATING : 表示主机的资源还在分配中
2. ALLOCATED :已分配
3. STARTING :启动中
4. RUNNING 运行中
5. FAIL :
6. RUNFAILED : 已停止
7. STARTFAILED : 删除中
8. STOPPING : 已删除
9. STOPPED : 等待支付
10. LOGIN : 等待支付
11. STOPFAILED : 等待支付
data->containers->createTime String 容器创建时间
data->containers->startTime String 容器启动时间
data->containers->stopTime String 容器停止时间
data->containers->hostId Long 容器所在主机ID
data->containers->cpu Integer 容器使用的CPU核数, -1表示共享
data->containers->mem Integer 容器使用的内存大小, 单位MB
data->containers->disk Integer 容器使用的磁盘大小, 单位MB
data->containers->health String 容器健康状态

获取指定节点信息

请求获取指定节点信息

请求地址

/api/v1/node/{node_id}

请求方法

GET

请求参数

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

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "id": 610474,
    "name": "正式环境",
    "imageName": "registry.acs.aliyun.com/open/tomcat7:3.0.0",
    "status": "RUNNING",
    "serviceId": 12209,
    "createTime": "2016-06-23 17:56:00",
    "containers": [
      {
        "id": 16634,
        "nodeId": 610474,
        "status": "RUNNING",
        "createTime": "2016-06-23 17:56:01",
        "startTime": "2016-06-23 17:57:55",
        "stopTime": "",
        "hostId": 3505,
        "cpu": 0,
        "mem": 1024,
        "disk": 10240,
        "health": ""
      },
      {
        "id": 16636,
        "nodeId": 610474,
        "status": "RUNNING",
        "createTime": "2016-06-23 18:29:00",
        "startTime": "2016-06-23 18:57:58",
        "stopTime": "2016-06-23 18:37:39",
        "hostId": 3505,
        "cpu": 0,
        "mem": 1024,
        "disk": 10240,
        "health": ""
      }
    ]
  }
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->id Long 节点ID
data->name Long 节点名字,节点主要分为线下,预发,线上
data->imageName Long 节点镜像名字,和服务镜像名字相同
data->status String 节点状态:
1. CREATED : 已创建
2. RUNNING :运行中
3. STOPPED : 已停止
4. DELETING :删除中
data->serviceId Long 节点所在服务ID
data->createTime String 节点创建时间
data->containers->id Long 容器ID
data->containers->nodeId Long 容器所在节点ID
data->containers->status String 容器状态:
1. ALLOCATING : 表示主机的资源还在分配中
2. ALLOCATED :已分配
3. STARTING :启动中
4. RUNNING 运行中
5. FAIL :
6. RUNFAILED : 已停止
7. STARTFAILED : 删除中
8. STOPPING : 已删除
9. STOPPED : 等待支付
10. LOGIN : 等待支付
11. STOPFAILED : 等待支付
data->containers->createTime String 容器创建时间
data->containers->startTime String 容器启动时间
data->containers->stopTime String 容器停止时间
data->containers->hostId Long 容器所在主机ID
data->containers->cpu Integer 容器使用的CPU核数, -1表示共享
data->containers->mem Integer 容器使用的内存大小, 单位MB
data->containers->disk Integer 容器使用的磁盘大小, 单位MB
data->containers->health String 容器健康状态

上传部署

请求地址

/api/v1/node/{node_id}/uploadStart

请求方法

POST

请求参数

参数名 风格 类型 是否必须 示例 描述
node_id URI Long 1234 节点ID
accesskey 参数 String t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)
update 参数 Boolean false 是否容器需要需要以重建的方式启动
url 参数 String 应用代码网络地址,即调用上传部署接口前需先将代码上传至网络空间中(如OSS),并将代码网络地址作为此参数值
method 参数 String PARALLEL 部署方式(大写):
PARALLEL :并行部署
SEQUENTIAL:顺序部署

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "commandId": "6762ccf2-31ef-4917-9e8c-03dd6a510097",
    "name": "node_delete",
    "status": "CREATED",
    "result": "",
    "resultMsg": "",
    "createTime": "2016-06-27 09:21:36",
    "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/node/{node_id}/historyStart

请求方法

POST

请求参数

参数名 风格 类型 是否必须 示例 描述
node_id URI Long 1234 节点ID
accesskey 参数 String t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)
update 参数 Boolean false 是否容器需要需要以重建的方式启动
version 参数 String 2 版本号
method 参数 String PARALLEL 部署方式(大写):
PARALLEL :并行部署
SEQUENTIAL:顺序部署

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "commandId": "6762ccf2-31ef-4917-9e8c-03dd6a510097",
    "name": "node_delete",
    "status": "CREATED",
    "result": "",
    "resultMsg": "",
    "createTime": "2016-06-27 09:21:36",
    "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/node/{node_id}/start

请求方法

POST

请求参数

参数名 风格 类型 是否必须 示例 描述
node_id URI Long 1234 节点ID
accesskey 参数 String t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)
update 参数 Boolean false 是否容器需要需要以重建的方式启动
imageName 参数 String registry.acs.aliyun.com/open/tomcat7 镜像名称
imageTag 参数 String 3.0.0 镜像Tag
method 参数 String PARALLEL 部署方式(大写):
PARALLEL :并行部署
SEQUENTIAL:顺序部署

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "commandId": "11f60951-ca0b-4546-b278-50b140111b1a",
    "name": "node_start",
    "status": "CREATED",
    "result": "",
    "resultMsg": "",
    "createTime": "2016-06-24 16:40:53",
    "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/node/{node_id}/stop

请求方法

POST

请求参数

参数名 风格 类型 是否必须 示例 描述
node_id URI Long 1234 节点ID
accesskey 参数 String t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)
method 参数 String PARALLEL 部署方式(大写):
PARALLEL :并行部署
SEQUENTIAL:顺序部署

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "commandId": "11f60951-ca0b-4546-b278-50b140111b1a",
    "name": "node_stop",
    "status": "CREATED",
    "result": "",
    "resultMsg": "",
    "createTime": "2016-06-24 16:40:53",
    "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/node/{node_id}

请求方法

DELETE

请求参数

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

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "commandId": "6762ccf2-31ef-4917-9e8c-03dd6a510097",
    "name": "node_delete",
    "status": "CREATED",
    "result": "",
    "resultMsg": "",
    "createTime": "2016-06-27 09:21:36",
    "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
返回
顶部