ListWaypoints - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Queries the configurations of all waypoint proxies in a namespace of a cluster on the data plane.

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 Service Mesh (ASM) instance ID.	c08ba3fd1e6484b0f8cc1ad8fe10d****
ClusterId	string	Yes	The ID of the cluster on the data plane.	ce3c25e247da24f3aab9b7edfae83****
Namespace	string	No	The namespace.	default
Name	string	No	Waypoint which you want to get. If empty, return all waypoints.	bookinfo-productpage
Limit	long	No	Limit the number of waypoints returned.	30
Continue	string	No	Used in conjunction with Limit, it is used to query waypoints starting from a specified offset. When calling for the first time, no need to care abount it. If the Continue in the returned result is not empty, it means that there is still data that has not been returned, and you need to continue the call with the returned Continue.	eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MjY4Njc5Miwic3RhcnQiOiJkZWZhdWx0L2Jvb2tpbmZvLXByb2R1Y3RwYWdlXHUwMDAwIn0

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	BD65C0AD-D3C6-48D3-8D93-38D2015C****
Waypoints	object []	The configurations of waypoint proxies.
Name	string	The name of the gateway resource for the waypoint proxy. If the waypoint proxy applies to a service account, the name is the service account name. If the waypoint proxy applies to the entire namespace, the name is `namespace`.	namespace
ServiceAccount	string	The service account to which the waypoint proxy applies. If no value is returned for this parameter, the waypoint proxy applies to the entire namespace.	bookinfo-productpage
Namespace	string	The namespace.	default
RequestCPU	string	The amount of CPU resources requested by the waypoint proxy pods.	100m
RequestMemory	string	The amount of memory resources requested by the waypoint proxy pods.	128Mi
LimitCPU	string	The maximum amount of CPU resources that are available to the waypoint proxy pods.	2000m
LimitMemory	string	The maximum amount of memory resources that are available to the waypoint proxy pods.	1024Mi
Replicas	string	The number of waypoint proxy pods.	1
HPAEnabled	string	Indicates whether Horizontal Pod Autoscaling (HPA) is enabled.	false
HPATargetCPU	string	The expected CPU utilization when HPA is enabled.	93
HPATargetMemory	string	The expected memory usage when HPA is enabled.	91
HPAMinReplicas	string	The minimum number of waypoint proxy pods when HPA is enabled.	2
HPAMaxReplicas	string	The maximum number of waypoint proxy pods when HPA is enabled.	4
PreferECI	string	Indicates whether waypoint proxy pods are preferentially scheduled to elastic container instances.	false
Continue	string	Base64 encoded string. If it is empty, it means that all waypoints have been obtained; if it is not empty, this value should be included in the next list, and you can continue to obtain it from the offset that ends this time.	eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MjY4Njc5Miwic3RhcnQiOiJkZWZhdWx0L2Jvb2tpbmZvLXByb2R1Y3RwYWdlXHUwMDAwIn0

Examples

Sample success responses

JSONformat

{
  "RequestId": "BD65C0AD-D3C6-48D3-8D93-38D2015C****",
  "Waypoints": [
    {
      "Name": "namespace",
      "ServiceAccount": "bookinfo-productpage",
      "Namespace": "default",
      "RequestCPU": "100m",
      "RequestMemory": "128Mi",
      "LimitCPU": "2000m",
      "LimitMemory": "1024Mi",
      "Replicas": "1",
      "HPAEnabled": "false",
      "HPATargetCPU": "93",
      "HPATargetMemory": "91",
      "HPAMinReplicas": "2",
      "HPAMaxReplicas": "4",
      "PreferECI": "false"
    }
  ],
  "Continue": "eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MjY4Njc5Miwic3RhcnQiOiJkZWZhdWx0L2Jvb2tpbmZvLXByb2R1Y3RwYWdlXHUwMDAwIn0"
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2023-11-08

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Name
	Added Input Parameters: Limit
	Added Input Parameters: Continue
Output Parameters	The response structure of the API has changed.