ModifyInstanceAttributes - 修改实例信息元信息--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

ModifyInstanceAttributes - 修改实例信息元信息

最近更新时间：2024.11.18 10:27:30首次发布时间：2023.07.12 16:22:34

调用 ModifyInstanceAttributes 接口修改对应实例名称、描述、TPS比例等实例配置信息。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyInstanceAttributes	要执行的操作，取值：ModifyInstanceAttributes。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
ProductInfo	Object	是	/	产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例 ID。
InstanceName	String	否	myinstance	实例名称。
InstanceDescription	String	否	New instance	实例描述。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=ModifyInstanceAttributes&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-cnai1f0c29ca****",
  "InstanceName": "rocketmq-doc",
  "InstanceDescription": "rocketmq-doc"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202302271847143C6FF96F30A58C7F0FE4",
        "Action": "ModifyInstanceAttributes",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {}
}

错误码

公共错误码请参见公共错误码文档。