文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 组件/ 根据组件ID下发组件任务
更新时间：2024-12-16 GMT+08:00
查看PDF
分享

根据组件ID下发组件任务

功能介绍

此API用于通过组件ID下发组件任务。

URI

POST /v3/{project_id}/cas/applications/{application_id}/components/{component_id}/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

application_id

是

String

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

component_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，回滚。
  • continue_deploy，继续部署。
  • check_gray_release，检查灰度规则。
  • modify_gray_rule，修改灰度规则。

parameters

否

Object

任务参数，请参考表4。
表4 parameters

参数

是否必选

参数类型

描述

replica

否

Integer

组件实例数量。

version

否

String

版本号。

hosts

否

Array of String

hostID列表，当虚机部署组件伸缩时必选。

响应消息

表5 响应参数

参数

参数类型

描述

job_id

String

任务ID。

result

String

任务状态。

请求示例

启动组件。

{
  "action": "start",
  "parameters": {
    "replica": 0,
    "hosts": [
      "string"
    ],
    "version": "string"
  }
}

响应示例

{
  "job_id": "string",
  "result": "succeeded"
}

状态码

状态码

描述

200

操作成功

400

错误的请求

404

请求对象不存在

500

内部错误

错误码

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

父主题： 组件