启动升级前的准备。升级前需要做一轮评估，评估通过，则可以升级，否则需要联系人工升级。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v1/instances/{instanceId}/upgrade/prepare HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| instanceId |
string |
否 |
实例 id。 |
hgpostcn-cn-nwy3e6yxxx |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 id。 |
cn-shenzhen |
| body |
object |
否 |
请求体。 |
|
| version |
string |
否 |
目标版本。建议先调用 ListUpgradeReleaseVersion 查看可以升级到哪些版本。 |
r5.0.0 |
| dryRun |
boolean |
否 |
废弃参数 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
77B97AFB-7C9D-50FF-A72D-F13FD73E49D8 |
| Data |
object |
返回参数。 |
|
| Success |
boolean |
启动升级准备任务是否成功 |
true |
| FailReason |
string |
升级失败原因。 |
null |
| ReasonKey |
string |
升级目标 key。 |
null |
| Success |
boolean |
请求结果，与业务无关。 |
true |
| ErrorCode |
string |
错误码。 |
null |
| ErrorMessage |
string |
错误信息。 |
null |
| HttpStatusCode |
string |
http 状态码。 |
200 |
示例
正常返回示例
JSON格式
{
"RequestId": "77B97AFB-7C9D-50FF-A72D-F13FD73E49D8",
"Data": {
"Success": true,
"FailReason": "null\n",
"ReasonKey": "null"
},
"Success": true,
"ErrorCode": "null",
"ErrorMessage": "null",
"HttpStatusCode": "200"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。