创建一键体验任务 - CreateWorkshop
功能介绍
该API用于创建一键体验任务
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
URI
POST /v2/meshes/{mesh_id}/workshops
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
mesh_id |
是 |
String |
网格ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
消息体的类型（格式）。 取值范围： |
|
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
description |
否 |
String |
描述 |
|
metadata |
是 |
WorkshopMetadata object |
网格灰度发布任务的基本信息，为集合类的元素类型，包含一组由不同名称定义的属性 |
|
spec |
是 |
WorkshopSpec object |
一键体验任务属性 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
primaryCluster |
是 |
String |
部署一键体验任务的工作负载和网关入口的集群ID |
|
ingress |
是 |
WorkshopIngress object |
一键体验任务网关入口属性 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
description |
String |
描述 |
|
metadata |
WorkshopMetadata object |
网格灰度发布任务的基本信息，为集合类的元素类型，包含一组由不同名称定义的属性 |
|
spec |
WorkshopSpec object |
一键体验任务属性 |
|
status |
WorkshopStatus object |
一键体验任务状态 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
一键体验任务名称 |
|
uid |
String |
一键体验任务ID，资源唯一标识，创建成功后自动生成，填写无效 |
|
creationTimestamp |
String |
一键体验任务创建时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
primaryCluster |
String |
部署一键体验任务的工作负载和网关入口的集群ID |
|
ingress |
WorkshopIngress object |
一键体验任务网关入口属性 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
elbId |
String |
网关使用的ELB ID |
|
elbIp |
String |
网关使用的ELB IP |
|
port |
Integer |
网关对外暴露提供访问的端口 |
|
imageAddress |
String |
一键体验任务的镜像地址 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errorCode |
String |
错误码 |
|
errorMsg |
String |
错误描述 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errorCode |
String |
错误码 |
|
errorMsg |
String |
错误描述 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功创建一键体验任务 |
|
400 |
参数有误，创建一键体验任务请求体失败 |
|
500 |
内部错误 |
错误码
请参见错误码。
