文档

AddPrometheusInstance - 创建RemoteWrite类型的Prometheus实例

更新时间:

创建RemoteWrite类型Prometheus实例。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
Namestring

Remote Write 实例类型的名称。

notificationpolicy_test
Typestring

实例类型, 目前仅支持 Remote Write 类型, 简写 RW。

RW

返回参数

名称类型描述示例值
object
Datastring

返回结构体。 { "RequestId": 请求 ID, "Data": "{ "clusterType": 集群类型, "remoteWriteUrl": remote write 公网链接, "internetGrafanaUrl": Grafana 内网链接, "authToken": 是否开启 Token, "internetPushGatewayUrl": PushGateway 内网链接, "clusterId": 集群 ID, "internetRemoteReadUrl": remote read 内网链接, "remoteReadUrl": remote read 公网链接, "grafanaUrl": Grafana 公网链接, "pushGatewayUrl": PushGateway 公网链接, "internetRemoteWriteUrl": remote write 内网链接}" }

{ "RequestId": "1293091C-54AD-50FE-B787-E314B94B35AB", "Data": "{ "clusterType":"remote-write-prometheus", "remoteWriteUrl":"http://cn-hu/api/v3/write", "internetGrafanaUrl":"https://cn-hanga/cn-hangzhou", "authToken":false, "internetPushGatewayUrl":"https://cangzhou/api/v2", "clusterId":"vrju1lj3sa|123456", "internetRemoteReadUrl":"https://cn-hangzh67cn-hangzhou/api/v1/read", "remoteReadUrl":"http://cn-hanou/api/v1/read", "grafanaUrl":"http://cn-angzhou", "pushGatewayUrl":"htt1lj3sa/cn-hangzhou/api/v2", "internetRemoteWriteUrl":"httpsngzhou/api/v3/write"}" }
RequestIdstring

请求 ID。

9319A57D-2D9E-472A-B69B-CF3CD16D****
Codeinteger

返回码。返回 200 代表成功。

200
Messagestring

返回结果的提示信息。

success
Successboolean

调用是否成功。

true

示例

正常返回示例

JSON格式

{
  "Data": "{\n  \"RequestId\": \"1293091C-54AD-50FE-B787-E314B94B35AB\",\n  \"Data\": \"{\n  \"clusterType\":\"remote-write-prometheus\",\n  \"remoteWriteUrl\":\"http://cn-hu/api/v3/write\",\n  \"internetGrafanaUrl\":\"https://cn-hanga/cn-hangzhou\",\n  \"authToken\":false,\n  \"internetPushGatewayUrl\":\"https://cangzhou/api/v2\",\n  \"clusterId\":\"vrju1lj3sa|123456\",\n  \"internetRemoteReadUrl\":\"https://cn-hangzh67cn-hangzhou/api/v1/read\",\n  \"remoteReadUrl\":\"http://cn-hanou/api/v1/read\",\n  \"grafanaUrl\":\"http://cn-angzhou\",\n  \"pushGatewayUrl\":\"htt1lj3sa/cn-hangzhou/api/v2\",\n  \"internetRemoteWriteUrl\":\"httpsngzhou/api/v3/write\"}\"\n}",
  "RequestId": "9319A57D-2D9E-472A-B69B-CF3CD16D****",
  "Code": 200,
  "Message": "success",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-03-23OpenAPI 返回结构发生变更查看变更详情
2022-07-29新增 OpenAPI查看变更详情