新建Prometheus实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
arms:CreatePrometheusInstance | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 实际region。 | cn-shanghai |
ClusterType | string | 是 | 类型有:
| remote-write |
VpcId | string | 否 | 当clusterType为ecs或者aliyun-cs的托管版ask容器集群时,需要传此参数:用户专有网络VPC。 | vpc-rpn********** |
VSwitchId | string | 否 | 当clusterType为ecs或者aliyun-cs的托管版ask容器集群时,需要传此参数:用户专有网络交换机VSwitch。 | vsw-bp1********* |
SecurityGroupId | string | 否 | 当clusterType为ecs或者aliyun-cs的托管版ask容器集群时,需要传此参数:用户专有网络安全组SecurityGroup。 | sg-bp1******** |
ClusterId | string | 否 | 当clusterType为aliyun-cs时,需要传此参数:用户容器服务集群ID。 | 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 | object [] | 否 | 用户自定义标签 | [ { "labelName":"labelValue" }, { "testName":"clusterA" } ] |
Key | string | 否 | 标签的键(key)。 | TestKey |
Value | string | 否 | 标签的值(value)。 | TestValue |
返回参数
示例
正常返回示例
JSON
格式
{
"Data": "qduukd****",
"RequestId": "70675725-8F11-4817-8106-CFE0AD71****",
"Message": "message",
"Code": 200
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-08-17 | OpenAPI 入参发生变更 | 看变更集 | ||||
| ||||||
2023-08-11 | OpenAPI 入参发生变更 | 看变更集 | ||||
| ||||||
2023-03-29 | OpenAPI 入参发生变更 | 看变更集 | ||||
|