CreatePrometheusInstance_应用实时监控服务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.

流控信息

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

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
arms:CreatePrometheusInstance
Create
Prometheus
acs:arms:{#regionId}:{#accountId}:prometheus/*

请求参数

字段名称字段详情
RegionIdstring

实际 Region。

示例值:cn-shanghai
ClusterTypestring

类型有: 展开详情

示例值:remote-write参考取值来源:
    OpenVCluster
    ListClusterFromGrafana
VpcIdstring

用户专有网络 VPC。当 clusterType 为 ecs 或者 aliyun-cs 的托管版 ask 容器集群时,需要传此参数。

示例值:vpc-rpn**********
VSwitchIdstring

用户专有网络交换机 VSwitch。当 clusterType 为 ecs 或者 aliyun-cs 的托管版 ask 容器集群时,需要传此参数。

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

用户专有网络安全组 SecurityGroup。当 clusterType 为 ecs 或者 aliyun-cs 的托管版 ask 容器集群时,需要传此参数。

示例值:sg-bp1********参考取值来源:
    ListPrometheusInstanceByTagAndResourceGroupId
ClusterIdstring

用户容器服务集群 ID。当 clusterType 为 aliyun-cs 时,需要传此参数。

示例值:cc7a37ee31aea4ed1a059eff8034b****参考取值来源:
    AddTagToFlinkCluster
    ListClusterFromGrafana
ClusterNamestring

用户新建集群的名称。当 clusterType 为 remote-write、ecs、global-view 时,需要传此参数。展开详情

示例值:clusterNameOfTest参考取值来源:
    ListClusterFromGrafana
SubClustersJsonstring

globalView 实例的子实例 JSON 串。

示例值:当clusterType为global-view时,需要传此参数:需要聚合的集群的信息列表;示例: [ { "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
GrafanaInstanceIdstring

绑定的 Grafana 工作区 ID。使用共享版 Grafana 时,值为“free”。

示例值:grafana-bp1*****参考取值来源:
    GetPrometheusInstance
    ListPrometheusInstanceByTagAndResourceGroupId
ResourceGroupIdstring

资源组 ID。

示例值:rg-acfmxyexli2****参考取值来源:
    ChangeResourceGroup
    ListPrometheusInstanceByTagAndResourceGroupId
Tagsarray<object>

用户自定义标签。

示例值:[ { "labelName":"labelValue" }, { "testName":"clusterA" } ]子级条数 <= 21
Durationinteger<int32>

数据存储时长(天)。

示例值:90
ArchiveDurationinteger<int32>

存储到期后,自动归档保存的天数(可选值:60、90、180、365)。0 表示不归档保存。

示例值:90
PaymentTypestring

计费方式:展开详情

示例值:POSTPAY枚举值:POSTPAYPOSTPAY_GB

返回参数

字段名称字段详情
Datastring

新建实例成功后的实例 ID。展开详情

示例值:qduukd****
RequestIdstring

请求 ID。

示例值:70675725-8F11-4817-8106-CFE0AD71****
Messagestring

返回信息。

示例值:message
Codeinteger<int32>

接口状态码:展开详情

示例值:200

返回示例

变更历史

变更时间变更内容概要操作
2024-12-13
新增请求参数PaymentType
2024-12-05
变更请求参数ArchiveDuration
2024-04-12
变更请求参数Duration
新增请求参数ArchiveDuration
2024-02-28
新增请求参数Duration
2023-08-17
删除请求参数ParamJson
2023-08-11
新增请求参数ParamJson

相关示例