文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 历史API/ 应用管理（v2版本）/ 实例/ 对组件实例的操作
更新时间：2024-10-11 GMT+08:00
查看PDF
分享

对组件实例的操作

功能介绍

通过此API操作组件实例。

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances/{instance_id}/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID。获取方法，请参考获取项目ID。

application_id

是

String

应用ID。获取方法，请参考获取所有应用。

component_id

是

String

组件ID。获取方法，请参考获取应用所有组件。

instance_id

是

String

组件实例ID。获取方法，请参考获取组件实例。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

操作，支持start、stop、restart、scale、rollback。

  • start：启动组件实例。
  • stop：停止组件实例。
  • restart：重启组件实例。
  • scale：伸缩组件实例。
  • rollback：回滚组件实例到上个版本。

parameters

否

Object

操作参数，action为scale和rollback时必选，请参考表4。
表4 parameters

参数

是否必选

参数类型

描述

replica

否

Integer

实例数，在scale操作时必选。

hosts

否

Array

ECS id列表，指定虚机伸缩的时候部署的ECS主机，在scale操作时必选。

version

否

String

版本号，在rollback操作时必选，通过获取组件实例快照获取。

响应消息

表5 响应参数

参数

参数类型

描述

job_id

String

Job ID。

请求示例

伸缩组件实例，修改组件实例数到4个。

{
  "action": "scale",
  "parameters": {
    "replica": 4
  }
}

响应示例

{
    "job_id": "JOB66761060-f209-407c-a093-4df6f531b9dc"
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

错误码格式为：SVCSTG.00100.[Error_ID]，例如：SVCSTG.00100400。错误码说明请参考ServiceStage错误码。

父主题： 实例

相关文档