变更存储策略
所有文档
menu

消息服务 for Kafka

变更存储策略

产品详情立即开通

该接口用于变更集群磁盘存储策略。

请求结构

PUT /v{version}/clusters/{clusterId}/update-storage-policy HTTP/1.1
Host: kafka-api.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其他特殊头域。

请求参数

参数名称 类型 是否必须 参数位置 描述
version String URL参数 API版本号
clusterId String URL参数 集群ID
storagePolicyEnabled Boolean Request Body参数 是否开启磁盘水位处理
storagePolicy StoragePolicy Request Body参数 磁盘阈值策略的方式,参见 StoragePolicy

返回头域

除公共头域外,无其他特殊头域。

返回参数

参数名称 类型 描述
clusterId String 集群ID
jobId String 变更任务ID

错误码

错误码 错误描述 HTTP状态码 描述
ERROR_PARAMS 请求参数错误 400 请求参数错误
CLUSTER_NOT_FOUND 集群不存在 451 集群不存在
CLUSTER_NOT_ACTIVE 集群非运行状态 451 集群非运行状态
UPDATE_CLUSTER_FORBIDDEN 集群不可执行更新操作 451 集群不可执行更新操作
STOCK_FAILED 库存不足 451 库存不足
UPDATE_CLUSTER_ORDER_FAILED 集群更新下单失败 451 集群更新下单失败
INTERNAL_ERROR 服务内部错误 500 服务内部错误

请求示例

PUT http://kafka-api.bj.baidubce.com/v2/clusters/33a168bb70c0459787416077114ab233/update-storage-policy
Authorization: bce-auth-v1/ALTAKaiKeDfBD880eMWBE5oIGE/2023-05-08T11:43:45Z/1800/host;x-bce-date/322f3f98ce57d296c0f5abc64e5554b640ea035c5cb462fcaeab54b9810a3c61
Host: kafka-api.bj.baidubce.com
{
    "storagePolicyEnabled": true,
    "storagePolicy": {
        "type": "AUTO_DELETE",
        "autoDelete": {
            "diskUsedThresholdPercent": 75,
            "logMinRetentionMs": 3600000,
            "logMinRetentionBytes": 2147483648
        }
	}
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 97e6d4ad-6fca-4609-ad4d-9a27c4d1a362
Date: Mon, 08 May 2023 09:39:11 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "clusterId": "33a168bb70c0459787416077114ab233",
    "jobId": "16411be300de729baaee9b4dc3f0e4cd"
}
上一篇
集群配置接口
下一篇
变更集群配置