文档

UpdatePrometheusRemoteWrite - 更新Prometheus实例remoteWrite配置

更新时间:

编辑Prometheus实例(仅支持aliyun-cs、ecs两种类型的实例)指定RemoteWrite配置。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
ClusterIdstring

prometheus 实例 Id。仅支持 aliyun-cs、ecs 两种类型的实例。

cc7a37ee31aea4ed1a059eff8034b****
RemoteWriteNamestring

prometheus remote write 配置名称。

rw1
RemoteWriteYamlstring

prometheus remote write 配置(yaml 格式)。

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

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

2A0CEDF1-06FE-44AC-8E21-21A5BE65****
Datastring

返回成功修改的 remoteWrite 名称,或异常信息。

rw1
Successboolean

操作是否成功:

  • true:操作成功
  • false:操作失败
true
Messagestring

返回结果的提示信息。

message
Codeinteger

状态码。说明 200 表示成功。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "2A0CEDF1-06FE-44AC-8E21-21A5BE65****",
  "Data": "rw1",
  "Success": true,
  "Message": "message",
  "Code": 200
}

错误码

HTTP status code错误码错误信息
400IdempotentParameterMismatchThe 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.

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈