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

Updated on 2025-10-24 GMT+08:00

View PDF

Obtaining Job Atomic Capability Details

Function

This API is used to obtain atomic capability details.

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:get	Read	-	-	-	-

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: N/A. Default value: N/A.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
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 3** 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: N/A.
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 4** AtomicOutputModel
Parameter	Type	Description
supported	Boolean	Definition: Whether the output is supported. Value range: N/A.
type	String	Definition: Output type. Value range: N/A.

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",
      "default_value" : "0",
      "param_enums" : null,
      "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,
      "type" : "integer"
    }, {
      "param_key" : "script_uuid",
      "param_type" : "CONSTANT",
      "default_value" : null,
      "param_enums" : null,
      "param_name_zh" : "Script UUID",
      "param_name_en" : "Script uuid",
      "required" : true,
      "max" : null,
      "min" : null,
      "max_len" : null,
      "min_len" : null,
      "pattern" : null,
      "type" : null
    }, {
      "param_key" : "execute_user",
      "param_type" : "CONSTANT",
      "default_value" : null,
      "param_enums" : null,
      "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,
      "type" : "string"
    }, {
      "param_key" : "timeout",
      "param_type" : "CONSTANT",
      "default_value" : "60",
      "param_enums" : null,
      "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,
      "type" : "integer"
    }, {
      "param_key" : "success_rate",
      "param_type" : "CONSTANT",
      "default_value" : "100",
      "param_enums" : null,
      "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,
      "type" : "integer"
    }, {
      "param_key" : "script_params",
      "param_type" : "DICTIONARY",
      "default_value" : null,
      "param_enums" : null,
      "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,
      "type" : null
    } ],
    "target_instance" : {
      "required" : true,
      "limit" : null
    },
    "display_region" : "REQUIRED",
    "outputs" : {
      "supported" : false,
      "type" : null
    }
  }
}