Creating a Mesh Canary Upgrade Task

This API is used to create a mesh canary upgrade 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:upgrade

Write

mesh *

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

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

POST /v1/{project_id}/mesh-upgrade

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project 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
kind	Yes	String	API type. Fixed value: MeshUpgrade
apiVersion	Yes	String	API version. Fixed value: v1
metadata	Yes	MeshCanaryUpgradeMetadata object	Basic information about a mesh canary upgrade task. Metadata is a collection of attributes.
spec	Yes	MeshCanaryUpgeadeSpec object	Attributes of a mesh canary upgrade task
status	No	MeshCanaryUpgeadeStatus object	Status of a mesh canary upgrade task

**Table 4** MeshCanaryUpgradeMetadata
Parameter	Mandatory	Type	Description
name	Yes	String	Name of a mesh canary upgrade task

**Table 5** MeshCanaryUpgeadeSpec
Parameter	Mandatory	Type	Description
meshId	Yes	String	ID of the mesh to be upgraded
upgradeStrategy	Yes	String	Mesh upgrade policy
targetVersion	Yes	String	Target mesh version
targetType	Yes	String	Target mesh type
currentStep	Yes	MeshCanaryUpgradeCurrentStep object	Current upgrade step

**Table 6** MeshCanaryUpgradeCurrentStep
Parameter	Mandatory	Type	Description
name	Yes	String	Name of a canary upgrade step
action	Yes	String	Action of a canary upgrade step

**Table 7** MeshCanaryUpgeadeStatus
Parameter	Mandatory	Type	Description
state	No	String	Status of a canary upgrade task
currentStep	No	MeshCanaryUpgeadeCurrentStepStatus object	Status of the current step in a canary upgrade task
updatedAt	No	String	Update time of a canary upgrade task

**Table 8** MeshCanaryUpgeadeCurrentStepStatus
Parameter	Mandatory	Type	Description
id	No	String	Current step ID in a mesh canary upgrade task
phase	No	String	Current step status in a mesh canary upgrade task
startTime	No	String	Start time of the current step in a mesh canary upgrade task

Status code: 200

**Table 9** Response body parameters
Parameter	Type	Description
kind	String	API type. Fixed value: MeshUpgrade
apiVersion	String	API version. Fixed value: v1
metadata	MeshCanaryUpgradeMetadata object	Basic information about a mesh canary upgrade task. Metadata is a collection of attributes.
spec	MeshCanaryUpgeadeSpec object	Attributes of a mesh canary upgrade task
status	MeshCanaryUpgeadeStatus object	Status of a mesh canary upgrade task

**Table 10** MeshCanaryUpgradeMetadata
Parameter	Type	Description
name	String	Name of a mesh canary upgrade task
uid	String	ID of a mesh canary upgrade task, which is unique. The value is automatically generated after the task is created. A custom value will not take effect.
creationTimestamp	String	Time when a mesh canary upgrade task is created

**Table 11** MeshCanaryUpgeadeSpec
Parameter	Type	Description
meshId	String	ID of the mesh to be upgraded
upgradeStrategy	String	Mesh upgrade policy
targetVersion	String	Target mesh version
targetType	String	Target mesh type
currentStep	MeshCanaryUpgradeCurrentStep object	Current upgrade step

**Table 12** MeshCanaryUpgradeCurrentStep
Parameter	Type	Description
name	String	Name of a canary upgrade step
action	String	Action of a canary upgrade step

**Table 13** MeshCanaryUpgeadeStatus
Parameter	Type	Description
state	String	Status of a canary upgrade task
currentStep	MeshCanaryUpgeadeCurrentStepStatus object	Status of the current step in a canary upgrade task
updatedAt	String	Update time of a canary upgrade task

**Table 14** MeshCanaryUpgeadeCurrentStepStatus
Parameter	Type	Description
id	String	Current step ID in a mesh canary upgrade task
phase	String	Current step status in a mesh canary upgrade task
startTime	String	Start time of the current step in a mesh canary upgrade task