更新时间:2025-08-15 GMT+08:00

创建容器导出任务

功能介绍

创建容器导出任务

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/container/export-task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

export_size

Integer

参数解释:

导出条数

约束限制:

不涉及

取值范围:

取值1-100000

默认取值:

100000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

cluster_container

Boolean

参数解释:

是否是集群内的容器。只导出集群内容器时,设置此参数值为true。只导出非集群容器时,设置此参数为false。

约束限制:

不涉及

取值范围:

true或者false。

默认取值:

不涉及

cluster_type

String

参数解释:

集群类型。

约束限制:

不涉及

取值范围:

  • cce:CCE集群

  • ali:阿里云集群

  • tencent:腾讯云集群

  • azure:微软云集群

  • aws:亚马逊集群

  • self_built_hw:华为云自建集群

  • self_built_idc:IDC自建集群

默认取值:

不涉及

cluster_name

String

参数解释:

所属集群名称。

约束限制:

不涉及

取值范围:

字符长度1-255。

默认取值:

不涉及

container_name

String

参数解释:

容器名称。

约束限制:

不涉及

取值范围:

字符长度1-255。

默认取值:

不涉及

pod_name

String

参数解释:

所属Pod名称。

约束限制:

不涉及

取值范围:

字符长度1-512。

默认取值:

不涉及

image_name

String

参数解释:

镜像名称。

约束限制:

不涉及

取值范围:

字符长度1-255。

默认取值:

不涉及

status

String

参数解释:

容器状态。

约束限制:

不涉及

取值范围:

  • Running : 运行中

  • Waiting : 等待

  • Terminated : 终止

  • Isolated : 已隔离

  • Paused : 已暂停

默认取值:

不涉及

risky

Boolean

参数解释:

是否有安全风险。只导出有安全风险容器时,设置此参数值为true。只导出无安全风险容器时,设置此参数为false。

约束限制:

不涉及

取值范围:

true或者false。

默认取值:

不涉及

create_time

create_time object

创建时间

cpu_limit

String

参数解释:

cpu限制。

约束限制:

不涉及

取值范围:

字符长度0-64。以m为单位,例如100m。

默认取值:

不涉及

memory_limit

String

参数解释:

内存限制。

约束限制:

不涉及

取值范围:

字符长度0-64。以Mi、Gi为单位,例如300Mi。

默认取值:

不涉及

export_headers

Array<Array<String>>

参数解释:

导出容器列表的表头信息。

约束限制:

不涉及

取值范围:

合法的key值及其对应的表头名称(表头名称可自定义)

  • container_id:容器id

  • container_name:容器名称

  • image_name:镜像名称

  • pod_name:所属POD

  • cluster_name:所属集群

  • cluster_type:集群类型

  • status:状态

  • risky:是否有安全风险

  • low_risk:低危风险

  • medium_risk:中危风险

  • high_risk:高危风险

  • fatal_risk:致命风险

  • create_time:创建时间

  • restart_count:重启次数

  • cpu_limit:CPU限制

  • memory_limit:内存限制

默认取值:

不涉及

表5 create_time

参数

是否必选

参数类型

描述

start_time

Long

筛选起始时间

end_time

Long

筛选终止时间

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

task_id

String

导出任务ID

请求示例

创建容器导出任务

{
  "export_headers" : [ [ "container_name", "容器名称" ], [ "image_name", "镜像名称" ], [ "risky", "是否有安全风险" ] ]
}

响应示例

状态码:200

请求已成功

{
  "task_id" : "test"
}

SDK代码示例

SDK代码示例如下。

创建容器导出任务

 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("是否有安全风险");
        List<String> listExportHeadersExportHeaders1 = new ArrayList<>();
        listExportHeadersExportHeaders1.add("image_name");
        listExportHeadersExportHeaders1.add("镜像名称");
        List<String> listExportHeadersExportHeaders2 = new ArrayList<>();
        listExportHeadersExportHeaders2.add("container_name");
        listExportHeadersExportHeaders2.add("容器名称");
        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());
        }
    }
}

创建容器导出任务

 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",
            "是否有安全风险"
        ]
        listExportHeadersExportHeaders1 = [
            "image_name",
            "镜像名称"
        ]
        listExportHeadersExportHeaders2 = [
            "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)

创建容器导出任务

 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",
	    "是否有安全风险",
    }
	var listExportHeadersExportHeaders1 = []string{
        "image_name",
	    "镜像名称",
    }
	var listExportHeadersExportHeaders2 = []string{
        "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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码