Creating a Container Export Task
Function
Create a container export task.
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/container/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. |
export_size |
No |
Integer |
Parameter description: Exported records Constraints: N/A Options: 1-100000 Default value: 100000 |
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 |
---|---|---|---|
cluster_container |
No |
Boolean |
Parameter description: Whether the container is managed by a cluster. Set this parameter to true if only containers in a cluster are exported. Set this parameter to false if only non-cluster containers are exported. Constraints: N/A Options: The value can be "true" or "false". Default value: N/A |
cluster_type |
No |
String |
Definition Cluster type. Constraints N/A Range
Default Value N/A |
cluster_name |
No |
String |
Parameter description: Name of the cluster to which the audited source belongs. Constraints: N/A Options: The value contains 1 to 255 characters. Default value: N/A |
container_name |
No |
String |
Parameter description: Container name Constraints: N/A Options: The value contains 1 to 255 characters. Default value: N/A |
pod_name |
No |
String |
Parameter description: Pod name Constraints: N/A Options: The value can contain 1 to 512 characters. Default value: N/A |
image_name |
No |
String |
Parameter description: Image name. Constraints: N/A Options: The value contains 1 to 255 characters. Default value: N/A |
status |
No |
String |
Definition Container status. Constraints N/A Range
Default Value N/A |
risky |
No |
Boolean |
Parameter description: Check whether there are security risks. If only containers with security risks are to be exported, set this parameter to true. If only containers without security risks are to be exported, set this parameter to false. Constraints: N/A Options: The value can be "true" or "false". Default value: N/A |
create_time |
No |
create_time object |
Created |
cpu_limit |
No |
String |
Parameter description: CPU limit Constraints: N/A Options: You can enter 0 to 64 characters. The unit is MB, for example, 100 MB. Default value: N/A |
memory_limit |
No |
String |
Parameter description: Memory limit. Constraints: N/A Options: You can enter 0 to 64 characters. The unit is Mi or Gi, for example, 300 Mi. Default value: N/A |
export_headers |
Yes |
Array<Array<String>> |
Definition Export the header information of the container list. Constraints N/A Range Valid key values and their corresponding header names. (The header names can be customized.)
Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Export task ID |
Example Requests
Create a container export task.
{ "export_headers" : [ [ "container_name", "Container Name" ], [ "image_name", "Image Name" ], [ "risky", "Security Risk" ] ] }
Example Responses
Status code: 200
Request succeeded.
{ "task_id" : "test" }
SDK Sample Code
The SDK sample code is as follows.
Create a container export task.
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 65 |
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 ExportContainerListSolution { 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(); ExportContainerListRequest request = new ExportContainerListRequest(); ExportContainerListRequestBody body = new ExportContainerListRequestBody(); List<String> listExportHeadersExportHeaders = new ArrayList<>(); listExportHeadersExportHeaders.add("risky"); listExportHeadersExportHeaders.add("Security Risk"); List<String> listExportHeadersExportHeaders1 = new ArrayList<>(); listExportHeadersExportHeaders1.add("image_name"); listExportHeadersExportHeaders1.add("Image Name"); List<String> listExportHeadersExportHeaders2 = new ArrayList<>(); listExportHeadersExportHeaders2.add("container_name"); listExportHeadersExportHeaders2.add("Container Name"); List<List<String>> listbodyExportHeaders = new ArrayList<>(); listbodyExportHeaders.add(listExportHeadersExportHeaders); listbodyExportHeaders.add(listExportHeadersExportHeaders1); listbodyExportHeaders.add(listExportHeadersExportHeaders2); body.withExportHeaders(listbodyExportHeaders); request.withBody(body); try { ExportContainerListResponse response = client.exportContainerList(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()); } } } |
Create a container export task.
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 |
# 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 = ExportContainerListRequest() listExportHeadersExportHeaders = [ "risky", "Security Risk" ] listExportHeadersExportHeaders1 = [ "image_name", "Image Name" ] listExportHeadersExportHeaders2 = [ "container_name", "Container Name" ] listExportHeadersbody = [ listExportHeadersExportHeaders, listExportHeadersExportHeaders1, listExportHeadersExportHeaders2 ] request.body = ExportContainerListRequestBody( export_headers=listExportHeadersbody ) response = client.export_container_list(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create a container export task.
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.ExportContainerListRequest{} var listExportHeadersExportHeaders = []string{ "risky", "Security Risk", } var listExportHeadersExportHeaders1 = []string{ "image_name", "Image Name", } var listExportHeadersExportHeaders2 = []string{ "container_name", "Container Name", } var listExportHeadersbody = [][]string{ listExportHeadersExportHeaders, listExportHeadersExportHeaders1, listExportHeadersExportHeaders2, } request.Body = &model.ExportContainerListRequestBody{ ExportHeaders: listExportHeadersbody, } response, err := client.ExportContainerList(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