# 根据组件ID下发组件任务 - DeliverComponentTaskBasedOnTheComponentID #### 功能介绍 此API用于通过组件ID下发组件任务。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ServiceStage/doc?api=UpdateComponentAction&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-servicestage/servicestage_06_0183.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | servicestage:app:modifyComponent | write | app \* | - [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) - [g:ResourceTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) | servicestage:app:modify | - aom:discoveryRule:list - aom:discoveryRule:set - as:scalingConfig:create - as:scalingConfig:delete - as:scalingConfig:get - as:scalingConfig:list - as:scalingPolicy:get - as:scalingPolicy:list - as:scalingPolicy:update - cce:cluster:get - dcs:instance:get - dns:recordset:create - dns:recordset:delete - dns:recordset:get - ecs:cloudServers:get - elb:l7policies:get - elb:l7policies:list - elb:l7policies:update - elb:listeners:get - elb:listeners:list - elb:listeners:update - elb:members:get - elb:members:list - elb:members:update - rds:instance:get - vpc:addressGroups:get - vpc:networks:get - vpc:routeTables:get - vpc:securityGroupRules:get - vpc:securityGroups:get - vpc:subnets:get - vpc:subnets:get - vpc:vpcs:get | #### URI POST /v3/{project_id}/cas/applications/{application_id}/components/{component_id}/action 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户项目ID。获取方法，请参考[获取项目ID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0164.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | application_id | 是 | String | **参数解释：** 应用ID。获取方法，请参考[获取所有应用 - ObtainAllApplications](https://support.huaweicloud.com/api-servicestage/servicestage_06_0068.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | component_id | 是 | String | **参数解释：** 组件ID。获取方法，请参考[获取应用所有组件 - ObtainAllComponentsOfAnApplication](https://support.huaweicloud.com/api-servicestage/servicestage_06_0077.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求消息 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及 **取值范围：** application/json;charset=utf8 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考[认证鉴权](https://support.huaweicloud.com/api-servicestage/servicestage_06_0010.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | action | 是 | String | **参数解释：** 组件任务类型。 **取值范围：** - start：启动。 - stop：停止。 - restart：重启。 - scale：伸缩。 - rollback：回滚。 - rollback_current：回滚到上一个版本。 - continue_deploy：继续部署。 - check_gray_release：检查灰度规则。 - modify_gray_rule：修改灰度规则。 - sync_workload：同步工作负载。 - sync_import：比较工作负载导入前后的工作负载信息。 - abort_job：中断组件部署、升级任务。 - redeployment：重新部署。 **默认取值：** 不涉及 | | parameters | 否 | Object | **参数解释：** 任务参数，请参考[表4]。 | 表4parameters | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | replica | 否 | Integer | **参数解释：** 组件实例数量。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | version | 否 | String | **参数解释：** 版本号。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | hosts | 否 | Array of strings | **参数解释：** hostID列表，当虚机部署组件伸缩时必选。 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应消息 表5响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释：** 任务ID。 **取值范围：** 不涉及 | | component_id | String | **参数解释：** 组件ID。 **取值范围：** 不涉及 | #### 请求示例 启动组件。 ``` { "action": "start", "parameters": { "replica": 0, "hosts": [ "string" ], "version": "string" } } ``` #### 响应示例 ``` { "job_id": "JOBa6346016-b97d-4311-9e4c-9a40bd39ead8", "component_id": "29e7ea25-ce11-4cf9-9a04-3226fb26d60e" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功 | | 400 | 错误的请求 | | 404 | 请求对象不存在 | | 500 | 内部错误 | #### 错误码 请参考[ServiceStage错误码](https://support.huaweicloud.com/api-servicestage/servicestage_06_0162.html)。