AddPrometheusGlobalView - 新增聚合实例 - 可观测监控 Prometheus 版

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

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
GroupName	string	是	聚合实例名称。	zyGlobalView
Clusters	string	是	聚合实例列表，为 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 ]
ResourceGroupId	string	否	资源组 ID。	rg-aek2eq4pecazwfy
Tag	array<object>	否	标签列表。
	object	否	标签。
Key	string	否	标签键。	http.status_code
Value	string	否	标签值。	200

返回参数

名称	类型	描述	示例值
	object
Data	object	返回结构体。
Success	boolean	查询是否成功。 `true`：成功。 `false`：失败。	true
Msg	string	附加说明信息。	OK
Info	object	Info 级别信息。
RegionId	string	地域 ID。	cn-hangzhou
GlobalViewClusterId	string	聚合实例 ID。	global-v2-cn-1483223059272121-jmjjfznz
FailedInstances	string	添加失败的实例列表。	[{"sourceName": "数据源名称- ArmsPrometheus","sourceType":"AlibabaPrometheus","userId":"UserID","clusterId":"ClusterId",}]
RequestId	string	请求 ID，用于定位日志，排查问题。	34ED024E-9E31-434A-9E4E-D9D15C3****
Code	integer	状态码。说明 200 表示成功。	200
Message	string	返回结果的提示信息。	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-20	OpenAPI 返回结构发生变更	查看变更详情