DescribeServiceMeshProxyStatus - Alibaba Cloud Service Mesh

Queries the status of an Istio proxy.

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:DescribeServiceMeshProxyStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ID of the ASM instance.	ca04bc38979214bf2882be79d39b4****

Response elements

Element	Type	Description	Example
	object	The status of the proxy.
Message	string	The response message.	success
RequestId	string	The ID of the request.	31d3a0f0-07ed-4f6e-9004-1804498c****
ProxyStatus	array<object>	A list of proxy statuses.
	object	The status of the proxy.
ProxyVersion	string	The version of the proxy.	1.9.7
ClusterSynced	string	The status of the proxy. Valid values: `SYNCED`: The proxy status is synchronized. `NOT SENT`: The proxy status is not synchronized. `STALE (Never Acknowledged)`: Istiod sent a proxy status update to Envoy, but an acknowledgment was never received. `STALE`: Istiod sent a proxy status update to Envoy, but an acknowledgment has not been received.	SYNCED
EndpointPercent	string	The percentage of endpoints.	1
ListenerSynced	string	The synchronization status of the listener. Valid values: `SYNCED`: The listener status is synchronized. `NOT SENT`: The listener status is not synchronized. `STALE (Never Acknowledged)`: Istiod sent a listener status update to Envoy, but an acknowledgment was never received. `STALE`: Istiod sent a listener status update to Envoy, but an acknowledgment has not been received.	SYNCED
RouteSynced	string	The synchronization status of the route. Valid values: `SYNCED`: The route status is synchronized. `NOT SENT`: The route status is not synchronized. `STALE (Never Acknowledged)`: Istiod sent a route status update to Envoy, but an acknowledgment was never received. `STALE`: Istiod sent a route status update to Envoy, but an acknowledgment has not been received.	SYNCED
EndpointSynced	string	The synchronization status of the endpoint. Valid values: `SYNCED`: The endpoint status is synchronized. `NOT SENT`: The endpoint status is not synchronized. `STALE (Never Acknowledged)`: Istiod sent an endpoint status update to Envoy, but an acknowledgment was never received. `STALE`: Istiod sent an endpoint status update to Envoy, but an acknowledgment has not been received.	SYNCED
ProxyId	string	The ID of the proxy.	119q****
IstioVersion	string	The version of Istiod.	1.9.7
Code	string	The status code. Valid values: - `200`: The status of the Istio proxy was queried. `403`: Permission denied. `503`: A backend service error occurred.	200
Success	string	Indicates whether the request was successful.	success

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.