变更实例规格
功能介绍
变更实例的规格。
![](https://support.huaweicloud.com/api-nosql/public_sys-resources/note_3.0-zh-cn.png)
调整实例规格时,服务会有5~10分钟的业务中断重启,请谨慎操作。
接口约束
该接口支持如下数据库实例:
- GeminiDB Cassandra
- GeminiDB Redis
该接口既支持包周期实例,也支持按需实例。
该接口既支持扩大规格,也支持降低规格。
需要变更的规格不能与原规格一样。
实例状态仅为“normal”时,可以变更实例规格。
如果变更结果无法满足实例运行所需要的大小,将无法进行规格变更。
该接口支持GeminiDB Redis搭建双活关系的主实例和备实例。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/resize
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一region下的project ID。获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
resize |
是 |
ResizeInstanceOption object |
目标规格信息。 |
is_auto_pay |
否 |
String |
创建包周期实例时可指定,表示是否自动从账户中支付,此字段不影响自动续订的支付方式。
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
target_spec_code |
是 |
String |
变更至新规格的资源规格编码。 获取方法请参见查询数据库规格中响应参数“flavors.spec_code”的值。 |
响应参数
状态码: 202
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
任务ID,仅按需实例时会返回该参数。 |
order_id |
String |
订单ID,仅创建包年/包月实例时返回该参数。 |
请求示例
- URI样例
PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize
- 变更实例规格,实例目标规格为16U64G
{ "resize" : { "target_spec_code" : "geminidb.cassandra.4xlarge.4" } }
响应示例
状态码: 202
Accepted
按需实例响应样例:
{ "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5" }
包周期实例响应样例:
{ "order_id" : "CS20070721568OVO9" }
状态码
请参见状态码。
错误码
请参见错误码。