Help Center/Host Security Service/API Reference/API Description/Cluster Risks/Exporting Cluster Environment Security Information
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Exporting Cluster Environment Security Information

Function

This API is used to export cluster environment security information.

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}/container/cluster/risk/export-task

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.

risk_type

Yes

String

Definition

Risk type.

Constraints

N/A

Range

  • **iac_risk: IaC risk

Default Value

N/A

export_size

Yes

Integer

Definition

Number of exported data records.

Constraints

N/A

Range

N/A

Default Value

N/A

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

export_headers

Yes

Array<Array<String>>

Definition

Header list of exported cluster security data.

Range

Minimum value: 1; maximum value: 10000

iac_items

No

IacRequestInfo object

IaC risk filter criteria

Table 5 IacRequestInfo

Parameter

Mandatory

Type

Description

file_id_list

No

Array of strings

Definition

IaC file ID list.

Constraints

N/A

Range

1 to 200 items

Default Value

N/A

file_name

No

String

Definition

File name.

Constraints

N/A

Range

Length: 1 to 64 characters

Default Value

N/A

file_type

No

String

Definition

File type

Constraints

N/A

Range

  • dockerfile: Dockerfile file.

  • k8s_yaml: Kubernetes YAML file.

Default Value

N/A

risky

No

Boolean

Definition

Risky or not.

Constraints

N/A

Range

  • true: There is a risk.

  • false: There is no risk.

Default Value

N/A

scan_type

No

String

Definition

Scan Mode

Constraints

N/A

Range

  • manual_scan: manual scan.

  • cicd_scan: CI/CD scan.

Default Value

manual_scan

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

task_id

String

Definition

Task ID

Range

Length: 1 to 64 characters

Example Requests

Export all the IaC risks found in manual scans. The project ID is 2b31ed520xxxxxxebedb6e57xxxxxxxx. The exported Excel file contains the File Name and Risk Name columns.

POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/container/cluster/risk/export-task?enterprise_project_id=all_granted_eps&risk_type=iac_risk&export_size=10000

{
  "iac_items" : {
    "scan_type" : "manual_scan"
  },
  "export_headers" : [ [ "file_name", "Document name." ], [ "risk_name", "Risk name." ] ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "task_id" : "b02cdc6b-aeed-4232-911f-3e4e2a2d991a"
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Cluster Risks