更新时间:2025-07-04 GMT+08:00
分享

获取原子能力详细

功能介绍

获取原子能力详细。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/atomics/{atomic_unique_key}

表1 路径参数

参数

是否必选

参数类型

描述

atomic_unique_key

String

参数解释:

原子能力的key。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

atomic_unique_key

String

参数解释:

原子能力唯一标识。

取值范围:

只允许字母+下划线,字母开头。

atomic_name_zh

String

参数解释:

中文名。

取值范围:

不涉及。

atomic_name_en

String

参数解释:

英文名。

取值范围:

不涉及。

tags

Array of strings

参数解释:

标签信息。

取值范围:

不涉及。

inputs

Array of AtomicInputModel objects

参数解释:

原子能力入参。

取值范围:

不涉及。

outputs

AtomicOutputModel object

参数解释:

原子能力出参。

取值范围:

不涉及。

表3 AtomicInputModel

参数

参数类型

描述

param_key

String

参数解释:

参数变量名,执行时原子能力内引用。

取值范围:

不涉及。

param_name_zh

String

参数解释:

参数中文名,下拉展示时使用。

取值范围:

不涉及。

param_name_en

String

参数解释:

参数英文名,下拉展示时使用。

取值范围:

不涉及。

required

Boolean

参数解释:

是否必填。

取值范围:

不涉及。

param_type

String

参数解释:

参数类型:常量/字典。

取值范围:

不涉及。

min

Integer

参数解释:

最小值。

取值范围:

不涉及。

max

Integer

参数解释:

最大值。

取值范围:

不涉及。

min_len

Integer

参数解释:

长度最小值。

取值范围:

不涉及。

max_len

Integer

参数解释:

长度最大值。

取值范围:

不涉及。

pattern

String

参数解释:

正则限制表达式。

取值范围:

不涉及。

表4 AtomicOutputModel

参数

参数类型

描述

supported

Boolean

参数解释:

是否支持输出。

取值范围:

不涉及。

type

String

参数解释:

输出类型。

取值范围:

不涉及。

请求示例

获取指定原子能力详细。

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

响应示例

状态码:200

请求成功。

{
  "data" : {
    "atomic_unique_key" : "custom_script_execute",
    "atomic_name_zh" : "自定义脚本执行",
    "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" : "最大等待Uniagent启动时间(秒)",
      "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" : "脚本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" : "脚本执行用户",
      "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" : "脚本执行超时时长(秒)",
      "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" : "成功率阈值(%)",
      "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" : "脚本入参",
      "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
    }
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码

相关文档