UpdateInstanceMessageRetention - 修改实例消息保留时长--云原生消息引擎-火山引擎

文档中心

立即注册

导航

UpdateInstanceMessageRetention - 修改实例消息保留时长

最近更新时间：2024.12.11 16:59:13首次发布时间：2023.07.27 17:33:07

调用 UpdateInstanceMessageRetention 接口，修改目标实例下所有 Topic 的默认消息保留时长。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateInstanceMessageRetention&Version=2023-06-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateInstanceMessageRetention	要执行的操作，取值：UpdateInstanceMessageRetention。
Version	String	是	2023-06-01	API的版本，取值：2023-06-01。
Retention	Integer	是	96	实例下的所有 Topic 的默认消息保留时长，单位为小时。支持设置的留存范围为 1~336 小时（14天）。
InstanceId	String	是	o-00c0****m46c	BMQ 实例 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Status	String	SUCCESS	操作状态。
Message	String	OK	操作提示信息。

请求示例

POST /?Action=UpdateInstanceMessageRetention&Version=2023-06-01 HTTP/1.1
Host: bmq.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241104T134807Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=AK********/20241104/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=********

{
  "Retention": 96,
  "InstanceId": "o-00c0****m46c"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024110421481010518205812708****",
    "Action": "UpdateInstanceMessageRetention",
    "Version": "2023-06-01",
    "Service": "bmq",
    "Region": "cn-beijing"
  },
  "Result": {
    "Status": "SUCCESS",
    "Message": "OK"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	DatabaseError	database error	数据库错误。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。