对组件实例的操作
功能介绍
通过此API操作组件实例。
URI
POST /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances/{instance_id}/action
参数 |
参数类型 |
必选 |
描述 |
---|---|---|---|
project_id |
String |
是 |
租户项目ID |
application_id |
String |
是 |
应用ID |
component_id |
String |
是 |
组件ID |
instance_id |
String |
是 |
组件实例ID |
请求消息
参数 |
参数类型 |
必选 |
描述 |
---|---|---|---|
action |
String |
是 |
操作,支持start、stop、restart、scale、rollback。 |
parameters |
Object |
否 |
操作参数,action为scale和rollback时必选,请参考表3。 |
参数 |
参数类型 |
必选 |
描述 |
---|---|---|---|
replica |
Integer |
否 |
实例数,在scale操作时必选。 |
hosts |
Array |
否 |
ECS id列表,指定虚机伸缩的时候部署的ECS主机,在scale操作时必选。 |
version |
String |
否 |
版本号,在rollback操作时必选,通过获取组件实例快照获取。 |
响应消息
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
Job ID。 |
示例
请求示例
{ "action": "scale", "parameters": { "replica": 4 } }
响应示例
{ "job_id": "JOB66761060-f209-407c-a093-4df6f531b9dc" }
状态码
状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
错误的请求。 |
404 |
请求对象不存在。 |
500 |
内部错误。 |
错误码
错误码格式为:SVCSTG.00100.[Error_ID],例如:SVCSTG.00100400。错误码说明请参考应用管理API错误码。