Obtaining the Atomic Capabilities

Function

This API is used to obtain the atomic capability list of a job.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
coc:documentAtomic:list	List	-	-	-	-

URI

GET /v1/atomics

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	String	Definition: Pagination parameter. Constraints: Maximum number of records returned on each page. If this parameter is not set, 10 records are queried on the first page by default. Value range: N/A. Default value: N/A.
offset	No	String	Definition: Pagination parameter. Constraints: The query starts from the next data specified by offset. If this parameter is not transferred, the preset value 0 is used. Value range: N/A. Default value: N/A.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
data	Array of AtomicModel objects	Definition: Atomic capabilities. Value range: N/A.
total	Long	Definition: Total number of records. Value range: N/A.

**Table 3** AtomicModel
Parameter	Type	Description
atomic_unique_key	String	Definition: Unique ID of an atomic capability. Value range: N/A.
atomic_name_zh	String	Definition: Chinese name. Value range: N/A.
atomic_name_en	String	Definition: English name. Value range: N/A.
tags	Array of strings	Definition: Tag information. Value range: CLOUD_API and FUNCTION.

Example Requests

Obtain the atomic capability list.

GET https://{Endpoint}/v1/atomics

Example Responses

Status code: 200

Request succeeded.

{
  "data" : [ {
    "atomic_unique_key" : "coc_step_pause",
    "atomic_name_zh" : "Pause",
    "atomic_name_en" : "pause",
    "tags" : [ "CONTROL" ]
  }, {
    "atomic_unique_key" : "coc_step_review",
    "atomic_name_zh" : "Review",
    "atomic_name_en" : "review",
    "tags" : [ "CONTROL" ]
  }, {
    "atomic_unique_key" : "coc_step_loop",
    "atomic_name_zh" : "Loop",
    "atomic_name_en" : "loop",
    "tags" : [ "CONTROL" ]
  }, {
    "atomic_unique_key" : "coc_step_branch",
    "atomic_name_zh" : "Branch",
    "atomic_name_en" : "branch",
    "tags" : [ "CONTROL" ]
  }, {
    "atomic_unique_key" : "execute_api",
    "atomic_name_zh" : "Execute API",
    "atomic_name_en" : "Execute API",
    "tags" : [ "CLOUD_API" ]
  }, {
    "atomic_unique_key" : "coc_step_sleep",
    "atomic_name_zh" : "Sleep",
    "atomic_name_en" : "sleep",
    "tags" : [ "CONTROL" ]
  }, {
    "atomic_unique_key" : "custom_script_execute",
    "atomic_name_zh" : "Execute a custom script.",
    "atomic_name_en" : "Execute script",
    "tags" : [ "CUSTOM" ]
  }, {
    "atomic_unique_key" : "coc_execute_command",
    "atomic_name_zh" : "Execute a command.",
    "atomic_name_en" : "Execute Command",
    "tags" : [ "CUSTOM" ]
  } ],
  "total" : 8
}