Help Center/ Cloud Operations Center/ API Reference/ API/ Job Management/ Obtaining Job Atomic Capability Details

Updated on 2025-12-02 GMT+08:00

View PDF

Obtaining Job Atomic Capability Details

Function

This API is used to obtain atomic capability details.

URI

GET /v1/atomics/{atomic_unique_key}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
atomic_unique_key	Yes	String	Definition: Key of an atomic capability. Constraints: N/A Value range: coc_step_pause: paused coc_step_loop: loop coc_step_branch: branch execute_api: Executes an API. coc_step_sleep: sleep custom_script_execute: Execute a custom script. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: For details, see Error Codes.
error_msg	String	Definition: Error message. Value range: For details, see Error Codes.
data	data object	Returned data

**Table 3** data
Parameter	Type	Description
atomic_unique_key	String	Definition: Unique ID of an atomic capability. Value range: The value can contain only letters and underscores (_) and must start with a letter.
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: N/A
inputs	Array of AtomicInputModel objects	Definition: Input parameter of an atomic capability. Value range: N/A
outputs	AtomicOutputModel object	Definition: Output parameter of an atomic capability. Value range: N/A

**Table 4** AtomicInputModel
Parameter	Type	Description
param_key	String	Definition: Parameter variable name, which is referenced in the atomic capability during execution. Value range: N/A.
param_name_zh	String	Definition: Chinese name of a parameter, which is displayed in a drop-down list. Value range: N/A.
param_name_en	String	Definition: English name of a parameter, which is displayed in a drop-down list. Value range: N/A.
required	Boolean	Definition: Mandatory or not. Value range: N/A.
param_type	String	Definition: Parameter type. The options are constant and dictionary. Value range: CONSTANT: constant COMPLEX: dictionary
min	Integer	Definition: Minimum value. Value range: N/A.
max	Integer	Definition: Maximum value. Value range: N/A.
min_len	Integer	Definition: Minimum length. Value range: N/A.
max_len	Integer	Definition: Maximum length. Value range: N/A.
pattern	String	Definition: Regular expression. Value range: N/A.

**Table 5** AtomicOutputModel
Parameter	Type	Description
supported	Boolean	Definition: Whether the output is supported. Value range: N/A.
type	String	Definition: Output type. Value range: CUSTOM: user-defined

Example Requests

Obtain details about a specified atomic capability.

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

Example Responses

Status code: 200

Request succeeded.

{
  "data" : {
    "atomic_unique_key" : "custom_script_execute",
    "atomic_name_zh" : "Execute a custom script.",
    "atomic_name_en" : "Execute script",
    "tags" : [ "CUSTOM" ],
    "inputs" : [ {
      "param_key" : "wait_uniagent_time",
      "param_type" : "CONSTANT",
      "param_name_zh" : "Maximum waiting time for UniAgent startup (s)",
      "param_name_en" : "Maximum Waiting Time for UniAgent Startup (second)",
      "required" : false,
      "max" : 1200,
      "min" : 0,
      "max_len" : null,
      "min_len" : null,
      "pattern" : null
    }, {
      "param_key" : "script_uuid",
      "param_type" : "CONSTANT",
      "param_name_zh" : "Script UUID",
      "param_name_en" : "Script uuid",
      "required" : true,
      "max" : null,
      "min" : null,
      "max_len" : null,
      "min_len" : null,
      "pattern" : null
    }, {
      "param_key" : "execute_user",
      "param_type" : "CONSTANT",
      "param_name_zh" : "Script execution user",
      "param_name_en" : "Script execute os user",
      "required" : true,
      "max" : null,
      "min" : null,
      "max_len" : 32,
      "min_len" : null,
      "pattern" : null
    }, {
      "param_key" : "timeout",
      "param_type" : "CONSTANT",
      "param_name_zh" : "Script execution timeout (s)",
      "param_name_en" : "Script execute timeout (second)",
      "required" : true,
      "max" : 1800,
      "min" : 6,
      "max_len" : null,
      "min_len" : null,
      "pattern" : null
    }, {
      "param_key" : "success_rate",
      "param_type" : "CONSTANT",
      "param_name_zh" : "Success rate threshold (%)",
      "param_name_en" : "Success rate (%)",
      "required" : false,
      "max" : 100,
      "min" : 0,
      "max_len" : null,
      "min_len" : null,
      "pattern" : null
    }, {
      "param_key" : "script_params",
      "param_type" : "DICTIONARY",
      "param_name_zh" : "Script input parameters",
      "param_name_en" : "Script execute inputs",
      "required" : false,
      "max" : null,
      "min" : null,
      "max_len" : null,
      "min_len" : null,
      "pattern" : null
    } ],
    "outputs" : {
      "supported" : false,
      "type" : null
    }
  }
}