tencent cloud

APIs

CreateHostImageListExportJob

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-01 10:35:02

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

Create a local image list export task. The export fields include image ID, image name, mirror version, number of associated containers, number of associated hosts, creation time, account nickname, and risk fields such as scan status, vulnerability, Trojan, and sensitive information. Filtering is supported. Export is implemented through an async task. After JobId is returned, the frontend polls to query the export task status. In single account mode, the NickName field is automatically excluded.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateHostImageListExportJob.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
ClusterCaMD5 Yes String

MD5 of the cluster CA certificate (32-bit hexadecimal, required)

MemberId.N No Array of String

Group account member id

Filter No Filter

Common ListFilter structure (including Filters array + ListFindOption pagination)
Supported filter fields: Host / ImageId / ImageName / HasRunningContainer

ExportFields.N No Array of String

List of fields to export (all fields are exported if this parameter is not passed)
Enumeration values:
ImageId: image ID
ImageName: image name
ImageVersion: mirror version
ContainerCount: number of associated containers
HostCount: number of associated hosts
CreateTime: creation time
NickName: account nickname (automatically excluded in single account mode)
ScanStatus: scan status
LastScanTime: latest scan completion time
VulCountCritical: number of critical vulnerabilities
VulCountHigh: number of high vulnerabilities
VulCountMedium: number of medium vulnerabilities
VulCountLow: number of low vulnerabilities
VirusCountCritical: number of critical trojans
VirusCountHigh: number of high trojans
VirusCountMedium: number of medium trojans
VirusCountLow: number of low trojans
SensitiveCountCritical: number of critical sensitive data items
SensitiveCountHigh: number of high sensitive data items
SensitiveCountMedium: number of medium sensitive data items
SensitiveCountLow: number of low sensitive data items

3. Output Parameters

Parameter Name Type Description
JobId String

Export task ID
Parameter value reference: used when polling task status from the frontend

RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 1

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHostImageListExportJob
<Common request parameters>

{
    "ClusterCaMD5": "5f65*********************5d63e8a",
    "MemberId": [
        "mem-tencent-*********f66e429"
    ]
}

Output Example

{
    "Response": {
        "JobId": "32ce0493-60b3-4874-a3a5-15607d01b258",
        "RequestId": "0bb3e913-2f7f-47bf-8593-139765d81d64"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Parameter error.

Ajuda e Suporte

Esta página foi útil?

comentários