You need to enable JavaScript to run this app.
文档中心
消息队列 RocketMQ版

消息队列 RocketMQ版

复制全文
下载 pdf
实例管理
ModifyInstanceSpec - 修改实例配置
复制全文
下载 pdf
ModifyInstanceSpec - 修改实例配置
调用 ModifyInstanceSpec 接口修改实例的计算规格、存储规格、增配分区数等产品规格。​
使用说明​
随着业务规模增长,如果实例规格不再满足需求,您可以适当升高实例的规格配置。此接口用于变更 RocketMQ 实例的规格,包括计算规格、存储空间和分区数量等配置。​
说明​
  • 调用此接口前,请确认实例状态为运行中(Running)。​
  • 目前仅支持升级实例配置,不支持降级,例如降级计算规格或缩容存储空间。​
  • 不同计算规格对应不同的存储空间范围,升级实例的计算规格时,需要同步升级存储空间。​
注意事项​
请求频率:该接口请求频率限制为 100 次/秒;单用户请求频率限制为 20 次/秒。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ModifyInstanceSpec​
要执行的操作,取值:ModifyInstanceSpec。​
​
Version string 必选 示例值:2023-01-01​
API的版本,取值:2023-01-01。​
​
ClientToken string 可选 示例值:123e4567-e89b-12d3-a456-42665544****​
保证客户端请求幂等性的标识。​
该标识为 1~64 位的 ASCII 字符串,大小写敏感,由客户端生成,应确保不同请求之间该标识具有唯一性。​
如何使用幂等标识,请参考请求幂等性。​
​
InstanceId string 必选 示例值:rocketmq-cnai1f0c29ca****​
需要更新配置的实例 ID。​
​
ComputeSpec string 可选 示例值:rocketmq.n1.x2.tiny​
实例变更后的计算规格。如需升级计算规格,此参数必选。​
仅支持升级实例规格,不支持降级。​
​
StorageSpace integer 可选 示例值:300​
实例变更后的存储空间。如需扩容存储空间,此参数必选。​
单位为GiB,必须指定为 100 的倍数。取值范围取决于当前指定的计算规格,详细说明请参考产品规格。​
仅支持升级实例规格,不支持降级。​
​
AutoScaleQueue boolean 可选 示例值:false​
实例规格更改时,是否自动创建队列。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
OrderId string 示例值:order-712089661643355****​
订单 ID。​
​
​
​
请求示例​
​
POST /?Action=ModifyInstanceSpec&Version=2023-01-01 HTTP/1.1​
Host: rocketmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260108T102057Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260108/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"InstanceId": "rocketmq-cnai1f0c29ca****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20260108182102133175005238DE****",​
"Action": "ModifyInstanceSpec",​
"Version": "2023-01-01",​
"Service": "RocketMQ",​
"Region": "cn-beijing"​
},​
"Result": {​
"OrderId": "order-712089661643355****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
200​
OK​
OK​
成功。​
400​
NotModifiedParameter​
The resource was not changed.​
未变更任何配置。​
400​
InvalidParameter​
The specified parameter %s is not valid.​
参数值%s无效,请检查后重试。​
400​
MissingParameter​
The request body is missing a required parameter %s.​
缺少%s参数。​
400​
OperationDenied_InvalidRequest​
The request that you specified is not valid.​
请求异常,请检查后重试。​
400​
UnsupportedParameter​
The specified parameter %s is unsupported.​
不支持%s参数。​
400​
QuotaExceeded_GroupNumber​
The number of group exceeds the limit.​
Group 数量超出上限。​
400​
QuotaExceeded_TopicNumber​
The number of topic exceeds the limit.​
Topic 数量超出上限。​
400​
QuotaExceeded_AuthKeyNumber​
The number of authKeys exceeds the limit.​
密钥数量超出上限。​
400​
QuotaExceeded_InstanceNumber​
The number of instances exceeds the limit.​
实例数量超出上限。​
400​
InvalidGroupId_AlreadyExists​
The specified group name already exists.​
Group 名称已存在。​
400​
InvalidTopicName_AlreadyExists​
The specified topic name already exists.​
Topic 名称已存在。​
400​
QuotaExceeded_QueueNumber​
The number of queue exceeds the limit.​
队列数量超出上限。​
400​
QuotaExceeded.QueueNumber​
The number of queue exceeds the limit.​
队列数量超出上限。​
400​
QuotaExceeded.TopicNumber​
The number of topic exceeds the limit.​
Topic 数量超出上限。​
400​
QuotaExceeded.GroupNumber​
The number of group exceeds the limit.​
Group 数量超出上限。​
400​
OperationDenied.InvalidRequest​
The request that you specified is not valid.​
请求异常,请检查后重试。​
400​
QuotaExceeded.InnerPLB​
The number of inner plb exceeds the limit.​
InnerPLB 数量超出上限。​
400​
QuotaExceeded​
Quota Limited.​
资源超配额 quota。​
400​
InvalidPara​
The specified parameter is not valid.​
参数值无效。​
403​
OperationDenied_AccountNotAuthorized​
You are not authorized to perform this operation.​
您不具备相关权限,请授权或切换账号后重试。​
403​
OperationDenied_InternetAccessEnabled​
Internet access is enabled for the instance.​
该实例已开启公网访问方式。​
403​
OperationDenied_InternetAccessDisabled​
Internet access is disabled for the instance.​
该实例未开启公网访问方式。​
403​
OperationDenied_InvalidInstanceStatus​
The operation is not valid for the current status of the instance.​
当前实例状态不允许执行该操作。​
403​
OperationDenied_InstanceNotEmpty​
The instance that you tried to delete is not empty.​
期望删除的实例资源不为空。​
403​
OperationDenied_ResourceOccupied​
The resource is busy now, please try again later.​
资源繁忙,可能由于指定资源正在被访问或回收。​
403​
OperationDenied_TaskIsRunning​
An operation is currently in progress. Try again later.​
后台任务正在运行中,请稍后再试。​
403​
OperationDenied_VersionUnsupported​
The current instance version does not support this operation.Please upgrade the instance and try again.​
当前实例版本不支持指定操作,请升级实例后再试。​
403​
OperationDenied.VersionUnsupported​
The current instance version does not support this operation.Please upgrade the instance and try again.​
当前实例版本不支持指定操作,请升级实例后再试。​
403​
OperationDenied.TaskIsRunning​
An operation is currently in progress. Try again later.​
后台任务正在运行中,请稍后再试。​
403​
OperationDenied.InvalidInstanceStatus​
The operation is not valid for the current status of the instance.​
当前实例状态不允许执行该操作。​
403​
OperationDenied.ResourceOccupied​
The resource is busy now, please try again later.​
资源繁忙,可能由于指定资源正在被访问或回收。​
403​
OperationDenied.AccountNotAuthorized​
You are not authorized to perform this operation.​
您不具备相关权限,请授权或切换账号后重试。​
404​
InvalidInstanceId_NotFound​
The specified Instance ID does not exist.​
实例不存在。​
404​
InvalidTopicName_NotFound​
The specified topic does not exist.​
Topic 不存在。​
404​
InvalidGroup_NotFound​
The specified group does not exist.​
Group 不存在。​
404​
InvalidAccessKeyId_NotFound​
The specified accessKey does not exist.​
AccessKey 不存在。​
404​
InvalidMessageId_NotFound​
The message ID does not exist in the instance %s.​
Message ID 不存在。​
404​
InvalidEip_NotFound​
The specified EIP does not exist.​
EIP 不存在。​
404​
InvalidInstanceId.NotFound​
The specified Instance ID does not exist.​
实例不存在。​
500​
InternalError​
The request failed due to some unknown error, exception or failure.​
内部错误,请稍后再试。​
500​
ResourceIsBusy​
The resource is busy now, please try again later.​
资源繁忙,可能由于指定资源正在被访问或回收。​
500​
ServerInternalError​
The request failed due to some unknown error, exception or failure.​
服务内部错误。​
503​
ServiceUnavailable​
The request failed due to a temporary failure of the server.​
当前服务暂时不可用。​
​
​
最近更新时间:2026.02.13 18:31:52
这个页面对您有帮助吗?
有用
有用
无用
无用