获取原子能力列表 - ListDocumentAtomics
功能介绍
获取作业原子能力列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
coc:documentAtomic:list
List
-
-
-
-
URI
GET /v1/atomics
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
String |
参数解释: 分页参数。 约束限制: 每页返回记录个数限制,不传默认第一页查10个。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
offset |
否 |
String |
参数解释: 分页参数。 约束限制: 从offset指定的下一条数据开始查询,不传默认0。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of AtomicModel objects |
参数解释: 原子能力列表。 取值范围: 不涉及。 |
|
total |
Long |
参数解释: 总条数。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
atomic_unique_key |
String |
参数解释: 原子能力唯一标识。 取值范围:
|
|
atomic_name_zh |
String |
参数解释: 中文名。 取值范围: 不涉及。 |
|
atomic_name_en |
String |
参数解释: 英文名。 取值范围: 不涉及。 |
|
tags |
Array of strings |
参数解释: 标签信息。 取值范围:
|
请求示例
获取原子能力列表。
GET https://{Endpoint}/v1/atomics
响应示例
状态码:200
请求成功。
{
"data" : [ {
"atomic_unique_key" : "coc_step_pause",
"atomic_name_zh" : "暂停",
"atomic_name_en" : "pause",
"tags" : [ "CONTROL" ]
}, {
"atomic_unique_key" : "coc_step_review",
"atomic_name_zh" : "审批",
"atomic_name_en" : "review",
"tags" : [ "CONTROL" ]
}, {
"atomic_unique_key" : "coc_step_loop",
"atomic_name_zh" : "循环",
"atomic_name_en" : "loop",
"tags" : [ "CONTROL" ]
}, {
"atomic_unique_key" : "coc_step_branch",
"atomic_name_zh" : "分支",
"atomic_name_en" : "branch",
"tags" : [ "CONTROL" ]
}, {
"atomic_unique_key" : "execute_api",
"atomic_name_zh" : "执行API",
"atomic_name_en" : "Execute API",
"tags" : [ "CLOUD_API" ]
}, {
"atomic_unique_key" : "coc_step_sleep",
"atomic_name_zh" : "睡眠",
"atomic_name_en" : "sleep",
"tags" : [ "CONTROL" ]
}, {
"atomic_unique_key" : "custom_script_execute",
"atomic_name_zh" : "自定义脚本执行",
"atomic_name_en" : "Execute script",
"tags" : [ "CUSTOM" ]
}, {
"atomic_unique_key" : "coc_execute_command",
"atomic_name_zh" : "执行命令",
"atomic_name_en" : "Execute Command",
"tags" : [ "CUSTOM" ]
} ],
"total" : 8
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
错误码
请参见错误码。