CreatePrometheusInstance - 新建Prometheus实例 - 应用实时监控服务ARMS

新建Prometheus实例。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实际 Region。	cn-shanghai
ClusterType	string	是	类型有： remote-write：Prometheus for Remote Write ecs（不再支持）：Prometheus for ECS global-view：Prometheus for GlobalView aliyun-cs（不再支持）：Prometheus for 容器服务 cloud-product（不再支持）：Prometheus for 云服务 cloud-monitor（不再支持）：Prometheus for 企业云监控 flink（不再支持）: Prometheus for Flink	remote-write
VpcId	string	否	用户专有网络 VPC。当 clusterType 为 ecs 或者 aliyun-cs 的托管版 ask 容器集群时，需要传此参数。	vpc-rpn**********
VSwitchId	string	否	用户专有网络交换机 VSwitch。当 clusterType 为 ecs 或者 aliyun-cs 的托管版 ask 容器集群时，需要传此参数。	vsw-bp1*********
SecurityGroupId	string	否	用户专有网络安全组 SecurityGroup。当 clusterType 为 ecs 或者 aliyun-cs 的托管版 ask 容器集群时，需要传此参数。	sg-bp1********
ClusterId	string	否	用户容器服务集群 ID。当 clusterType 为 aliyun-cs 时，需要传此参数。	cc7a37ee31aea4ed1a059eff8034b****
ClusterName	string	否	用户新建集群的名称。当 clusterType 为 remote-write、ecs、global-view 时，需要传此参数。若是 ecs 类型实例，ClusterName 的命名规则为“name-vpc-id”，且 name 部分的长度不允许超过 24 个字符，例如“mytest1-vpc-xxxxxxxxxxx”。	clusterNameOfTest
SubClustersJson	string	否	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*********" } ]
AllSubClustersSuccess	boolean	否	创建 GlobalView 时，是否要求所有子实例都校验成功时，才创建 GlobalView 实例。默认是 false，即可以部分成功。	true
GrafanaInstanceId	string	是	绑定的 Grafana 工作区 ID。使用共享版 Grafana 时，值为“free”。	grafana-bp1*****
ResourceGroupId	string	否	资源组 ID。	rg-acfmxyexli2****
Tags	array<object>	否	用户自定义标签。	[ { "labelName":"labelValue" }, { "testName":"clusterA" } ]
	object	否	标签列表。
Key	string	否	标签的键（Key）。	TestKey
Value	string	否	标签的值（Value）。	TestValue
Duration	integer	否	数据存储时长（天）。	90
ArchiveDuration	integer	否	存储到期后，自动归档保存的天数（可选值：60、90、180、365）。0 表示不归档保存。	90

返回参数

名称	类型	描述	示例值
	object
Data	string	新建实例成功后的实例 ID。如果是 aliyun-cs 实例，则 Prometheus 实例 ID 就是 CS 的集群 ID。如果是 ecs 实例，则 Prometheus 实例 ID 就是 VPCID。	qduukd****
RequestId	string	请求 ID。	70675725-8F11-4817-8106-CFE0AD71****
Message	string	返回信息。	message
Code	integer	接口状态码： `2XX`：成功 `3XX`：重定向 `4XX`：请求错误 `5XX`：服务器错误	200

示例

正常返回示例

JSON格式

{
  "Data": "qduukd****",
  "RequestId": "70675725-8F11-4817-8106-CFE0AD71****",
  "Message": "message",
  "Code": 200
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-04-12	OpenAPI 入参发生变更	查看变更详情
2024-02-28	OpenAPI 入参发生变更	查看变更详情
2023-08-17	OpenAPI 入参发生变更	查看变更详情
2023-08-11	OpenAPI 入参发生变更	查看变更详情
2023-03-29	OpenAPI 入参发生变更	查看变更详情