文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 批量数据库补丁升级
更新时间：2024-10-28 GMT+08:00
查看PDF
分享

批量数据库补丁升级

功能介绍

批量升级数据库补丁版本。

接口约束

  • 该接口支持如下数据库实例：
    • GeminiDB Cassandra
    • GeminiDB Influx
    • GeminiDB Redis
  • 只支持即时升级，请选择在业务低峰期进行升级。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST https://{Endpoint}/v3/{project_id}/instances/db-upgrade

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

instance_ids

是

Array of strings

指定需要升级数据库补丁版本的实例ID列表。一次最多可传入10个实例ID，且为同一引擎的实例。

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

upgrade_results

Array of UpgradeResult objects

批量升级结果。
表5 UpgradeResult

参数

参数类型

描述

job_id

String

任务ID。仅当补丁版本升级任务提交成功时返回该字段。

instance_id

String

实例ID。

error_code

String

错误码。仅当补丁版本升级任务提交失败时返回该字段。

error_message

String

失败原因。仅当补丁版本升级任务提交失败时返回该字段。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

URI样例 
POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/db-upgrade

请求示例

批量升级数据库补丁版本： 
{ 
   "instance_ids" : [ "046287aae57843b1a7bc61b7a8812f41in13", "3d1e04f49efa473a8c7eaf07ed7ff870in13" ] 
 }

响应示例

状态码： 202

Accepted

{ 
  "upgrade_results" : [ { 
    "instance_id" : "046287aae57843b1a7bc61b7a8812f41in13", 
    "job_id" : "e4616470-733d-41de-a9b0-a260709293d3" 
  }, { 
    "instance_id" : "3d1e04f49efa473a8c7eaf07ed7ff870in13", 
    "error_code" : "DBS.200011", 
    "error_message" : "The status of DB instance does not allow the operation." 
  } ] 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档