首页 可观测监控 Prometheus 版 API参考 API目录 Prometheus监控 InstallManagedPrometheus - 创建托管Prometheus

InstallManagedPrometheus - 创建托管Prometheus

调用InstallManagedPrometheus接口创建托管(ASK/ECS)Prometheus。

接口说明

只适用于ASK和ECS实例,且集群未安装过阿里云Prometheus,托管Prometheus将被安装在云产品侧,用户集群中不可见。

调试

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

调试

授权信息

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

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

请求参数

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

地域ID。

cn-hangzhou
ClusterIdstring

阿里云容器服务Kubernetes版的Kubernetes集群的ID。

cc7a37ee31aea4ed1a059eff8034b****
ResourceGroupIdstring

Prometheus实例的资源组ID。

rg-acfmxyexli2****
ClusterNamestring

集群名称。ClusterType为ecs时,必填。

prd-ecs
ClusterTypestring

集群类型。目前只支持ask、ecs和one集群。

ask
VpcIdstring

集群所对应的VPC。

vpc-xxxxxx
VSwitchIdstring

集群所对应的交换机。

vsw-bp1*********
SecurityGroupIdstring

集群所对应的安全组。

sg-bp1********
GrafanaInstanceIdstring

集群绑定的托管版Grafana工作区Id。为空或"free"时,绑定到共享版Grafana。

grafana-bp1*****
KubeConfigstring

当前参数不支持使用。

-

返回参数

名称类型描述示例值
object

响应结果对象。

RequestIdstring

请求ID。

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

响应内容。通常返回安装状态。

success
Successboolean

是否安装成功。

true
Messagestring

安装失败时响应描述。

vpcId is blank
Codeinteger

状态码。200为成功,其他状态码为异常。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "String\t2A0CEDF1-06FE-44AC-8E21-21A5BE65****",
  "Data": "success",
  "Success": true,
  "Message": "vpcId is blank",
  "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.

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

变更历史

变更时间变更内容概要操作
2023-05-15OpenAPI 描述信息更新,OpenAPI 错误码发生变更
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-11-28OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-11-28OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-01-04新增 OpenAPI
阿里云首页 可观测监控 Prometheus 版 相关技术圈