创建灰度发布任务 - CreateRelease
功能介绍
该API用于创建灰度发布任务
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v2/meshes/{mesh_id}/namespaces/{namespace}/releases
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| mesh_id | 是 | String | 网格ID。 |
| namespace | 是 | String | 命名空间。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 消息体的类型(格式)。 取值范围: |
| X-Auth-Token | 是 | String | 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| kind | 否 | String | API类型,固定值“Release”,该值不可修改 |
| apiVersion | 否 | String | API版本,固定值“asm/v2”,该值不可修改 |
| metadata | 是 | ReleaseMetadata object | 网格灰度发布任务的基本信息,为集合类的元素类型,包含一组由不同名称定义的属性 |
| spec | 是 | ReleaseSpec object | 网格灰度发布任务属性 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| meshID | 否 | String | 灰度发布任务所属的网格ID |
| name | 是 | String | 灰度发布任务名称。 命名规则:以小写字母开头,由小写字母、数字、中划线(-)组成,长度范围4-64位,且不能以中划线(-)结尾 |
| uid | 否 | String | 灰度发布任务ID,资源唯一标识,创建成功后自动生成,填写无效 |
| namespace | 是 | String | 灰度发布任务所属的命名空间 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| serviceName | 是 | String | 网格灰度发布任务对应的服务名称 |
| clusterID | 是 | String | 网格灰度发布任务对应的集群ID |
| deploymentName | 是 | String | 网格灰度发布任务对应的工作负载名称 |
| version | 是 | String | 网格灰度发布任务对应的版本号 |
| type | 是 | String | 网格灰度发布任务类型 |
| grayDeployments | 是 | Array of GrayWorkload objects | 网格灰度发布任务的灰度工作负载模板 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| clusterID | 是 | String | 灰度工作负载所在的集群ID |
| template | 是 | Object | 灰度工作负载,参考Deployment | Kubernetes |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| kind | String | API类型,固定值“Release”,该值不可修改 |
| apiVersion | String | API版本,固定值“asm/v2”,该值不可修改 |
| metadata | ReleaseMetadata object | 网格灰度发布任务的基本信息,为集合类的元素类型,包含一组由不同名称定义的属性 |
| spec | ReleaseSpec object | 网格灰度发布任务属性 |
| status | ReleaseStatus object | 网格灰度发布任务状态 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| meshID | String | 灰度发布任务所属的网格ID |
| name | String | 灰度发布任务名称。 命名规则:以小写字母开头,由小写字母、数字、中划线(-)组成,长度范围4-64位,且不能以中划线(-)结尾 |
| uid | String | 灰度发布任务ID,资源唯一标识,创建成功后自动生成,填写无效 |
| namespace | String | 灰度发布任务所属的命名空间 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| serviceName | String | 网格灰度发布任务对应的服务名称 |
| clusterID | String | 网格灰度发布任务对应的集群ID |
| deploymentName | String | 网格灰度发布任务对应的工作负载名称 |
| version | String | 网格灰度发布任务对应的版本号 |
| type | String | 网格灰度发布任务类型 |
| grayDeployments | Array of GrayWorkload objects | 网格灰度发布任务的灰度工作负载模板 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| clusterID | String | 灰度工作负载所在的集群ID |
| template | Object | 灰度工作负载,参考Deployment | Kubernetes |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| phase | String | 网格灰度发布任务阶段 |
| startTime | String | 网格灰度发布任务启动时间 |
| updateTime | String | 网格灰度发布任务更新时间 |
| deployment | Object | 网格灰度发布任务原始工作负载,参考Deployment | Kubernetes |
| grayDeployments | Array of objects | 网格灰度发布任务创建的灰度工作负载,参考Deployment | Kubernetes |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errorCode | String | 错误码 |
| errorMsg | String | 错误描述 |
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功创建灰度发布任务 |
| 400 | 灰度发布任务参数有误,创建失败 |
错误码
请参见错误码。