DescribeServiceMeshUpgradeStatus - Alibaba Cloud Service Mesh

Queries the upgrade details of a Service Mesh (ASM) instance and its ingress gateways.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	11fd0027-c27e-41bb-a565-75583054****
UpgradeDetail	object	The upgrade results.
FinishedGatewaysNum	long	The number of ingress 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 of the instance fails.	running
TotalGatewaysNum	long	The total number of ingress gateways in the ASM instance.	2
GatewayStatusRecord	object	The information about the status of the ingress gateways.
	object	The status of the ingress gateway.
Status	string	The upgrade status of the ingress gateway. Valid values: `upgrading`: The ingress gateway is being upgraded. `pending`: The ingress gateway waits to be upgraded. `finished`: The ingress gateway upgrade is complete. `notStart`: The ingress gateway upgrade does not start. `failed`: The ingress gateway upgrade fails. `unknown`: The upgrade status of the ingress gateway is unknown.	upgrading
Message	string	Additional status information of the ingress gateway.	success
Version	string	The version of the ingress gateway.	1.9.7

Examples

Sample success responses

JSONformat

{
  "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
404	ERR404	Not found

For a list of error codes, visit the Service error codes.