Querying a Mesh Canary Upgrade Task

This API is used to query 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>	-	-

GET /v1/{project_id}/mesh-upgrade/{mesh_upgrade_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
mesh_upgrade_id	Yes	String	Mesh upgrade task ID

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
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.

Status code: 200

**Table 3** 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 4** 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 5** 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 6** MeshCanaryUpgradeCurrentStep
Parameter	Type	Description
name	String	Name of a canary upgrade step
action	String	Action of a canary upgrade step

**Table 7** 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 8** 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