全部产品
Search
文档中心

服务网格 ASM:ListWaypoints - 获取数据面集群的Waypoint配置

更新时间:Mar 05, 2024

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ServiceMeshIdstring

服务网格实例 ID

c08ba3fd1e6484b0f8cc1ad8fe10d****
ClusterIdstring

数据面集群 ID。

ce3c25e247da24f3aab9b7edfae83****
Namespacestring

命名空间。

default
Namestring

waypoint 名称。为空时,返回所有 waypoint;不为空时,查询指定名称 waypoint。

bookinfo-productpage
Limitlong

限制返回的 waypoint 数量。

30
Continuestring

配合 Limit 使用,用于从指定 offset 开始查询 waypoint。第一次调用时,填写空即可。如果返回结果中 Continue 不为空,即代表还有未返回的数据,需要带上返回的 Continue 继续调用。

eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MjY4Njc5Miwic3RhcnQiOiJkZWZhdWx0L2Jvb2tpbmZvLXByb2R1Y3RwYWdlXHUwMDAwIn0

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

BD65C0AD-D3C6-48D3-8D93-38D2015C****
Waypointsobject []

Waypoint 配置列表。

Namestring

Waypoint 对应的 Gateway 资源名称。如果 ServiceAccount 生效,则与 ServiceAccount 同名;如果命名空间生效,则名称为 namespace

namespace
ServiceAccountstring

Waypoint 生效的 ServiceAccount。如果为空,表示对整个命名空间生效。

bookinfo-productpage
Namespacestring

命名空间。

default
RequestCPUstring

Waypoint Pod 请求的 CPU 资源。

100m
RequestMemorystring

Waypoint Pod 请求的内存资源。

128Mi
LimitCPUstring

Waypoint Pod 的 CPU 资源限制。

2000m
LimitMemorystring

Waypoint Pod 的内存资源限制。

1024Mi
Replicasstring

Waypoint Pod 的副本数。

1
HPAEnabledstring

是否开启 HPA。

false
HPATargetCPUstring

HPA 目标 CPU 使用率。

93
HPATargetMemorystring

HPA 目标内存使用率。

91
HPAMinReplicasstring

HPA 最小副本数。

2
HPAMaxReplicasstring

HPA 最大副本数。

4
PreferECIstring

是否优先调度到 ECI 节点。

false
Continuestring

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-08OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Name
    新增入参:Limit
    新增入参:Continue
出参OpenAPI 返回结构发生变更