全部产品
Search
文档中心

应用实时监控服务ARMS:UpdatePrometheusGlobalView - 更新Prometheus for GlobalView聚合数据源

更新时间:Nov 05, 2024

更新Prometheus for GlobalView聚合数据源。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-shenzhen
GroupNamestring

聚合实例名称。

zyGlobalView
MostRegionIdstring

聚合实例所属地域 ID。

cn-hangzhou
ClusterIdstring

Prometheus 实例 ID。

global****
ResourceGroupIdstring

Prometheus 实例的资源组 ID。

rg-acfmxyexli2****
SubClustersJsonstring

需要聚合的 Ali Prometheus 集群或数据源的信息列表。

[ { "headers":{ }, "regionId":"cn-hangzhou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c39a1048921e04f***********", "sourceName":"arms-luyao-test", "dataSource":"", "userId":"1672753***********" }, { "headers":{ }, "regionId":"cn-beijing", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c6b6485496d5b40***********", "sourceName":"agent-321-测试", "dataSource":"", "userId":"1672753***********" }, { "headers":{ }, "regionId":"cn-zhangjiakou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c261a4f3200c446***********", "sourceName":"zaifeng-cardinality-01", "dataSource":"", "userId":"1672753***********" } ]
AllSubClustersSuccessboolean

创建 GlobalView 时,是否要求所有子实例都校验成功时,才创建 GlobalView 实例。默认是 false,即可以部分成功。

true

返回参数

名称类型描述示例值
object
Dataobject

返回结构体。

Successboolean

更新是否成功。

  • true:成功。
  • false:失败。
true
FailedInstancesarray<object>

更新失败的集群或数据源列表。

FailedInstanceobject
SourceNamestring

数据源名称。

sourcename-test
SourceTypestring

数据源类型:

  • AlibabaPrometheus
  • MetricStore
  • CustomPrometheus
AlibabaPrometheus
UserIdstring

用户标识。

23784673825*******
ClusterIdstring

Prometheus 实例 ID。

cdb65ed2d527345*********
RequestIdstring

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

E9C9DA3D-10FE-472E-9EEF-2D0A3E41****
Messagestring

安装失败时响应描述。

message
Codeinteger

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

200

示例

正常返回示例

JSON格式

{
  "Data": {
    "Success": true,
    "FailedInstances": [
      {
        "SourceName": "sourcename-test",
        "SourceType": "AlibabaPrometheus",
        "UserId": "23784673825*******",
        "ClusterId": "cdb65ed2d527345*********"
      }
    ]
  },
  "RequestId": "E9C9DA3D-10FE-472E-9EEF-2D0A3E41****",
  "Message": "message",
  "Code": 200
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-17OpenAPI 入参发生变更查看变更详情
2023-08-11OpenAPI 入参发生变更查看变更详情
2023-08-04OpenAPI 入参发生变更查看变更详情
2023-03-29OpenAPI 入参发生变更查看变更详情
2023-03-20API 内部配置变更,不影响调用查看变更详情