文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器安装与配置/ 生成cicd接入配置命令 - CreateCicdConfigurationCommand
更新时间:2025-10-31 GMT+08:00
分享

生成cicd接入配置命令 - CreateCicdConfigurationCommand

功能介绍

生成cicd接入配置命令

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/image/cicd/configurations/create-command

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

scan_type

String

参数解释

扫描类型

约束限制:

不涉及

取值范围:

  • local_image:本地镜像,镜像扫描参数

  • remote_image:远程镜像仓,镜像扫描参数

  • local_directory:本地目录,iac扫描参数

  • remote_address:https远程地址

  • git_repository_address:git仓库地址

默认取值:

不涉及

cicd_id

String

参数解释

cicd标识

约束限制

不涉及

取值范围

字符长度1-128位

默认取值

不涉及

image_name

String

参数解释:

镜像名称

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

image_version

String

参数解释:

镜像版本

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

is_blocking

Boolean

参数解释:

流水线是否阻断

约束限制:

不涉及

取值范围:

  • true:流水线被阻断。

  • false:流水线未阻断。

默认取值:

不涉及

repository_address

String

参数解释:

镜像仓地址

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

login_user_name

String

参数解释:

镜像仓登录用户名

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

login_password

String

参数解释:

镜像仓登录密码

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

namespace

String

参数解释:

组织名称

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

is_image_scan

Boolean

参数解释:

是否进行镜像扫描

约束限制:

不涉及

取值范围:

  • true:镜像扫描。

  • false:不进行镜像扫描。

默认取值:

不涉及

image_scan_info

ImageScanRequestInfo object

镜像扫描信息

is_iac_scan

Boolean

参数解释:

是否进行iac扫描

约束限制:

不涉及

取值范围:

  • true:iac扫描。

  • false:不进行iac扫描。

默认取值:

不涉及

iac_scan_info

IacScanRequestInfo object

iac扫描信息

表5 ImageScanRequestInfo

参数

是否必选

参数类型

描述

scan_type

String

参数解释:

扫描类型

约束限制:

不涉及

取值范围:

  • local_image:本地镜像,镜像扫描参数。

  • remote_image:远程镜像仓,镜像扫描参数。

默认取值:

不涉及

image_name

String

参数解释:

镜像名称

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

image_version

String

参数解释:

镜像版本

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

is_blocking

Boolean

参数解释:

流水线是否阻断

约束限制:

不涉及

取值范围:

  • true:流水线被阻断。

  • false:流水线未阻断。

默认取值:

不涉及

repository_address

String

参数解释:

镜像仓地址

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

login_user_name

String

参数解释:

镜像仓登录用户名

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

login_password

String

参数解释:

镜像仓登录密码

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

namespace

String

参数解释:

组织名称

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

表6 IacScanRequestInfo

参数

是否必选

参数类型

描述

configuration_mode

String

参数解释:

配置方式

约束限制:

不涉及

取值范围:

  • local_directory:本地目录。

  • remote_address:https远程地址。

  • git_repository_address:git仓库地址。

默认取值:

不涉及

path

String

参数解释:

配置文件路径

约束限制:

不涉及

取值范围:

字符取值1-256

默认取值:

不涉及

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

cicd_command

String

参数解释

cicd接入配置命令

取值范围

字符长度1-1024位

请求示例

响应示例

状态码:200

请求已成功

{
  "cicd_command" : "docker load xxx"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档