Updated on 2025-09-30 GMT+08:00

Generating a CI/CD Access Configuration Command

Function

This API is used to generate a CI/CD access configuration command.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

scan_type

No

String

Definition

Scan scope.

Constraints

N/A

Range

  • local_image: Local image. This is an image scan parameter.

  • remote_image: Remote image repository. This is an image scan parameter.

  • local_directory: Local directory. This is an IaC scan parameter.

  • remote_address: HTTPS remote address

  • git_repository_address: Git repository address

Default Value

N/A

cicd_id

Yes

String

Definition

CI/CD identifier.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

image_name

No

String

Definition

Image name.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

image_version

No

String

Definition

Image tag.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

is_blocking

No

Boolean

Definition

Whether the pipeline blocks risks.

Constraints

N/A

Range

  • true: The pipeline is blocked.

  • false: The pipeline is not blocked.

Default Value

N/A

repository_address

No

String

Definition

Image repository address.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

login_user_name

No

String

Definition

Username for logging in to the image repository.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

login_password

No

String

Definition

Password of an image repository.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

namespace

No

String

Definition

Organization name.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

is_image_scan

No

Boolean

Definition

Whether to scan images.

Constraints

N/A

Range

  • true: Scan.

  • false: Do not scan.

Default Value

N/A

image_scan_info

No

ImageScanRequestInfo object

Image scan information

is_iac_scan

No

Boolean

Definition

Whether to scan IaC.

Constraints

N/A

Range

  • true: Scan.

  • false: Do not scan.

Default Value

N/A

iac_scan_info

No

IacScanRequestInfo object

IaC scan information.

Table 5 ImageScanRequestInfo

Parameter

Mandatory

Type

Description

scan_type

No

String

Definition

Scan scope.

Constraints

N/A

Range

  • local_image: Local image. This is an image scan parameter.

  • remote_image: Remote image repository. This is an image scan parameter.

Default Value

N/A

image_name

No

String

Definition

Image name.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

image_version

No

String

Definition

Image tag.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

is_blocking

No

Boolean

Definition

Whether the pipeline blocks risks.

Constraints

N/A

Range

  • true: The pipeline is blocked.

  • false: The pipeline is not blocked.

Default Value

N/A

repository_address

No

String

Definition

Image repository address.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

login_user_name

No

String

Definition

Username for logging in to the image repository.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

login_password

No

String

Definition

Password of an image repository.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

namespace

No

String

Definition

Organization name.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

Table 6 IacScanRequestInfo

Parameter

Mandatory

Type

Description

configuration_mode

No

String

Definition

Configuration method.

Constraints

N/A

Range

  • local_directory: local directory

  • remote_address: HTTPS remote address

  • git_repository_address: Git repository address

Default Value

N/A

path

No

String

Definition

Configuration file path.

Constraints

N/A

Range

1 to 256 characters

Default Value

N/A

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

cicd_command

String

Definition

CI/CD access configuration command.

Range

Length: 1 to 1024 characters

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "cicd_command" : "docker load xxx"
}

SDK Sample Code

The SDK sample code is as follows.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.