更新时间:2024-10-16 GMT+08:00

根据插件ID下发插件任务

功能介绍

此API用于根据插件ID下发插件任务。

URI

POST /v3/{project_id}/cas/environments/{environment_id}/addons/{addon_id}/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

environment_id

String

环境ID。获取方法,请参考获取所有环境

addon_id

String

插件ID。获取方法,请参考查询插件列表

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式),默认取值为“application/json;charset=utf8”。

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

插件任务类型。

  • restart:重新启动。
  • redeploy:重新部署。

响应消息

表4 响应参数

参数

参数类型

描述

job_id

String

任务ID。

请求示例

下发重新部署插件任务。

{
    "action": "redeploy"
}

响应示例

{
    "job_id": "JOB7e9317bb-a63a-46f4-a026-244de2f6eac3"
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在

500

内部错误

错误码

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