# 生成cicd接入配置命令 - CreateCicdConfigurationCommand #### 功能介绍 生成cicd接入配置命令。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v5/{project_id}/image/cicd/configurations/create-command 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0024.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释**: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见[获取企业项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0027.html)。 如需查询所有企业项目下的资产请传参"all_granted_eps"。 **约束限制**: 开通企业项目功能后才需要配置企业项目ID参数。 **取值范围**: 字符长度1-256位 **默认取值**: 0，表示默认企业项目（default）。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度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扫描信息 | 表5ImageScanRequestInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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位 **默认取值**: 不涉及 | | pipeline_type | 否 | String | **参数解释**: 流水线类型 **约束限制**: 不涉及 **取值范围**: - jenkins：Jenkins流水线。 - codearts：CodeArts流水线。 **默认取值**: 不涉及 | 表6IacScanRequestInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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位 | #### 请求示例 ``` { "scan_type" : "local_image", "cicd_id" : "xxx", "image_name" : "xxx", "image_version" : "xxx", "is_blocking" : true, "repository_address" : "xxx", "login_user_name" : "xxxx", "login_password" : "xxx", "namespace" : "xxx", "is_image_scan" : true, "image_scan_info" : { "scan_type" : "local_image", "image_name" : "xxx", "image_version" : "xxxx", "is_blocking" : true, "repository_address" : "xxx", "login_user_name" : "xxx", "login_password" : "xxx", "namespace" : "xxx", "pipeline_type" : "jenkins" }, "is_iac_scan" : true, "iac_scan_info" : { "configuration_mode" : "local_directory", "path" : "xxx" } } ``` #### 响应示例 **状态码：200** 请求已成功 ``` { "cicd_command" : "docker load xxx" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class CreateCicdConfigurationCommandSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("")) .build(); CreateCicdConfigurationCommandRequest request = new CreateCicdConfigurationCommandRequest(); CreateCicdConfigurationCommandRequestBody body = new CreateCicdConfigurationCommandRequestBody(); IacScanRequestInfo iacScanInfobody = new IacScanRequestInfo(); iacScanInfobody.withConfigurationMode("local_directory") .withPath("xxx"); ImageScanRequestInfo imageScanInfobody = new ImageScanRequestInfo(); imageScanInfobody.withScanType("local_image") .withImageName("xxx") .withImageVersion("xxxx") .withIsBlocking(true) .withRepositoryAddress("xxx") .withLoginUserName("xxx") .withLoginPassword("xxx") .withNamespace("xxx") .withPipelineType("jenkins"); body.withIacScanInfo(iacScanInfobody); body.withIsIacScan(true); body.withImageScanInfo(imageScanInfobody); body.withIsImageScan(true); body.withNamespace("xxx"); body.withLoginPassword("xxx"); body.withLoginUserName("xxxx"); body.withRepositoryAddress("xxx"); body.withIsBlocking(true); body.withImageVersion("xxx"); body.withImageName("xxx"); body.withCicdId("xxx"); body.withScanType("local_image"); request.withBody(body); try { CreateCicdConfigurationCommandResponse response = client.createCicdConfigurationCommand(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("")) \ .build() try: request = CreateCicdConfigurationCommandRequest() iacScanInfobody = IacScanRequestInfo( configuration_mode="local_directory", path="xxx" ) imageScanInfobody = ImageScanRequestInfo( scan_type="local_image", image_name="xxx", image_version="xxxx", is_blocking=True, repository_address="xxx", login_user_name="xxx", login_password="xxx", namespace="xxx", pipeline_type="jenkins" ) request.body = CreateCicdConfigurationCommandRequestBody( iac_scan_info=iacScanInfobody, is_iac_scan=True, image_scan_info=imageScanInfobody, is_image_scan=True, namespace="xxx", login_password="xxx", login_user_name="xxxx", repository_address="xxx", is_blocking=True, image_version="xxx", image_name="xxx", cicd_id="xxx", scan_type="local_image" ) response = client.create_cicd_configuration_command(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.CreateCicdConfigurationCommandRequest{} configurationModeIacScanInfo:= "local_directory" pathIacScanInfo:= "xxx" iacScanInfobody := &model.IacScanRequestInfo{ ConfigurationMode: &configurationModeIacScanInfo, Path: &pathIacScanInfo, } scanTypeImageScanInfo:= "local_image" imageNameImageScanInfo:= "xxx" imageVersionImageScanInfo:= "xxxx" isBlockingImageScanInfo:= true repositoryAddressImageScanInfo:= "xxx" loginUserNameImageScanInfo:= "xxx" loginPasswordImageScanInfo:= "xxx" namespaceImageScanInfo:= "xxx" pipelineTypeImageScanInfo:= "jenkins" imageScanInfobody := &model.ImageScanRequestInfo{ ScanType: &scanTypeImageScanInfo, ImageName: &imageNameImageScanInfo, ImageVersion: &imageVersionImageScanInfo, IsBlocking: &isBlockingImageScanInfo, RepositoryAddress: &repositoryAddressImageScanInfo, LoginUserName: &loginUserNameImageScanInfo, LoginPassword: &loginPasswordImageScanInfo, Namespace: &namespaceImageScanInfo, PipelineType: &pipelineTypeImageScanInfo, } isIacScanCreateCicdConfigurationCommandRequestBody:= true isImageScanCreateCicdConfigurationCommandRequestBody:= true namespaceCreateCicdConfigurationCommandRequestBody:= "xxx" loginPasswordCreateCicdConfigurationCommandRequestBody:= "xxx" loginUserNameCreateCicdConfigurationCommandRequestBody:= "xxxx" repositoryAddressCreateCicdConfigurationCommandRequestBody:= "xxx" isBlockingCreateCicdConfigurationCommandRequestBody:= true imageVersionCreateCicdConfigurationCommandRequestBody:= "xxx" imageNameCreateCicdConfigurationCommandRequestBody:= "xxx" scanTypeCreateCicdConfigurationCommandRequestBody:= "local_image" request.Body = &model.CreateCicdConfigurationCommandRequestBody{ IacScanInfo: iacScanInfobody, IsIacScan: &isIacScanCreateCicdConfigurationCommandRequestBody, ImageScanInfo: imageScanInfobody, IsImageScan: &isImageScanCreateCicdConfigurationCommandRequestBody, Namespace: &namespaceCreateCicdConfigurationCommandRequestBody, LoginPassword: &loginPasswordCreateCicdConfigurationCommandRequestBody, LoginUserName: &loginUserNameCreateCicdConfigurationCommandRequestBody, RepositoryAddress: &repositoryAddressCreateCicdConfigurationCommandRequestBody, IsBlocking: &isBlockingCreateCicdConfigurationCommandRequestBody, ImageVersion: &imageVersionCreateCicdConfigurationCommandRequestBody, ImageName: &imageNameCreateCicdConfigurationCommandRequestBody, CicdId: "xxx", ScanType: &scanTypeCreateCicdConfigurationCommandRequestBody, } response, err := client.CreateCicdConfigurationCommand(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=CreateCicdConfigurationCommand&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。