Creating a One-Click Experience Task

This API is used to create a one-click experience task.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies
asm:mesh:createWorkshop

Write

mesh *

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
asm:mesh:createWorkshop	Write	mesh *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

POST /v2/meshes/{mesh_id}/workshops

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
mesh_id	Yes	String	Mesh ID

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format) Range: application/json;charset=utf-8: The content is in JSON format and encoded using UTF-8. application/json: The content is in JSON format.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	Description
metadata	Yes	WorkshopMetadata object	Basic information about the grayscale release task. Metadata is a collection of attributes.
spec	Yes	WorkshopSpec object	One-click experience task attributes

**Table 4** WorkshopMetadata
Parameter	Mandatory	Type	Description
name	Yes	String	One-click experience task name

**Table 5** WorkshopSpec
Parameter	Mandatory	Type	Description
primaryCluster	Yes	String	ID of the cluster where the workload and gateway reside for one-click experience task deployment
ingress	Yes	WorkshopIngress object	Gateway attributes in a one-click experience task

**Table 6** WorkshopIngress
Parameter	Mandatory	Type	Description
elbId	Yes	String	ELB ID used by the gateway
elbIp	Yes	String	ELB IP address used by the gateway
port	Yes	Integer	Port provided by the gateway for external systems to access
imageAddress	No	String	Image address of the one-click experience task

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
description	String	Description
metadata	WorkshopMetadata object	Basic information about the grayscale release task. Metadata is a collection of attributes.
spec	WorkshopSpec object	One-click experience task attributes
status	WorkshopStatus object	One-click experience task status

**Table 8** WorkshopMetadata
Parameter	Type	Description
name	String	One-click experience task name
uid	String	One-click experience task ID, which is unique. The value is automatically generated after the task is created. A custom value will not take effect.
creationTimestamp	String	Time when the one-click experience task is created

**Table 9** WorkshopSpec
Parameter	Type	Description
primaryCluster	String	ID of the cluster where the workload and gateway reside for one-click experience task deployment
ingress	WorkshopIngress object	Gateway attributes in a one-click experience task

**Table 10** WorkshopIngress
Parameter	Type	Description
elbId	String	ELB ID used by the gateway
elbIp	String	ELB IP address used by the gateway
port	Integer	Port provided by the gateway for external systems to access
imageAddress	String	Image address of the one-click experience task

**Table 11** WorkshopStatus
Parameter	Type	Description
updateTime	String	Time when the one-click experience task is updated

Status code: 400

**Table 12** Response body parameters
Parameter	Type	Description
errorCode	String	Error code

Status code: 500

**Table 13** Response body parameters
Parameter	Type	Description
errorCode	String	Error code

None

None

Status Code	Description
200	The one-click experience task is created.
400	Failed to create the request body for creating the one-click experience task due to incorrect parameters.
500	Internal error.

Parent topic: One-Click Experience

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.