实例升级 - UpgradeInstance
功能介绍
实例内核升级。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v2/{project_id}/kafka/instances/{instance_id}/upgrade
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_schedule |
否 |
Boolean |
是否作为定时任务执行。若非定时执行,is_schedule和execute_at字段可为空。若为定时执行,is_schedule为true,execute_at字段非空。 |
|
execute_at |
否 |
Long |
定时时间,格式为Unix时间戳,单位为毫秒 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
提交升级任务id |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
升级id为instance_id的实例。
POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/upgrade
{
"is_schedule" : true,
"execute_at" : 1695796358970
}
响应示例
状态码:200
升级成功。
93b94287-728d-4bb1-a158-cb66cb0854e7
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
升级成功。 |
|
400 |
升级失败。 |
错误码
请参见错误码。