DescribeServiceMeshUpgradeStatus - Alibaba Cloud Service Mesh

Queries the upgrade status of an ASM instance and its ASM gateways.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicemesh:DescribeServiceMeshUpgradeStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ID of the ASM instance.	11fd0027-c27e-41bb-a565-75583054****
GuestClusterIds	string	No	The IDs of the data plane clusters that are added to the ASM instance. Separate multiple IDs with commas.	caeac85a793c94afbbb0a4bb20320****
AllIstioGatewayFullNames	string	No	The fully qualified names of the ASM gateways. Separate multiple names with commas.	istio-system:ingressgateway1,istio-system:ingressgateway2

Response elements

Element	Type	Description	Example
	object	The upgrade status.
RequestId	string	The request ID.	11fd0027-c27e-41bb-a565-75583054****
UpgradeDetail	object	The details of the upgrade status.
FinishedGatewaysNum	integer	The number of gateways that are upgraded.	1
MeshStatus	string	The status of the ASM instance. Valid values: running: The instance is running. `upgrading`: The instance is being upgraded. `upgrading_failed`: The upgrade failed.	running
TotalGatewaysNum	integer	The total number of gateways.	2
GatewayStatusRecord	object	The status records of the ASM gateways.
	object	The status of an ASM gateway.
Status	string	The upgrade status of the ASM gateway. Valid values: `upgrading`: The gateway is being upgraded. `pending`: The upgrade is pending. `finished`: The upgrade is complete. `notStart`: The upgrade has not started. `failed`: The upgrade failed. `unknown`: The status is unknown.	upgrading
Message	string	The additional status information about the ASM gateway.	success
Version	string	The version of the ASM gateway.	1.9.7

Examples

Success response

JSON format

{
  "RequestId": "11fd0027-c27e-41bb-a565-75583054****",
  "UpgradeDetail": {
    "FinishedGatewaysNum": 1,
    "MeshStatus": "running",
    "TotalGatewaysNum": 2,
    "GatewayStatusRecord": {
      "key": {
        "Status": "upgrading",
        "Message": "success",
        "Version": "1.9.7"
      }
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	ERR404	Not found

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.