Exporting Cluster Environment Security Information
Function
This API is used to export cluster environment security information.
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/container/cluster/risk/export-task
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 |
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
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
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 |
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 |
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
Default Value N/A |
risky |
No |
Boolean |
Definition Risky or not. Constraints N/A Range
Default Value N/A |
scan_type |
No |
String |
Definition Scan Mode Constraints N/A Range
Default Value manual_scan |
Response Parameters
Status code: 200
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" }
SDK Sample Code
The SDK sample code is as follows.
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.
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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
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.*; import java.util.List; import java.util.ArrayList; public class ExportRisksSolution { 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(); ExportRisksRequest request = new ExportRisksRequest(); ExportRisksRequestBody body = new ExportRisksRequestBody(); IacRequestInfo iacItemsbody = new IacRequestInfo(); iacItemsbody.withScanType("manual_scan"); List<String> listExportHeadersExportHeaders = new ArrayList<>(); listExportHeadersExportHeaders.add("risk_name"); listExportHeadersExportHeaders.add("Risk name."); List<String> listExportHeadersExportHeaders1 = new ArrayList<>(); listExportHeadersExportHeaders1.add("file_name"); listExportHeadersExportHeaders1.add("Document name."); List<List<String>> listbodyExportHeaders = new ArrayList<>(); listbodyExportHeaders.add(listExportHeadersExportHeaders); listbodyExportHeaders.add(listExportHeadersExportHeaders1); body.withIacItems(iacItemsbody); body.withExportHeaders(listbodyExportHeaders); request.withBody(body); try { ExportRisksResponse response = client.exportRisks(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()); } } } |
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.
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 50 |
# 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 = ExportRisksRequest() iacItemsbody = IacRequestInfo( scan_type="manual_scan" ) listExportHeadersExportHeaders = [ "risk_name", "Risk name." ] listExportHeadersExportHeaders1 = [ "file_name", "Document name." ] listExportHeadersbody = [ listExportHeadersExportHeaders, listExportHeadersExportHeaders1 ] request.body = ExportRisksRequestBody( iac_items=iacItemsbody, export_headers=listExportHeadersbody ) response = client.export_risks(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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.
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 50 51 52 53 54 55 56 57 |
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.ExportRisksRequest{} scanTypeIacItems:= "manual_scan" iacItemsbody := &model.IacRequestInfo{ ScanType: &scanTypeIacItems, } var listExportHeadersExportHeaders = []string{ "risk_name", "Risk name.", } var listExportHeadersExportHeaders1 = []string{ "file_name", "Document name.", } var listExportHeadersbody = [][]string{ listExportHeadersExportHeaders, listExportHeadersExportHeaders1, } request.Body = &model.ExportRisksRequestBody{ IacItems: iacItemsbody, ExportHeaders: listExportHeadersbody, } response, err := client.ExportRisks(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot