更新时间:2026-04-30 GMT+08:00
分享

创建算法-CreateAlgorithm

功能介绍

创建算法。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    octopus:simAlgorithm:create

    Write

    -

    -

    -

    -

URI

POST https://{hostURL}/v2/{project_id}/sim/pm/algorithms

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方法请参见获取项目ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

run

是

RunSrlz object

参数解释:

运行信息。

约束限制:

不涉及

name

是

String

参数解释:

算法名称。

约束限制:

不涉及

取值范围:

最大长度64位,支持中文,字母,数字及下划线命名。

默认取值:

不涉及

description

否

String

参数解释:

算法描述。

约束限制:

不涉及

取值范围:

最大长度256位,支持中文,字母,数字及下划线命名。

默认取值:

不涉及

category

是

category object

参数解释:

算法类型。

约束限制:

不涉及

取值范围:

  • image - Image

默认取值:

不涉及

mount_dir

否

String

参数解释:

挂载目录,需绝对路径。

约束限制:

不涉及

取值范围:

最大长度256位,支持中文,字母,数字及下划线命名,不允许挂载系统目录[/opt, /boot, /dev, /etc, /lib, /proc, /sys, /usr]。

默认取值:

不涉及

image_repo_id

是

Integer

参数解释:

镜像ID。

约束限制:

必须是已创建且用途是仿真算法的镜像,可以通过创建镜像仓库接口创建。

取值范围:

不涉及

默认取值:

不涉及

表3 RunSrlz

参数

是否必选

参数类型

描述

command

是

String

参数解释:

运行命令。

约束限制:

不涉及。

取值范围:

长度[0-256],仅支持ASCII字符,不能包含@#$%^&*<>,不支持中文字符。

默认取值:

不涉及

keyword

否

String

参数解释:

算法关键字。

约束限制:

不涉及。

取值范围:

长度[0-256],仅支持ASCII字符,不能包含@#$%^&*<>,不支持中文字符。

默认取值:

不涉及

cpu

否

Double

参数解释:

cpu配额。

约束限制:

值需在集群cpu 配额的范围内。

取值范围:

大于0。

默认取值:

不涉及。

memory

否

Integer

参数解释:

内存配额。

约束限制:

值需在集群内存 配额的范围内。

取值范围:

大于0。

默认取值:

不涉及。

gpu

否

Integer

参数解释:

gpu配额。

约束限制:

值需在集群gpu 配额的范围内。

取值范围:

大于0。

默认取值:

不涉及。

pkg_log_dir

否

String

参数解释:

日志打包目录,需绝对路径。

约束限制:

不涉及

取值范围:

最大长度256位,支持中文,字母,数字及下划线命名,不允许挂载系统目录[/opt, /boot, /dev, /etc, /lib, /proc, /sys, /usr]。

默认取值:

不涉及

表4 category

参数

是否必选

参数类型

描述

-

否

String

参数解释:

算法类型。

约束限制:

不涉及

取值范围:

  • image - Image

默认取值:

不涉及

响应参数

状态码:201

表5 响应Body参数

参数

参数类型

描述

url

String

参数解释:

算法镜像的资源地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

id

Integer

参数解释:

算法镜像ID。

约束限制:

不涉及。

取值范围:

不涉及

默认取值:

不涉及

created_at

Double

参数解释:

创建时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

updated_at

Double

参数解释:

更新时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

run

RunSrlz object

参数解释:

运行信息。

约束限制:

不涉及

name

String

参数解释:

算法名称。

约束限制:

不涉及

取值范围:

最大长度64位,支持中文,字母,数字及下划线命名。

默认取值:

不涉及

description

String

参数解释:

算法描述。

约束限制:

不涉及

取值范围:

最大长度256位,支持中文,字母,数字及下划线命名。

默认取值:

不涉及

category

category object

参数解释:

算法类型。

约束限制:

不涉及

取值范围:

  • image - Image

默认取值:

不涉及

mount_dir

String

参数解释:

挂载目录,需绝对路径。

约束限制:

不涉及

取值范围:

最大长度256位,支持中文,字母,数字及下划线命名,不允许挂载系统目录[/opt, /boot, /dev, /etc, /lib, /proc, /sys, /usr]。

默认取值:

不涉及

image_repo_id

Integer

参数解释:

镜像ID。

约束限制:

必须是已创建且用途是仿真算法的镜像,可以通过创建镜像仓库接口创建。

取值范围:

不涉及

默认取值:

不涉及

表6 RunSrlz

参数

参数类型

描述

command

String

参数解释:

运行命令。

约束限制:

不涉及。

取值范围:

长度[0-256],仅支持ASCII字符,不能包含@#$%^&*<>,不支持中文字符。

默认取值:

不涉及

keyword

String

参数解释:

算法关键字。

约束限制:

不涉及。

取值范围:

长度[0-256],仅支持ASCII字符,不能包含@#$%^&*<>,不支持中文字符。

默认取值:

不涉及

cpu

Double

参数解释:

cpu配额。

约束限制:

值需在集群cpu 配额的范围内。

取值范围:

大于0。

默认取值:

不涉及。

memory

Integer

参数解释:

内存配额。

约束限制:

值需在集群内存 配额的范围内。

取值范围:

大于0。

默认取值:

不涉及。

gpu

Integer

参数解释:

gpu配额。

约束限制:

值需在集群gpu 配额的范围内。

取值范围:

大于0。

默认取值:

不涉及。

pkg_log_dir

String

参数解释:

日志打包目录,需绝对路径。

约束限制:

不涉及

取值范围:

最大长度256位,支持中文,字母,数字及下划线命名,不允许挂载系统目录[/opt, /boot, /dev, /etc, /lib, /proc, /sys, /usr]。

默认取值:

不涉及

表7 category

参数

参数类型

描述

-

String

参数解释:

算法类型。

约束限制:

不涉及

取值范围:

  • image - Image

默认取值:

不涉及

请求示例

创建算法

POST https://{endpoint}/v2/{project_id}/sim/pm/algorithms/

{
  "category" : "image",
  "name" : "my-algorithm",
  "description" : "add-new-algorithm",
  "run" : {
    "command" : "my_cmd",
    "keyword" : "my_keyword",
    "cpu" : 2,
    "memory" : 1024,
    "gpu" : 0,
    "pkg_log_dir" : "/srv/log"
  },
  "repository_id" : 262463
}

响应示例

状态码:201

{
  "url" : "/v2/my_project_id/sim/pm/algorithms/62/",
  "id" : 62,
  "created_at" : 1.699954029362022E9,
  "updated_at" : 1.699954029362044E9,
  "description" : {
    "content" : "customer algorithm"
  },
  "name" : "my-algorithm-x1",
  "category" : "image",
  "mount_dir" : "/srv/code",
  "image_repo_id" : 262463,
  "compilation" : {
    "git_url" : null,
    "git_branch" : null,
    "git_sha1" : null,
    "compile_image_status" : 100,
    "compile_command" : null,
    "compile_workspace" : ".",
    "artifact_paths" : null,
    "public_key" : null
  },
  "build" : {
    "run_image_status" : 100,
    "run_workspace" : "."
  },
  "run" : {
    "command" : "my_cmd",
    "pkg_log_dir" : "/srv/log",
    "keyword" : "my_keyword",
    "cpu" : 2.0,
    "memory" : 1024,
    "gpu" : 0
  }
}

状态码

状态码

描述

201

创建成功

错误码

请参见错误码。

相关文档