Queries the status of proxies on the data plane of an Alibaba Cloud Service Mesh (ASM) instance.

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 DescribeServiceMeshProxyStatus

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

ServiceMeshId String Yes ca04bc38979214bf2882be79d39b4****

The ID of the ASM instance.

Response parameters

Parameter Type Example Description
Message String success

The returned message.
RequestId String 31d3a0f0-07ed-4f6e-9004-1804498c****

The ID of the request.
ProxyStatus Array of ProxyStatus

The information about the status of the proxies on the data plane.
ProxyVersion String 1.9.7

The version number of the proxy on the data plane.
ClusterSynced String SYNCED

The update status of the proxy. Valid values:

  • SYNCED: The status of the proxy is updated.
  • NOT SENT: The status of the proxy is not updated.
  • STALE (Never Acknowledged): Istiod has sent multiple requests to the Envoy proxy to update the status of the proxy but receives no response.
  • STALE: Istiod has sent a request to the Envoy proxy to update the status of the proxy but receives no response.
EndpointPercent String 1

The percentage of the updated endpoints.
ListenerSynced String SYNCED

The update status of the listener. Valid values:

  • SYNCED: The status of the listener is updated.
  • NOT SENT: The status of the listener is not updated.
  • STALE (Never Acknowledged): Istiod has sent multiple requests to the Envoy proxy to update the status of the listener but receives no response.
  • STALE: Istiod has sent a request to the Envoy proxy to update the status of the listener but receives no response.
RouteSynced String SYNCED

The update status of the route. Valid values:

  • SYNCED: The status of the route is updated.
  • NOT SENT: The status of the route is not updated.
  • STALE (Never Acknowledged): Istiod has sent multiple requests to the Envoy proxy to update the status of the route but receives no response.
  • STALE: Istiod has sent a request to the Envoy proxy to update the status of the route but receives no response.
EndpointSynced String SYNCED

The update status of the endpoint. Valid values:

  • SYNCED: The status of the endpoint is updated.
  • NOT SENT: The status of the endpoint is not updated.
  • STALE (Never Acknowledged): Istiod has sent multiple requests to the Envoy proxy to update the status of the endpoint but receives no response.
  • STALE: Istiod has sent a request to the Envoy proxy to update the status of the endpoint but receives no response.
ProxyId String 119q****

The ID of the proxy on the data plane.
IstioVersion String 1.9.7

The version of Istiod.
Code String 200

The status code. Valid values:

200: The status code returned because the operation is successful.

  • 403: The status code returned because you are not authorized to perform this operation.
  • 503: The status code returned because a backend server error occurs.
Success String success

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeServiceMeshProxyStatus
&ServiceMeshId=ca04bc38979214bf2882be79d39b4****
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeServiceMeshProxyStatusResponse>
    <Message>success</Message>
    <RequestId>31d3a0f0-07ed-4f6e-9004-1804498c****</RequestId>
    <ProxyStatus>
        <ProxyVersion>1.9.7</ProxyVersion>
        <ClusterSynced>SYNCED</ClusterSynced>
        <EndpointPercent>1</EndpointPercent>
        <ListenerSynced>SYNCED</ListenerSynced>
        <RouteSynced>SYNCED</RouteSynced>
        <EndpointSynced>SYNCED</EndpointSynced>
        <ProxyId>119q****</ProxyId>
        <IstioVersion>1.9.7</IstioVersion>
    </ProxyStatus>
    <Code>200</Code>
    <Success>success</Success>
</DescribeServiceMeshProxyStatusResponse>

JSON format 

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

{
  "Message" : "success",
  "RequestId" : "31d3a0f0-07ed-4f6e-9004-1804498c****",
  "ProxyStatus" : {
    "ProxyVersion" : "1.9.7",
    "ClusterSynced" : "SYNCED",
    "EndpointPercent" : 1,
    "ListenerSynced" : "SYNCED",
    "RouteSynced" : "SYNCED",
    "EndpointSynced" : "SYNCED",
    "ProxyId" : "119q****",
    "IstioVersion" : "1.9.7"
  },
  "Code" : 200,
  "Success" : "success"
}

Error codes

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