根据组件ID下发组件任务 - DeliverComponentTaskBasedOnTheComponentID
功能介绍
此API用于通过组件ID下发组件任务。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
servicestage:app:modifyComponent
write
app *
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
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 租户项目ID。获取方法,请参考获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
application_id | 是 | String | 参数解释: 应用ID。获取方法,请参考获取所有应用 - ObtainAllApplications。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
component_id | 是 | String | 参数解释: 组件ID。获取方法,请参考获取应用所有组件 - ObtainAllComponentsOfAnApplication。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求消息
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 参数解释: 消息体的类型(格式)。 约束限制: 不涉及 取值范围: application/json;charset=utf8 默认取值: 不涉及 |
X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
action | 是 | String | 参数解释: 组件任务类型。 取值范围:
默认取值: 不涉及 |
parameters | 否 | Object | 参数解释: 任务参数,请参考表4。 |
响应消息
参数 | 参数类型 | 描述 |
|---|---|---|
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错误码。

