Generating a CI/CD Access Configuration Command

Function

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

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
pipeline_type	No	String	Definition Pipeline type. Constraints N/A Range jenkins: Jenkins pipeline codearts: CodeArts pipeline 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"
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Installation and Configuration

Previous topic: Deleting CI/CD Configuration

Next topic: Querying CI/CD Configuration

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot