ListWaypoints - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

You can call ListWaypoints to retrieve all Waypoint configurations in a namespace of a data plane cluster.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ID of the Service Mesh instance.	c08ba3fd1e6484b0f8cc1ad8fe10d****
ClusterId	string	Yes	The ID of the data plane cluster.	ce3c25e247da24f3aab9b7edfae83****
Namespace	string	No	The namespace.	default
Name	string	No	The name of the waypoint. If this parameter is left empty, all waypoints are returned. Otherwise, only the waypoint with the specified name is returned.	bookinfo-productpage
Limit	integer	No	The maximum number of waypoints to return.	30
Continue	string	No	A pagination token used to retrieve the next page of results. For the first call, leave this parameter empty. If the response includes a Continue value, more results are available. To get the next page, include the returned Continue value in your next request.	eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MjY4Njc5Miwic3RhcnQiOiJkZWZhdWx0L2Jvb2tpbmZvLXByb2R1Y3RwYWdlXHUwMDAwIn0

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	BD65C0AD-D3C6-48D3-8D93-38D2015C****
Waypoints	array<object>	A list of Waypoint configurations.
	object	The Waypoint configuration.
Name	string	The name of the Gateway resource for the Waypoint. If the Waypoint applies to a service account, this value is the same as the service account name. If the Waypoint applies to a namespace, the name is `namespace`.	namespace
ServiceAccount	string	The service account for which the Waypoint is effective. If this parameter is empty, the Waypoint applies to the entire namespace.	bookinfo-productpage
Namespace	string	The namespace.	default
RequestCPU	string	The CPU resources requested for the Waypoint pod.	100m
RequestMemory	string	The memory resources requested for the Waypoint pod.	128Mi
LimitCPU	string	The CPU resource limit for the Waypoint pod.	2000m
LimitMemory	string	The memory resource limit for the Waypoint pod.	1024Mi
Replicas	string	The number of replicas for the Waypoint pod.	1
HPAEnabled	string	Indicates whether Horizontal Pod Autoscaling (HPA) is enabled.	false
HPATargetCPU	string	The target CPU utilization for HPA.	93
HPATargetMemory	string	The target memory usage for HPA.	91
HPAMinReplicas	string	The minimum number of replicas for HPA.	2
HPAMaxReplicas	string	The maximum number of replicas for HPA.	4
PreferECI	string	Indicates whether the Waypoint is preferentially scheduled to Elastic Container Instance (ECI) nodes.	false
Continue	string	A Base64-encoded string. If this parameter is empty, all waypoints have been returned. If this parameter is not empty, include it in your next request to retrieve the next page of results.	eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MjY4Njc5Miwic3RhcnQiOiJkZWZhdWx0L2Jvb2tpbmZvLXByb2R1Y3RwYWdlXHUwMDAwIn0

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.