产品文档

Pod

pod

简介

pod 服务

版本

v1

API

接口名称 请求方式 功能描述
associateElasticIp POST pod 绑定弹性公网 IP,绑定的是主网卡、主内网IP对应的弹性IP.
一个 pod 只能绑定一个弹性公网 IP(主网卡),若主网卡已存在弹性公网IP,会返回错误。
如果是黑名单中的用户,会返回错误。
attach GET 将容器连接到本地标准输入输出
checkPodName POST podName 是否符合命名规范,以及查询指定 podName 区域内是否已经存在。
createPods POST 创建一台或多台 pod
- 创建pod需要通过实名认证
- hostname规范
- 支持两种方式:以标签方式书写或以完整主机名方式书写
- 标签规范
- 0-9,a-z(不分大小写)和-(减号),其他的都是无效的字符串
- 不能以减号开始,也不能以减号结尾
- 最小1个字符,最大63个字符
- 完整的主机名由一系列标签与点连接组成
- 标签与标签之间使用“.”(点)进行连接
- 不能以“.”(点)开始,也不能以“.”(点)结尾
- 整个主机名(包括标签以及分隔点“.”)最多有63个ASCII字符
- 网络配置
- 指定主网卡配置信息
- 必须指定subnetId
- 可以指定elasticIp规格来约束创建的弹性IP,带宽取值范围[1-100]Mbps,步进1Mbps
- 可以指定网卡的主IP(primaryIpAddress)和辅助IP(secondaryIpAddresses),此时maxCount只能为1
- 可以设置网卡的自动删除autoDelete属性,指明是否删除实例时自动删除网卡
- 安全组securityGroup需与子网Subnet在同一个私有网络VPC内
- 一个 pod 创建时至多指定5个安全组
- 主网卡deviceIndex设置为1
- 存储
- volume分为container system disk和pod data volume,container system disk的挂载目录是/,data volume的挂载目录可以随意指定
- container system disk
- 只能是cloud类别
- 云硬盘类型可以选择hdd.std1、ssd.gp1、ssd.io1
- 磁盘大小
- 所有类型:范围[20,100]GB,步长为10G
- 自动删除
- 默认自动删除
- 可以选择已存在的云硬盘
- data volume
- 当前只能选择cloud类别
- 云硬盘类型可以选择hdd.std1、ssd.gp1、ssd.io1
- 磁盘大小
- 所有类型:范围[20,4000]GB,步长为10G
- 自动删除
- 默认自动删除
- 可以选择已存在的云硬盘
- 可以从快照创建磁盘
- pod 容器日志
- default:默认在本地分配10MB的存储空间,自动rotate
- DNS-1123 label规范
- 长度范围: [1-63]
- 例子: my-name, 123-abc
- DNS-1123 subdomain规范
- 长度范围: [1-253]
- 例子: example.com, registry.docker-cn.com
- 其他
- 创建完成后,pod 状态为running
- maxCount为最大努力,不保证一定能达到maxCount
createSecret POST 创建一个 secret,用于存放镜像仓库机密相关信息。
deletePod DELETE pod 状态必须为 stopped、running 或 error状态。
按量付费的实例,如不主动删除将一直运行,不再使用的实例,可通过本接口主动停用。
只能支持主动删除按量计费类型的实例。包年包月过期的 pod 也可以删除,其它的情况还请发工单系统。计费状态异常的容器无法删除。
敏感操作,可开启MFA操作保护
deleteSecret DELETE 删除单个 secret
describeContainer GET 获取 pod 中某个容器的详情
describeInstanceTypes GET 查询实例规格信息列表
describePod GET 查询一个 pod 的详细信息
describePods GET 批量查询 pod 的详细信息
此接口支持分页查询,默认每页20条。
describeQuota GET 查询资源的配额,支持:原生容器 pod 和 secret.
describeSecret GET 查询单个 secret 详情
describeSecrets GET 查询 secret 列表。

此接口支持分页查询,默认每页20条。
disassociateElasticIp POST pod 解绑公网 IP,解绑的是主网卡、主内网 IP 对应的弹性 IP.
execCreate POST 创建 exec
execGetExitCode GET 获取exec退出码
execStart GET 执行exec,此接口需要升级Http协议到WebSocket
getContainerLogs GET 查询单个容器日志
modifyPodAttribute PATCH 修改 pod 的描述。
rebuildPod POST 对 pod 中的容器使用新的镜像进行重置,pod 需要处于关闭状态。
resizePod POST 调整pod实例类型配置。
- pod phase 需是停止状态;
- 支持升配、降配;不支持原有规格
- 计费类型不变
- 包年包月:需要计算配置差价,如果所选配置价格高,需要补齐到期前的差价,到期时间不变;如果所选配置价格低,需要延长到期时间
- 按配置:按照所选规格,进行计费
- 支持对 pod 中的容器进行资源限制、资源需求的调整
- 容器需求的总资源占用不得超过 pod 的实例类型
- 容器资源限制不得超过 pod 的实例类型
resizeTTY POST 设置TTY大小
startPod POST 启动处于关闭状态的单个 pod ,处在任务执行中的 pod 无法启动。
pod 实例或其绑定的云盘已欠费时,容器将无法正常启动。
stopPod POST 停止处于运行状态的单个实例,处于任务执行中的 pod 无法启动。
更新时间:2019-12-05 18:26:01