Queries the upgrade details of an Alibaba Cloud 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeServiceMeshUpgradeStatus

The operation that you want to perform. Set the value to DescribeServiceMeshUpgradeStatus.

ServiceMeshId String Yes 11fd0027-c27e-41bb-a565-75583054****

The ID of the ASM instance.

GuestClusterIds String No caeac85a793c94afbbb0a4bb20320****

The IDs of the clusters on the data plane of the ASM instance. Separate multiple clusters with commas (,).

AllIstioGatewayFullNames String No istio-system:ingressgateway1,istio-system:ingressgateway2

The fully qualified names of ingress gateways in the ASM instance. Separate multiple names with commas (,).

Response parameters

Parameter Type Example Description
RequestId String 11fd0027-c27e-41bb-a565-75583054****

The ID of the request.

UpgradeDetail Object

The upgrade results.

FinishedGatewaysNum Long 1

The number of ingress gateways that are upgraded.

MeshStatus String running

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.
TotalGatewaysNum Long 2

The total number of ingress gateways in the ASM instance.

GatewayStatusRecord Map

The information about the status of the ingress gateways.

Object

The status of the ingress gateway.

Status String upgrading

The status of the ingress gateway upgrade. 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.
Message String success

Indicates whether the operation to upgrade the ingress gateway is successful.

Version String 1.9.7

The version of the ingress gateway.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeServiceMeshUpgradeStatus
&ServiceMeshId=11fd0027-c27e-41bb-a565-75583054****
&GuestClusterIds=caeac85a793c94afbbb0a4bb20320****
&AllIstioGatewayFullNames=istio-system:ingressgateway1,istio-system:ingressgateway2
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeServiceMeshUpgradeStatusResponse>
    <RequestId>11fd0027-c27e-41bb-a565-75583054****</RequestId>
    <UpgradeDetail>
        <FinishedGatewaysNum>1</FinishedGatewaysNum>
        <MeshStatus>running</MeshStatus>
        <TotalGatewaysNum>2</TotalGatewaysNum>
        <GatewayStatusRecord>
            <key>
                <Status>upgrading</Status>
                <Message>success</Message>
                <Version>1.9.7</Version>
            </key>
        </GatewayStatusRecord>
    </UpgradeDetail>
</DescribeServiceMeshUpgradeStatusResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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
503 ERR404 Not found The error message returned because the requested resource does not exist.

For a list of error codes, visit the API Error Center.