根据组件ID批量下发组件任务 - DeliverComponentTaskInBatches
功能介绍
此API用于通过组件ID批量下发组件任务。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
servicestage:app:modifyComponent
write
app
servicestage:app:modify
-
URI
POST /v3/{project_id}/cas/components/action
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目ID。获取方法,请参考获取项目ID。 |
请求消息
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
消息体的类型(格式),默认取值为“application/json;charset=utf8”。 |
|
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
action |
是 |
String |
请求执行动作。
|
|
components |
否 |
List<Object> |
组件相关信息。请参考表6。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
组件ID。 |
|
application_id |
是 |
String |
应用ID。 |
响应消息
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
laneId |
String |
泳道ID。 |
|
job_id |
String |
异步任务ID。 |
|
components |
List<Object> |
组件信息,请参考表4 组件信息参数。 |
请求示例
{
"action": "sync_workload",
"components": [
{
"id": "b458a122-f21f-4e45-9815-eb0651849be3",
"application_id": "84ce8cda-561b-423d-a921-aa79a246ba07"
}
]
}
响应示例
{
"laneId": null,
"components": null,
"job_id": "JOB74c8c7d7-f045-41d0-ad7a-7d4274d044e2"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
操作成功 |
|
400 |
错误的请求 |
|
404 |
请求对象不存在 |
|
500 |
内部错误 |
错误码
请参考ServiceStage错误码。