文档

AddPrometheusGlobalView - 新增聚合实例

更新时间:

增加ARMS Prometheus监控的聚合实例。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
GroupNamestring

聚合实例名称。

zyGlobalView
Clustersstring

聚合实例列表,为 JSON 格式字符串。

[ { "sourceName": "数据源名称- ArmsPrometheus No.1", "sourceType":"AlibabaPrometheus", "userId":"UserID", "clusterId":"ClusterId", }, { "sourceName": "数据源名称 - MetrcStore No.2", "sourceType":"MetricStore", "dataSource":"MetricStore的 remote read 地址", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Custom ", "sourceType":"CustomPrometheus", "dataSource":"自建Prometheus数据源 remoteread地址", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Other one ", "sourceType":"Others", "dataSource":"其他数据源如Tencent remoteread地址", "headers":{ "AnyHeaderToFill":"需要填充的Headers" }, "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } } // ....... more addre ]
ResourceGroupIdstring

资源组 ID。

rg-aek2eq4pecazwfy
Tagarray<object>

标签列表。

object

标签。

Keystring

标签键。

http.status_code
Valuestring

标签值。

200

返回参数

名称类型描述示例值
object
Dataobject

返回结构体。

Successboolean

查询是否成功。

  • true:成功。
  • false:失败。
true
Msgstring

附加说明信息。

OK
Infoobject

Info 级别信息。

RegionIdstring

地域 ID。

cn-hangzhou
GlobalViewClusterIdstring

聚合实例 ID。

global-v2-cn-1483223059272121-jmjjfznz
FailedInstancesstring

添加失败的实例列表。

[{"sourceName": "数据源名称- ArmsPrometheus","sourceType":"AlibabaPrometheus","userId":"UserID","clusterId":"ClusterId",}]
RequestIdstring

请求 ID,用于定位日志,排查问题。

34ED024E-9E31-434A-9E4E-D9D15C3****
Codeinteger

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

200
Messagestring

返回结果的提示信息。

success

示例

正常返回示例

JSON格式

{
  "Data": {
    "Success": true,
    "Msg": "OK",
    "Info": {
      "RegionId": "cn-hangzhou",
      "GlobalViewClusterId": "global-v2-cn-1483223059272121-jmjjfznz",
      "FailedInstances": "[{\"sourceName\": \"数据源名称- ArmsPrometheus\",\"sourceType\":\"AlibabaPrometheus\",\"userId\":\"UserID\",\"clusterId\":\"ClusterId\",}]"
    }
  },
  "RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3****",
  "Code": 200,
  "Message": "success"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-03-20OpenAPI 返回结构发生变更查看变更详情