淘宝开放平台

登录
文档中心 > 容器服务

容器服务

获取服务信息

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

获取指定服务信息

请求指定的服务信息

请求地址

/api/v1/service/{service_id}

请求方法

GET

请求参数

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

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "id": 11982,
    "name": "沐剑测试",
    "imageName": "registry.acs.aliyun.com/open/tomcat8:4.0.0",
    "createTime": "2016-06-17 10:15:49",
    "regionDisplay": "杭州",
    "nodes": [
      {
        "id": 610247,
        "name": "正式环境",
        "imageName": "registry.acs.aliyun.com/open/tomcat8:4.0.0",
        "status": "RUNNING",
        "serviceId": 11982,
        "createTime": "2016-06-17 10:15:49",
        "containers": [
          {
            "id": 16237,
            "nodeId": 610247,
            "status": "RUNNING",
            "createTime": "2016-06-17 10:15:50",
            "startTime": "2016-06-17 10:35:05",
            "stopTime": "2016-06-17 10:34:34",
            "hostId": 1745,
            "cpu": 0,
            "mem": 0,
            "disk": 10240,
            "health": ""
          },
          {
            "id": 16238,
            "nodeId": 610247,
            "status": "RUNNING",
            "createTime": "2016-06-17 10:15:50",
            "startTime": "2016-06-17 10:35:06",
            "stopTime": "2016-06-17 10:34:33",
            "hostId": 1745,
            "cpu": 0,
            "mem": 0,
            "disk": 10240,
            "health": ""
          }
        ]
      }
    ]
  }
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->id Long 服务ID
data->name String 服务名字
data->imageName String 服务所使用的镜像
data->createTime String 服务创建时间
data->regionDisplay String 区域
data->nodes->id Long 节点ID
data->nodes->name String 节点名字，节点主要分为线下，预发，线上
data->nodes->imageName Long 节点镜像名字，和服务镜像名字相同
data->nodes->status String 节点状态：
1. CREATED ： 已创建
2. RUNNING ：运行中
3. STOPPED ： 已停止
4. DELETING ：删除中
data->nodes->serviceId Long 节点所在服务ID
data->nodes->createTime String 节点创建时间
data->nodes->containers->id Long 容器ID
data->nodes->containers->nodeId Long 容器所在节点ID
data->nodes->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->nodes->containers->createTime String 容器创建时间
data->nodes->containers->startTime String 容器启动时间
data->nodes->containers->stopTime String 容器停止时间
data->nodes->containers->hostId Long 容器所在主机ID
data->nodes->containers->cpu Integer 容器使用的CPU核数, -1表示共享
data->nodes->containers->mem Integer 容器使用的内存大小, 单位MB
data->nodes->containers->disk Integer 容器使用的磁盘大小, 单位MB
data->nodes->containers->health String 容器健康状态

获取指定服务信息

请求指定的服务信息

请求地址

/api/v1/service/{service_id}

请求方法

GET

请求参数

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

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "id": 11982,
    "name": "沐剑测试",
    "imageName": "registry.acs.aliyun.com/open/tomcat8:4.0.0",
    "createTime": "2016-06-17 10:15:49",
    "regionDisplay": "杭州",
    "nodes": [
      {
        "id": 610247,
        "name": "正式环境",
        "imageName": "registry.acs.aliyun.com/open/tomcat8:4.0.0",
        "status": "RUNNING",
        "serviceId": 11982,
        "createTime": "2016-06-17 10:15:49",
        "containers": [
          {
            "id": 16237,
            "nodeId": 610247,
            "status": "RUNNING",
            "createTime": "2016-06-17 10:15:50",
            "startTime": "2016-06-17 10:35:05",
            "stopTime": "2016-06-17 10:34:34",
            "hostId": 1745,
            "cpu": 0,
            "mem": 0,
            "disk": 10240,
            "health": ""
          },
          {
            "id": 16238,
            "nodeId": 610247,
            "status": "RUNNING",
            "createTime": "2016-06-17 10:15:50",
            "startTime": "2016-06-17 10:35:06",
            "stopTime": "2016-06-17 10:34:33",
            "hostId": 1745,
            "cpu": 0,
            "mem": 0,
            "disk": 10240,
            "health": ""
          }
        ]
      }
    ]
  }
}

返回字段说明

字段 类型 描述
code String 响应状态码
message String 响应消息
data->id Long 服务ID
data->name String 服务名字
data->imageName String 服务所使用的镜像
data->createTime String 服务创建时间
data->regionDisplay String 区域
data->nodes->id Long 节点ID
data->nodes->name String 节点名字，节点主要分为线下，预发，线上
data->nodes->imageName Long 节点镜像名字，和服务镜像名字相同
data->nodes->status String 节点状态：
1. CREATED ： 已创建
2. RUNNING ：运行中
3. STOPPED ： 已停止
4. DELETING ：删除中
data->nodes->serviceId Long 节点所在服务ID
data->nodes->createTime String 节点创建时间
data->nodes->containers->id Long 容器ID
data->nodes->containers->nodeId Long 容器所在节点ID
data->nodes->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->nodes->containers->createTime String 容器创建时间
data->nodes->containers->startTime String 容器启动时间
data->nodes->containers->stopTime String 容器停止时间
data->nodes->containers->hostId Long 容器所在主机ID
data->nodes->containers->cpu Integer 容器使用的CPU核数, -1表示共享
data->nodes->containers->mem Integer 容器使用的内存大小, 单位MB
data->nodes->containers->disk Integer 容器使用的磁盘大小, 单位MB
data->nodes->containers->health String 容器健康状态

删除服务

删除指定的服务

请求地址

/api/v1/service/{service_id}

请求方法

DELETE

请求参数

参数名 风格 类型 是否必须 示例 描述
service_id 路径（不参与签名计算） Long 是 1234 服务ID
accesskey 参数 String 是 t9xuit3pt202ou09 用户accessKey
timestamp 参数 String 是 18223784 当前时间戳(从1970.1.1到此刻的毫秒数)
force 参数 boolean 否 false 是否强制删除，默认false

返回示例

{
  "code": "0",
  "message": "success",
  "data": {
    "commandId": "71c9c30e-9f44-40a0-bf96-21d9a43523f6",
    "name": "service_delete",
    "status": "CREATED",
    "result": "",
    "resultMsg": "",
    "createTime": "2016-06-27 11:25:16",
    "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) 我要提问
返回
顶部