ModifyInstanceSpec - 变更实例规格--消息队列 RabbitMQ版-火山引擎

文档中心

导航

ModifyInstanceSpec - 变更实例规格

最近更新时间：2024.11.18 10:21:06首次发布时间：2023.05.19 15:47:10

调用 ModifyInstanceSpec 接口修改实例的计算规格、存储规格等产品规格。

使用说明

随着业务规模增长，如果实例规格不再满足需求，您可以适当升高实例的规格配置。此接口用于变更 RabbitMQ 实例的规格，包括计算规格、存储空间等配置。

说明

API Explorer

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

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

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyInstanceSpec	要执行的操作，取值：ModifyInstanceSpec。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
ClientToken	String	否	123e4567-e89b-12d3-a456-426655440000	保证客户端请求幂等性的标识。该标识为 1~64 位的 ASCII 字符串，大小写敏感，由客户端生成，应确保不同请求之间该标识具有唯一性。如何使用幂等标识，请参考请求幂等性。
InstanceId	String	是	rbtmq-5b293870****	实例 ID。
ComputeSpec	String	否	rabbitmq.n3.x2.medium	实例变更后的计算规格。仅支持升级实例规格，不支持降级。消息队列 RabbitMQ 版实例提供的计算规格清单，请参考产品规格。
StorageSpace	Integer	否	300	实例变更后的存储空间。单位为 GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格，您可以通过 DescribeComputeSpecsInfo 接口查看指定计算规格支持的存储空间范围和默认存储空间大小。说明仅支持升级实例规格，不支持降级。您可以通过 DescribeComputeSpecsInfo 查询指定实例规格对应的存储空间范围。升配时通常需要同时升级存储空间，存储空间升级后的最小容量为原单节点容量/原节点数*新节点数，例如原规格为n3，即 3 节点，存储空间为 300GiB，更配到 n5（5 节点）时至少就需要 500GiB。

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

参数	类型	示例值	描述
OrderId	String	order-712089661643355****	订单ID。

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

状态码	错误码	错误信息	说明
400	UnSupportedConfig	Unsupported instance configuration, please check.	配置不符合规范。
400	NotModifiedParameter	The resource was not changed.	未变更任何配置。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效。
400	InsufficientBalance	Insufficient account balance.	余额不足。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。
500	InsufficientResource	Insufficient resources, please switch to another available zone or region and try again.	资源不足，请稍后重试。