阿里云容器服务-API参考-D.docxVIP

容器服务

API参考

容器服务/API

容器服务/API参考

PAGE10

PAGE10

API参考

简介

欢迎使用阿里云容器服务。用户可以使用本文档介绍的API对容器服务进行相关操作。请确保在使用这些接口前，已充分了解了容器服务说明、使用协议和收费方式。

术语表

术语

全称

中文

说明

Cluster

Cluster

集群

用户的容器集群，一个集群可以部署多个应用

Node

Node

节点

用户的容器集群中的某一个节点，目前只支持

ECS实例

Project

Project

应用

一个复杂的应用可以由多个服务组合而成，最简单的应用可能只包含一个容器

Service

Service

服务

一组基于相同镜像和配置定义的容器，作为一个可伸缩的微服务

Container

Container

容器

Docker容器运行时实例

API概述

容器服务API组成

容器服务的API主要分为3个部分

集群管理

应用管理

触发器

集群管理

容器服务提供了一些用于集群的管理的接口，例如创建集群、删除集群等

集群管理接口列表

API

描述

GetClusterList

查看所有集群实例

CreateCluster

创建集群实例

DeleteCluster

删除集群实例

GetClusterById

查看集群实例

GetClusterCerts

获取集群证书

UpdateClusterSizeById

更新集群节点数量

应用管理

应用管理的提供了DockerRemoteAPI兼容接口，你可以像访问单个DockerEngine一样，操作你的Docker集群。

应用管理接口列表

API

描述

ListProjects

查看应用实例列表

Createproject

创建应用实例

Retrieveproject

查看应用实例

Startproject

启动应用实例

Stopproject

停止应用实例

Killproject

终止应用实例

Updateproject

更新应用实例

Deleteproject

删除应用实例

ListServices

查看服务实例列表

Retrieveservice

查看服务实例

Startservice

启动服务实例

Stopservice

停止服务实例

Killservice

终止服务实例

Scaleservice

伸缩服务实例

触发器

触发器是容器服务中提供的简单快捷进行持续部署的API,详见说明

更新历史

-最近更新时间：2016-02-04

更新历史

发布时间

更新

说明

2015-12-15

第一版确定

提供了集群管理的基本接口

2015-02-04

增加应用相关接口

提供了应用管理的基本接口

集群API调用方式调用方式

对容器服务API接口调用是通过向容器服务API的服务端地址发送HTTP请求，并按照接口说明在请求中加入相应请求参数来完成的；根据请求的处理情况，系统会返回处理结果。

请求结构

公共参数

返回结果

签名机制

请求结构

服务地址

阿里云容器服务的OpenAPI接入地址为：

通信协议

支持通过HTTP或HTTPS通道进行请求通信。为了获得更高的安全性，推荐您使用HTTPS通道发送请求。

请求方法

使用HTTP的PUT、POST、GET、DELETE等HTTPMethod发送不同的请求。

请求参数

每个请求都需要包含的公共请求参数和指定操作所特有的请求参数。

请求编码

请求及返回结果都使用UTF-8字符集进行编码。

公共参数

公共请求头部

公共请求参数是指每个接口都需要使用到的请求参数。

参数名称

说明

选项

Authorization

用于验证请求合法性的认证信息

，采用AccessKeyId:Signature的形式

Required

Content-Length

RFC2616中定义的HTTP请求内容长度

Required

Content-Type

RFC2616中定义的HTTP请求内容类型

Required

Content-MD5

HTTP协议消息体的128-bitMD5散列值转换成BASE64编码的结果。为了防止所有请求被篡改，这里建议所有请求都附加该信息

Required

Date

请求的构造时间，目前只支持GMT格式，如果和MNS的服务器时间前后差异超过15分钟将

Required

返回本次请求非法

Host

访问Host值，例如

：

Required

Accept

客户端需要的返回值类型，支持application/json和application/xml

Required

x-acs-region-id

地域（Region）指的是ECS实例所在的物理位置。地域概念

，ECS查询可用地域列表

Required