调用ListPrometheusRemoteWrites查询Prometheus实例的RemoteWrite配置列表

查询Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）Remote Write配置列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListPrometheusRemoteWrites	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
ClusterId	string	是	Prometheus 实例 ID。仅支持 aliyun-cs、ecs 两种类型的实例。	cc7a37ee31aea4ed1a059eff8034b** 或 vpc-**

返回参数

名称	类型	描述	示例值
	object	返回结果对象
RequestId	string	请求 ID	9319A57D-2D9E-472A-B69B-CF3CD16D****
Data	object []	返回 prometheus 的 remote write 配置列表	[ { "name": "TiDBxxx", "yaml": "remote_write:\\n- basic_auth: {password: '****', username: xxx}\\n name: TiDBxxx\\n write_relabel_configs:\\n - regex: si-6e2ca86444db4e55a7c1\\n source_labels: [instance_id]\\n action: keep\\n separator: ;\\n replacement: $1\\n url: http://xxx:8080/prometheus/xxx/ddd/cn-hangzhou/api/v3/write\\n" }, { "name": "TiDBxxx1", "yaml": "remote_write:\\n- basic_auth: {password: '****', username: xxx}\\n name: TiDBxxx1\\n write_relabel_configs:\\n - regex: si-6e2ca86444db4e55a7c1\\n source_labels: [instance_id]\\n action: keep\\n separator: ;\\n replacement: $1\\n url: http://xxx:8080/prometheus/xxx/ddd/cn-hangzhou/api/v3/write\\n" } ]
ClusterId	string	prometheus 实例 id	c589a1b8db05c4561aefbb898ca8fb1cf
RemoteWriteName	string	remote write 名称	abc123
RemoteWriteYaml	string	prometheus remote write 配置（yaml 格式）。	参见返回参数补充说明。
Success	boolean	操作是否成功：true：操作成功 false：操作失败	true
Message	string	返回结果的提示信息。	message
Code	integer	状态码。200 为成功，其他状态码为异常。	200

RemoteWriteYaml 示例值：

remote_write:
  - name: rw1
    url: "http://cn-hangzhou-intranet.arms.aliyuncs.com/prometheus/uid/xx/cn-hangzhou/api/v3/write"
    basic_auth:
      username: xxx
      password: xxx
    write_relabel_configs:
      - source_labels: [ instance_id ]
        separator: ;
        regex: si
        replacement: $1
        action: keep

示例

正常返回示例

JSON格式

{
  "RequestId": "9319A57D-2D9E-472A-B69B-CF3CD16D****",
  "Data": [
    {
      "ClusterId": "c589a1b8db05c4561aefbb898ca8fb1cf",
      "RemoteWriteName": "abc123",
      "RemoteWriteYaml": "参见返回参数补充说明。"
    }
  ],
  "Success": true,
  "Message": "message",
  "Code": 200
}

错误码

HTTP status code	错误码	错误信息
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史