更新Prometheus实例信息。
接口说明
更新 Prometheus 实例信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cms:UpdatePrometheusInstance | update | *PrometheusInstance acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#prometheusInstanceId} |
| 无 |
请求语法
PUT /prometheus-instances/{prometheusInstanceId} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| prometheusInstanceId | string | 是 | prometheus 实例 ID | rw-xxxxxxx |
| body | object | 否 | 请求体。 | |
| archiveDuration | integer | 否 | 存储到期后,自动归档保存的天数,0 表示不归档保存。归档天数取值范围: V1:1~365 天。仅按指标写入量支持。 V2:1~3650 天(3650 表示永久保存)。 | 365 |
| authFreeReadPolicy | string | 否 | 免密读策略(支持 IP 段和 VpcId)。 | { "SourceIp": [ "192.168.1.0/24", "172.168.2.22" ], "SourceVpc": [ "vpc-xx1", "vpc-xx2" ] } |
| authFreeWritePolicy | string | 否 | 免密读策略(支持 IP 段和 VpcId)。 | { "SourceIp": [ "192.168.1.0/24", "172.168.2.22" ], "SourceVpc": [ "vpc-xx1", "vpc-xx2" ] } |
| enableAuthFreeRead | boolean | 否 | 是否开启免密读。 | true |
| enableAuthFreeWrite | boolean | 否 | 是否开启免密写。 | true |
| enableAuthToken | boolean | 否 | 是否开启访问 Token 鉴权。 | true |
| prometheusInstanceName | string | 否 | 实例名称。 | test-prom-name |
| status | string | 否 | 实例存储 db 状态(仅支持 RUNNING)。为空时,不改变存储 db 状态。 | RUNNING |
| storageDuration | integer | 否 | 存储时长(天): 按写入量:90、180。 按指标上报量:15、30、60、90、180。 | 90 |
| paymentType | string | 否 | 计费方式(实例的生命周期内,只能修改一次): POSTPAY:按指标上报量后付费。 POSTPAY_GB:按指标写入量后付费。 | POSTPAY_GB |
| workspace | string | 否 | 归属的工作空间。 | default-cms-1500199863951574-cn-shanghai |
返回参数
示例
正常返回示例
JSON格式
{
"prometheusInstanceId": "rw-abc123",
"requestId": "1E92F783-E057-58F1-BD5C-92DED088E7A5"
}错误码
访问错误中心查看更多错误码。
