Deployment 接口文档
1. 通用返回码说明
类型 | CODE | MESSAGE |
InternalServerError | InternalServerError | 服务器内部错误 |
MissingParameter | MissingParameter | 参数 %s 缺失 |
InvalidFormat | InvalidFormat | 参数 %s 的格式非法 |
AlreadyExist | AlreadyExist | %名称已存在 |
QuotaInsufficient | QuotaInsufficient | %配额不足 |
Note
通用返回码后续可能会新增。
2. 接口说明
2.1 创建 Deployment
METHOD | URL |
POST | /ncs?Version=2017-11-16&Action=CreateDeployment |
示例
{
"Placement": {
"ZoneId": ["cn-east-1a"]
},
"SpecType": "ncs.n1.medium2",
"VirtualPrivateCloud": {
"VpcId": "yourvpcId",
"SubnetId": "None"
},
"SecurityGroupIds": ["ad2d4e"],
"ContainerType": "Standard",
"NamespaceId": 1,
"Name": "test",
"Replicas": 3,
"SysCmds": ["xxx"],
"MinReadySeconds": 10,
"DeploymentStrategy": {
"Type": "RollingUpdate",
"RollingUpdate": {
"MaxSurge": "25%",
"MaxUnavailable": "25%"
}
},
"Containers": [{
"Name": "container",
"Image": "hub.cn-east-1.163yun.com/public/debian:7.9",
"LogDirs": ["/var/log/test", "/var/log/hello"],
"Args": ["xxx", "xxx"],
"Envs": [{
"Name": "HOSTNAME",
"Value": "test"
}],
"ResourceRequirements": {
"Limits": {
"Cpu": 1000,
"Memory": 1024
},
"Requests": {
"Cpu": 1000,
"Memory": 1024
}
},
"SecurityContext": {
"Privilege": true,
"Capabilities": []
}
}]
}
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 |
Action | CreateDeployment | string | 是 |
Version | 2017-11-16 | string | 是 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Placement | 实例所属位置 | object | 是 | 详细信息见下表 |
SpecType | 资源规格类型,PostPaid时必填 | string | 否 | |
VirtualPrivateCloud | | object | 是 | 详细信息见下表 |
SecurityGroupIds | 实例所属安全组 | array | 否 | |
ContainerType | 容器类型 | string | 是 | |
NamespaceId | 空间Id | long | 是 | |
Name | Deployment名称 | string | 是 | |
Replicas | 副本数 | long | 是 | |
SysCmds | sysctl系统参数数组 | array | 否 | |
Labels | 标签,map类型,key和value类型都是string | object | 否 | 详细信息见下表 |
MinReadySeconds | pod更新间隔, 单位s,默认5 | long | 是 | |
DeploymentStrategy | Deployment升级策略 | object | 是 | 详细信息见下表 |
Containers | | array | 是 | 详细信息见下表 |
RevisionHistroyLimit | 历史版本数目限制 | integer | 否 | |
ImagePullSecretIds | 拉取镜像秘钥id列表 | array | 否 | |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Name | 容器名称 | string | 否 | |
Image | 镜像URL | string | 否 | |
LogDirs | 日志路径数组 | array | 否 | |
Args | Docker CMD命令 | array | 否 | |
Command | Docker EntryPoint命令 | array | 否 | |
Envs | 环境变量数组 | array | 否 | 详细信息见下表 |
ResourceRequirements | 资源限制 | object | 否 | 详细信息见下表 |
SecurityContext | 安全选项 | object | 否 | 详细信息见下表 |
SshKeyIds | 密钥Id数组 | array | 否 | |
LivenessProbe | liveness探针(可选) | object | 否 | 详细信息见下表 |
ReadinessProbe | readiness探针(可选) | object | 否 | 详细信息见下表 |
Volumes | 容器卷(可选) | array | 是 | 详细信息见下表 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
VolumeType | 容器卷类型,目前仅支持Emptydir | string | 是 | |
Emptydirs | 当volumeType为Emptydir时必填,容器绑定的Emptydir的信息 | array | 否 | 详细信息见下表 |
Secrets | 密钥,若VolumeType为Secret则必填 | array | 否 | 详细信息见下表 |
参数名称 | 说明 | 参数类型 | 是否必填 |
SecretId | 密钥Id | long | 是 |
MountPath | 秘钥在容器中的挂载点 | string | 是 |
Mode | 容器对秘钥的访问方式,仅支持只读 | string | 是 |
参数名称 | 说明 | 参数类型 | 是否必填 |
Medium | 默认支持内存Memory,未来支持磁盘 | string | 否 |
MountPath | 卷在容器中的挂载点 | string | 是 |
Mode | 容器对卷的访问方式,ro 为只读,rw 为读写(default) | string | 是 |
Name | EmptyDir的名称,同一个容器里的EmptyDir此字段不能重复 | string | 是 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Exec | 探针执行的结构 | object | 否 | 详细信息见下表 |
PeriodSeconds | 执行间隔周期 | integer | 否 | |
timeoutSeconds | 执行超时时间 | integer | 否 | |
参数名称 | 说明 | 参数类型 | 是否必填 |
Command | 探针执行的命令 | array | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Exec | 探针执行的结构 | object | 否 | 详细信息见下表 |
PeriodSeconds | 执行间隔周期 | integer | 否 | |
timeoutSeconds | 执行超时时间 | integer | 否 | |
参数名称 | 说明 | 参数类型 | 是否必填 |
Command | 探针执行的命令 | array | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 |
privilege | 默认权限或root权限,缺省为默认权限,有白名单限制 | boolean | 否 |
capabilities | 容量 | array | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Limits | 资源限制 | object | 否 | 详细信息见下表 |
Requests | 资源需求 | object | 否 | 详细信息见下表 |
|参数名称 说明 参数类型 是否必填|
|Cpu| cpu核数| long| 否|
|Memory| 内存大小 |long |否|
|Gpu |gpu核数 |string| 否 |
参数名称 | 说明 | 参数类型 | 是否必填 |
Cpu | cpu核数 | long | 否 |
Memory | 内存大小 | long | 否 |
Gpu | gpu核数 | string | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 |
Name | 环境名字 | string | 是 |
Value | 环境值;当type不存在时必填,其它时候无效; | string | 否 |
Type | 环境变量类型;此值要么不出现,出现则仅支持Secret; | string | 否 |
SecretId | 秘钥id,秘钥类型仅支持Opaque;当Type为Secret时必填,Type为其它值时此值无效 | long | 否 |
Key | 键值;键值必须存在于secret中 | string | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Type | 类型 | string | 否 | |
RollingUpdate | 滚动升级策略 | object | 否 | 详细信息见下表 |
参数名称 | 说明 | 参数类型 | 是否必填 |
MaxSurge | 最大不可用副本数 | string | 否 |
MaxUnavailable | 最大超过预期副本数 | string | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 |
key | label key | string | 否 |
value | value of key | string | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 |
VpcId | 私有网络id | string | 否 |
SubnetId | 当子网为classic时,无子网id, 此值为None | string | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 |
ZoneId | 实例所属可用区数组 | array | 否 |
返回参数
参数名称 | 说明 | 参数类型 | 是否必填 |
RequestId | string | 是 | |
Code | 返回码 | long | 是 |
Message | | string | 是 |
2.2 更新Deployment
METHOD | URL |
POST | /ncs?Version=2017-11-16&Action=ModifyDeployment |
示例
{
"NamespaceId": 1700,
"DeploymentId": 4740,
"Labels": {
},
"Containers": [{
"Name": "new1",
"Image": "10.185.8.175:5001/public/debian:7.9-common",
"Envs": [{
"Name": "TEST",
"Value": "testsss"
}],
"ResourceRequirements": {
"Limits": {
"Cpu": 1996,
"Memory": 2046
},
"Requests": {
"Cpu": 1994,
"Memory": 2045
}
},
"SecurityContext": {
"Privilege": false,
"Capabilities": ["SYS_ADMIN"]
}
}]
}
Note
Cpu 1000代表 1 core。
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 |
Action | ModifyDeployment | string | 是 |
Version | 2017-11-16 | string | 是 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
NamespaceId | 空间id | long | 是 | |
DeploymentId | DeploymentId | long | 是 | |
SysCmds | sysctl系统参数数组 | array | 否 | |
Labels | 标签,map类型,key和value类型都是string | object | 否 | 详细信息见下表 |
MinReadySeconds | 默认使用创建时的值 | long | 否 | |
DeploymentStrategy | 默认使用RollingUpdate | object | 否 | 详细信息见下表 |
Containers | 容器数组 | array | 否 | 详细信息见下表 |
RevisionHistoryLimit | 历史版本数目限制 | integer | 否 | |
ImagePullSecretIds | 拉取镜像秘钥列表 | array | 是 | |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Name | 容器名称 | string | 否 | |
Image | 镜像URL | string | 否 | |
LogDirs | 日志路径数组 | array | 否 | |
Args | Docker CMD命令 | array | 否 | |
Command | Docker EntryPoint命令 | array | 否 | |
Envs | 环境变量数组 | array | 否 | 详细信息见下表 |
ResourceRequirements | 资源限制 | object | 否 | 详细信息见下表 |
SecurityContext | 安全选项 | object | 否 | 详细信息见下表 |
SshKeyIds | 密钥Id数组 | array | 否 | |
LivenessProbe | liveness探针(可选) | object | 否 | 详细信息见下表 |
ReadinessProbe | readiness探针(可选) | object | 否 | 详细信息见下表 |
Volumes | 容器卷(可选) | array | 是 | 详细信息见下表 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
VolumeType | 容器卷类型,目前仅支持Emptydir | string | 是 | |
Emptydirs | 当volumeType为Emptydir时必填,容器绑定的Emptydir的信息 | array | 否 | 详细信息见下表 |
Secrets | 密钥,若VolumeType为Secret则必填 | array | 否 | 详细信息见下表 |
参数名称 | 说明 | 参数类型 | 是否必填 |
SecretId | 密钥Id | long | 是 |
MountPath | 秘钥在容器中的挂载点 | string | 是 |
Mode | 容器对秘钥的访问方式,仅支持只读 | string | 是 |
参数名称 | 说明 | 参数类型 | 是否必填 |
Medium | 默认支持内存Memory,未来支持磁盘 | string | 否 |
MountPath | 卷在容器中的挂载点 | string | 是 |
Mode | 容器对卷的访问方式,ro 为只读,rw 为读写(default) | string | 是 |
Name | EmptyDir的名称,同一个容器里的EmptyDir此字段不能重复 | string | 是 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Exec | 探针执行的结构 | object | 否 | 详细信息见下表 |
PeriodSeconds | 执行间隔周期 | integer | 否 | |
timeoutSeconds | 执行超时时间 | integer | 否 | |
参数名称 | 说明 | 参数类型 | 是否必填 |
Command | 探针执行的命令 | array | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Exec | 探针执行的结构 | object | 否 | 详细信息见下表 |
PeriodSeconds | 执行间隔周期 | integer | 否 | |
timeoutSeconds | 执行超时时间 | integer | 否 | |
参数名称 | 说明 | 参数类型 | 是否必填 |
Command | 探针执行的命令 | array | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 |
privilege | 默认权限或root权限,缺省为默认权限,有白名单限制 | boolean | 否 |
capabilities | 容量 | array | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Limits | 资源限制 | object | 否 | 详细信息见下表 |
Requests | 资源需求 | object | 否 | 详细信息见下表 |
参数名称 | 说明 | 参数类型 | 是否必填 |
Cpu | cpu核数 | long | 否 |
Memory | 内存大小 | long | 否 |
Gpu | gpu核数 | string | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 |
Cpu | cpu核数 | long | 否 |
Memory | 内存大小 | long | 否 |
Gpu | gpu核数 | string | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 |
Name | 环境名字 | string | 是 |
Value | 环境值;当type不存在时必填,其它时候无效; | string | 否 |
Type | 环境变量类型;此值要么不出现,出现则仅支持Secret; | string | 否 |
SecretId | 秘钥id,秘钥类型仅支持Opaque;当Type为Secret时必填,Type为其它值时此值无效 | long | 否 |
Key | 键值;键值必须存在于secret中 | string | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
Type | 类型 | string | 否 | |
RollingUpdate | 滚动升级策略 | object | 否 | 详细信息见下表 |
参数名称 | 说明 | 参数类型 | 是否必填 |
MaxSurge | double类型 | long | 否 |
MaxUnavailable | double类型 | string | 否 |
参数名称 | 说明 | 参数类型 | 是否必填 |
key | label key | string | 否 |
value | value of key | string | 否 |
返回参数
参数名称 | 说明 | 参数类型 | 是否必填 |
RequestId | string | 是 | |
Code | long | 是 | |
Message | string | 是 | |
2.3 更改Deployment实例规格(按量计费)
METHOD | URL |
POST | /ncs?Version=2017-11-16&Action=ResetDeploymentSpecType |
参数 | 类型 | 说明 | 备注 | 是否必填 |
NamespaceId | long | 空间Id | | 是 |
DeploymentId | long | Deployment Id | | 是 |
SpecType | String | 资源规格类型 | | 是 |
Containers | Object Array | 容器资源限制 | | 是 |
Container对象为:
参数 | 类型 | 说明 | 备注 | 是否必填 |
Name | String | 容器名称 | | 是 |
ResourceRequirements | Object | 与创建时的对象一样 | | 是 |
{
"NamespaceId": 1700,
"DeploymentId": 4848,
"SpecType": "ncs.n1.medium4",
"Containers": [{
"Name": "con1",
"ResourceRequirements": {
"Limits": {
"Cpu": 2000,
"Memory": 4095
},
"Requests": {
"Cpu": 2000,
"Memory": 4094
}
}
}]
}
Note
Cpu 1000代表 1 core。
无
2.4 更改Deployment副本数
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=ModifyDeploymentReplicas |
参数 | 类型 | 说明 | 备注 | 是否必填 |
NamespaceId | long | 空间Id | | 是 |
DeploymentId | long | Deployment Id | | 是 |
Replicas | int | 副本数 | 受限于配额 | 是 |
/ncs?Version=2017-11-16&Action=ModifyDeploymentReplicas&NamespaceId=1&DeploymentId=1&Replicas=3
无
2.5 重新部署Deployment
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=RedeployDeployment |
参数 | 类型 | 说明 | 备注 | 是否必填 |
NamespaceId | long | 空间Id | | 是 |
DeploymentId | long | Deployment Id | | 是 |
/ncs?Version=2017-11-16&Action=RedeployDeployment&NamespaceId=1&DeploymentId=1
无
2.6查询Deployment列表
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=DescribeDeployments |
参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
NamespaceId | 空间Id | string | 是 | |
Limit | int,默认20 | string | 否 | |
Offset | int,默认0 | string | 否 | |
Action | DescribeDeployments | string | 是 | |
Version | 2017-11-16 | string | 是 | |
/ncs?Version=2017-11-16&Action=DescribeDeployments&NamespaceId=1
参数名称 | 说明 | 参数类型 | 备注 |
TotalCount | 总数 | integer | |
RequestId | 请求id | string | |
Deployments | deployment列表 | array | 详细信息见下表 |
其中,Deployment对象包含信息为:
参数名称 | 说明 | 参数类型 | 备注 |
Status | Deployment状态,可取值:Creating/CreateFail/Updating/Running/Abnormal | string | |
DeploymentId | Deployment的Id | integer | |
Images | 镜像URL数组 | array | |
Pods | 所属deployment的pod | array | 详细信息见下表 |
AvailableReplicas | 可用副本数 | integer | |
Conditions | Condition对象 | array | 详细信息见下表 |
OperationLocks | 返回一个数组,数组对象里目前仅有LockReason一个字段,如果为欠费停服,则字段值为financial;如果不是欠费停服状态,则为空数组; | array | |
Name | Deployment名称 | string | |
DesiredReplicas | 预期副本数 | integer | |
UpdateAt | 更新时间, ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') | string | |
VirtualPrivateCloud | vpc信息 | object | |
CreateAt | 创建时间,ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') | string | |
Placement | 实例所属位置 | object | 详细信息见下表 |
NamespaceId | 空间Id | integer | |
Placement对象格式为:
参数名称 | 说明 | 参数类型 | 备注 |
ZoneId | az信息 | array | |
VirtualPrivateCloud 说明:
参数名称 | 说明 | 参数类型 | 备注 |
VpcId | vpc网络id | string | |
SubnetId | 子网id | string | |
Conditions 说明:
参数名称 | 说明 | 参数类型 | 备注 |
Status | 状态 | string | |
Type | 类型 | string | |
Reason | 理由 | string | |
Pods 说明:
参数名称 | 说明 | 参数类型 | 备注 |
PodStatus | Pod状态 | string | |
PodName | Pod名称 | string | |
2.7 查询所有空间下Deployment列表
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=DescribeDeploymentsAllNamespaces |
参数 | 类型 | 描述 | 是否必填 |
Limit | int | 默认20 | 否 |
Offset | int | 默认0 | 否 |
/ncs?Version=2017-11-16&Action=DescribeDeployments
参数 | 类型 | 描述 |
TotalCount | int | 已创建Deployment总数 |
Deployments | Object Array | Deployment列表 |
其中,Deployment对象包含信息为:
参数 | 类型 | 描述 |
DeploymentId | long | Deployment Id |
NamespaceId | long | 空间Id |
Name | String | Deployment名称 |
Placement | Object | 实例所属位置 |
Status | String | Deployment状态, 可取值:Creating/CreateFail/Updating/Running/Abnormal |
Images | String Array | 镜像URL数组 |
CreateAt | String | 创建时间,ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') |
UpdateAt | String | 更新时间,ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') |
Conditions | Object Array | Condition对象参考详情API |
AvailableReplicas | int | 正常副本数 |
DesiredReplicas | int | 预期副本数 |
Placement对象格式为:
参数 | 类型 | 描述 |
ZoneId | String Array | 实例所属可用区数组 |
2.8 查询 Deployment 详情
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=DescribeDeploymentInfo |
/ncs?Version=2017-11-16&Action=DescribeDeploymentInfo&NamespaceId=1&DeploymentId=1
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 |
NamespaceId | 必填 | string | 是 |
DeploymentId | 必填 | string | 是 |
Action | DescribeDeploymentInfo | string | 是 |
Version | 2017-11-16 | string | 是 |
参数名称 | 说明 | 参数类型 | 备注 |
Deployment | object | 详细信息见下表 | |
参数名称 | 说明 | 参数类型 | 备注 |
DeploymentId | 负载id,long类型 | long | |
NamespaceId | 空间id,long类型 | long | |
Name | 负载名称 | string | |
Placement | 实例所属位置 | object | |
Status | 状态,值:Creating/CreateFail/Updating/Running/Abnormal | string | |
AvailableReplicas | 正常副本数 | long | |
DesiredReplicas | 预期副本数量 | long | |
CreateAt | | 创建时间,ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') | string |
UpdateAt | 更新时间 | string | |
PackageId | 资源包id | string | |
PayType | 购买模式 | string | |
SpecType | 资源规格类型 | string | |
VirtualPrivateCloud | 私有网络信息 | object | |
SecurityGroupIds | 实例所属安全组 | array | |
ContainerType | 容器类型,Standard/HighPerformance, 默认Standard | string | |
Replicas | 副本数 | long | |
SysCmds | sysctl系统参数数组 | array | |
Labels | k8s labels | object | 详细信息见下表 |
MinReadySeconds | pod最小更新间隔 | long | |
DeploymentStrategy | 更新策略 | object | 详细信息见下表 |
Containers | 容器数组 | array | 详细信息见下表 |
OperationLocks | 返回一个数组,数组成员对象里目前仅有LockReason一个字段,如果为欠费停服,则字段值为financial; 如果不是欠费停服状态,则为空数组; | array | 详细信息见下表 |
RevisionHistoryLimit | 历史版本数目限制 | integer | |
Kind | 种类,无状态为deployments | string | |
ClusterId | 集群id | integer | |
ImagePullSecretIds | 拉取秘钥id列表 | array | |
ResourcePoolInfo | 资源池信息 | object | 详细信息见下表 |
参数名称 | 说明 | 参数类型 |
ResourcePoolId | 资源池id | string |
ResourcePoolName | 资源池名字 | string |
Owner | 资源池归属(公共/专属) | string |
参数名称 | 说明 | 参数类型 |
LockReaso | 被锁的原因 | string |
参数名称 | 说明 | 参数类型 | 备注 |
Name | 容器名称 | string | |
Image | 镜像URL | string | |
LogDirs | 日志路径数组 | array | |
Args | Docker CMD命令 | array | |
Command | Docker EntryPoint命令 | array | |
Envs | 环境变量数组 | array | 详细信息见下表 |
ResourceRequirements | 资源限制 | object | 详细信息见下表 |
SecurityContext | 安全选项 | object | 详细信息见下表 |
SshKeyIds | 密钥Id数组 | array | |
LivenessProbe | liveness探针(可选) | object | 细信息见下表 |
ReadinessProbe | readiness探针(可选) | object | 详细信息见下表 |
Volumes | 容器卷(可选) | array | 详细信息见下表 |
参数名称 | 说明 | 参数类型 | 备注 |
VolumeType | 容器卷类型,目前仅支持Emptydir | string | |
Emptydirs | 当volumeType为Emptydir时必填,容器绑定的Emptydir的信息 | array | 详细信息见下表 |
Secrets | 密钥,若VolumeType为Secret则必填 | array | 详细信息见下表 |
参数名称 | 说明 | 参数类型 |
SecretId | 密钥Id | long |
MountPath | 秘钥在容器中的挂载点 | string |
Mode | 容器对秘钥的访问方式,仅支持只读 | string |
参数名称 | 说明 | 参数类型 |
Medium | 默认支持内存Memory,未来支持磁盘 | string |
MountPath | 卷在容器中的挂载点 | string |
Mode | 容器对卷的访问方式,ro 为只读,rw 为读写(default) | string |
Name | EmptyDir的名称,同一个容器里的EmptyDir此字段不能重复 | string |
参数名称 | 说明 | 参数类型 | 备注 |
Exec | 探针执行的结构 | object | 详细信息见下表 |
PeriodSeconds | 执行间隔周期 | integer | |
timeoutSeconds | 执行超时时间 | integer | |
参数名称 | 说明 | 参数类型 |
Command | 探针执行的命令 | array |
参数名称 | 说明 | 参数类型 | 备注 |
Exec | 探针执行的结构 | object | 详细信息见下表 |
PeriodSeconds | 执行间隔周期 | integer | |
timeoutSeconds | 执行超时时间 | integer | |
参数名称 | 说明 | 参数类型 |
Command | 探针执行的命令 | array |
参数名称 | 说明 | 参数类型 |
privilege | 默认权限或root权限,缺省为默认权限,有白名单限制 | boolean |
capabilities | 容量 | array |
参数名称 | 说明 | 参数类型 | 备注 |
Limits | 资源限制 | object | 详细信息见下表 |
Requests | 资源需求 | object | 详细信息见下表 |
参数名称 | 说明 | 参数类型 |
Cpu | cpu核数 | long |
Memory | 内存大小 | long |
Gpu | gpu核数 | string |
参数名称 | 说明 | 参数类型 |
Cpu | cpu核数 | long |
Memory | 内存大小 | long |
Gpu | gpu核数 | string |
参数名称 | 说明 | 参数类型 |
Name | 环境名字 | string |
Value | 环境值;当type不存在时必填,其它时候无效; | string |
Type | 环境变量类型;此值要么不出现,出现则仅支持Secret; | string |
SecretId | 秘钥id,秘钥类型仅支持Opaque;当Type为Secret时必填,Type为其它值时此值无效 | long |
Key | 键值;键值必须存在于secret中 | string |
参数名称 | 说明 | 参数类型 | 备注 |
Type | 类型 | string | |
RollingUpdate | 滚动升级策略 | object | 详细信息见下表 |
参数名称 | 说明 | 参数类型 | 备注 |
MaxSurge | double类型 | long | |
MaxUnavailable | double类型 | string | |
参数名称 | 说明 | 参数类型 |
key | label key | string |
value | value of key | string |
参数名称 | 说明 | 参数类型 |
VpcId | 私有网络id | string |
SubnetId | 当子网为classic时,无子网id, 此值为None | string |
参数名称 | 说明 | 参数类型 |
ZoneId | 实例所属可用区数组 | array |
2.9 查询Deployment实例列表
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=DescribeDeploymentInstances |
参数 | 类型 | 描述 | 是否必填 |
NamespaceId | long | 空间Id | 是 |
DeploymentId | long | DeploymentId | 是 |
Limit | int | 默认20 | 否 |
Offset | int | 默认0 | 否 |
/ncs?Version=2017-11-16&Action= DescribeDeploymentInstances&NamespaceId=1&DeploymentId=1
参数 | 类型 | 描述 |
TotalCount | int | 总数 |
Pods | Object Array | Deployment当前rs 下的pods列表 |
Pod对象格式为:
参数 | 类型 | 描述 |
PodId | long | pod id |
PodName | String | pod名称 |
Status | String | pod状态 |
Ip | String | pod内网ip |
ZoneId | String | 可用区 |
CreateAt | String | 创建时间,ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') |
Containers | Object Array | 容器数组 |
Container对象格式为:
参数 | 类型 | 描述 |
Name | String | container名称 |
Image | String | 镜像URL |
Status | String | 容器状态 |
ContainerId | long | 容器id, 数据库主键 |
DockerContainerId | String | 容器在docker中的id |
2.10 删除Deployment实例
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=DeleteDeployment |
参数 | 类型 | 说明 | 备注 | 是否必填 |
NamespaceId | long | 空间Id | | 是 |
DeploymentId | long | Deployment Id | | 是 |
GET /ncs?Version=2017-11-16&Action=DeleteDeployment&NamespaceId=1&DeploymentId=1
无 或 ResourceNotFound IncorrectState