You need to enable JavaScript to run this app.
导航

【产品变更】OpenAPI(ListWorkspaces、GetWorkspace)变更通知

最近更新时间2023.04.27 11:00:04

首次发布时间2023.03.31 17:17:24

背景

为了更好地实现监控数据的读写负载均衡,提升用户的使用体验,托管 Prometheus(VMP)计划将工作区的读写接口进行分离,从原来 读写接口共用一个域名 变更为 读写接口分别使用单独的子域名

变更之后,读写接口(Remote Write 和 Query)发生了如下变化:ListWorkspaces、GetWorkspace 两个接口的 Response 信息发生了变化,如果有依赖这两个接口 Response 相应的字段需要进行提前变更,以免业务受到影响。

影响客户

通过调用 ListWorkspaces、GetWorkspace 接口来获得PrometheusIntranetEndpoint字段,从而获取工作区的读写接口(Endpoint)的客户会有影响,其余客户没有影响。

变更详情

说明

本次变更仅涉及 OpenAPI 变更,数据面不进行变更,即此次变更旧的数据面 API 不会进行下线,详情请参见 数据面 API 说明。旧的数据面 API 下线时间会另外进行通知。

OpenAPI 变更说明

  • ListWorkspaces:Response 中PrometheusIntranetEndpoint字段下线,以PrometheusQueryIntranetEndpoint字段和PrometheusWriteIntranetEndpoint字段替代PrometheusIntranetEndpoint字段,提供内网读写接口。
  • GetWorkspace: Response 中PrometheusIntranetEndpoint字段下线,以PrometheusQueryIntranetEndpoint字段和PrometheusWriteIntranetEndpoint字段替代PrometheusIntranetEndpoint字段,提供内网读写接口。

说明

变更时间:预计2023年4月24日执行以上变更。

数据面 API 说明

数据面 API 指的是托管 Prometheus 提供的兼容 Prometheus 协议的 Remote Write 和 Query 接口,即控制台上可以看见的读写 Endpoint,如下图所示。
PrometheusIntranetEndpoint字段对应是的旧数据面 API,读写为一个域名:http://prometheus-${region}.ivolces.com/workspaces/${WorkspaceId}
PrometheusWriteIntranetEndpointPrometheusQueryIntranetEndpoint字段对应是新的数据面 API,读写域名不一样:
http://write.prometheus-${region}.ivolces.com/workspaces/${WorkspaceId}
http://query.prometheus-${region}.ivolces.com/workspaces/${WorkspaceId}
alt