文档

InstallManagedPrometheus - 创建托管Prometheus

更新时间:

创建托管(ASK/ECS)Prometheus。

接口说明

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

调试

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

授权信息

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

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

集群类型。

枚举值:
  • ecsecs
  • oneone
  • askask
  • pro容器监控pro
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.

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

变更历史

变更时间变更内容概要操作
2024-01-03OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-09-10OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-05-15OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-11-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-11-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-01-04新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈