更新时间:2025-09-26 GMT+08:00
分享

生成cicd接入配置命令

功能介绍

生成cicd接入配置命令

调用方法

请参见如何调用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"
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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("<YOUR REGION>"))
                .build();
        CreateCicdConfigurationCommandRequest request = new CreateCicdConfigurationCommandRequest();
        CreateCicdConfigurationCommandRequestBody body = new CreateCicdConfigurationCommandRequestBody();
        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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = CreateCicdConfigurationCommandRequest()
        request.body = CreateCicdConfigurationCommandRequestBody(
        )
        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)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateCicdConfigurationCommandRequest{}
	request.Body = &model.CreateCicdConfigurationCommandRequestBody{
	}
	response, err := client.CreateCicdConfigurationCommand(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档