ListWaypoints - 获取数据面集群的Waypoint配置

调用ListWaypoints获取数据面集群某个命名空间下所有Waypoint配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

servicemesh:ListWaypoints

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ServiceMeshId	string	是	服务网格实例 ID	c08ba3fd1e6484b0f8cc1ad8fe10d****
ClusterId	string	是	数据面集群 ID。	ce3c25e247da24f3aab9b7edfae83****
Namespace	string	否	命名空间。	default
Name	string	否	waypoint 名称。为空时，返回所有 waypoint；不为空时，查询指定名称 waypoint。	bookinfo-productpage
Limit	integer	否	限制返回的 waypoint 数量。	30
Continue	string	否	配合 Limit 使用，用于从指定 offset 开始查询 waypoint。第一次调用时，填写空即可。如果返回结果中 Continue 不为空，即代表还有未返回的数据，需要带上返回的 Continue 继续调用。	eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MjY4Njc5Miwic3RhcnQiOiJkZWZhdWx0L2Jvb2tpbmZvLXByb2R1Y3RwYWdlXHUwMDAwIn0

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	BD65C0AD-D3C6-48D3-8D93-38D2015C****
Waypoints	array<object>	Waypoint 配置列表。
	object	Waypoint 配置。
Name	string	Waypoint 对应的 Gateway 资源名称。如果 ServiceAccount 生效，则与 ServiceAccount 同名；如果命名空间生效，则名称为 `namespace`。	namespace
ServiceAccount	string	Waypoint 生效的 ServiceAccount。如果为空，表示对整个命名空间生效。	bookinfo-productpage
Namespace	string	命名空间。	default
RequestCPU	string	Waypoint Pod 请求的 CPU 资源。	100m
RequestMemory	string	Waypoint Pod 请求的内存资源。	128Mi
LimitCPU	string	Waypoint Pod 的 CPU 资源限制。	2000m
LimitMemory	string	Waypoint Pod 的内存资源限制。	1024Mi
Replicas	string	Waypoint Pod 的副本数。	1
HPAEnabled	string	是否开启 HPA。	false
HPATargetCPU	string	HPA 目标 CPU 使用率。	93
HPATargetMemory	string	HPA 目标内存使用率。	91
HPAMinReplicas	string	HPA 最小副本数。	2
HPAMaxReplicas	string	HPA 最大副本数。	4
PreferECI	string	是否优先调度到 ECI 节点。	false
Continue	string	base64 编码的字符串。如果为空，表示已经获取到所有的 waypoint；如果不为空，下次 list 时带上该值，可以接着从本次截止的 offset 继续获取。	eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MjY4Njc5Miwic3RhcnQiOiJkZWZhdWx0L2Jvb2tpbmZvLXByb2R1Y3RwYWdlXHUwMDAwIn0

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。