DescribeServiceMeshProxyStatus - Alibaba Cloud Service Mesh

Queries the status of proxies on the data plane of a 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.

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.	ca04bc38979214bf2882be79d39b4****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Message	string	The returned message.	success
RequestId	string	The request ID.	31d3a0f0-07ed-4f6e-9004-1804498c****
ProxyStatus	object []	The information about the status of the proxies on the data plane.
ProxyVersion	string	The version number of a proxy on the data plane.	1.9.7
ClusterSynced	string	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.	SYNCED
EndpointPercent	string	The percentage of the updated endpoints.	1
ListenerSynced	string	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.	SYNCED
RouteSynced	string	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.	SYNCED
EndpointSynced	string	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.	SYNCED
ProxyId	string	The ID of the proxy on the data plane.	119q****
IstioVersion	string	The version of Istiod.	1.9.7
Code	string	The status code. Valid values: `200`: The operation is successful. `403`: You are not authorized to perform this operation. `503`: A backend server error occurs.	200
Success	string	Indicates whether the request was successful.	success

Examples

Sample success responses

JSONformat

{
  "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 Service error codes.