InstallManagedPrometheus_应用实时监控服务ARMS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
arms:InstallManagedPrometheus
None
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

集群类型。

示例值:ask枚举值:ecsoneaskpro
VpcIdstring

集群所对应的 VPC。

示例值:vpc-xxxxxx
VSwitchIdstring

集群所对应的交换机。

示例值:vsw-bp1*********
SecurityGroupIdstring

集群所对应的安全组。

示例值:sg-bp1********
GrafanaInstanceIdstring

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

示例值:grafana-bp1*****
KubeConfigstring

当前参数不支持使用。

示例值:-
VcExtraInfostring

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:String 2A0CEDF1-06FE-44AC-8E21-21A5BE65****
Datastring

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

示例值:success
Successboolean

是否安装成功。

示例值:true
Messagestring

安装失败时响应描述。

示例值:vpcId is blank
Codeinteger<int32>

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

示例值:200

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
IdempotentParameterMismatch
The 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.诊断

变更历史

变更时间变更内容概要操作
2025-03-13
新增请求参数VcExtraInfo
2025-01-10
变更请求参数ClusterType
2024-08-05
新增deprecated
2024-01-03
变更请求参数ClusterType
2023-09-10
变更请求参数ClusterType

相关示例

2024年08月20日