# 导出资产指纹信息 - DownloadAssetFile #### 功能介绍 导出资产指纹信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v5/{project_id}/asset/export 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0024.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释**: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见[获取企业项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0027.html)。 如需查询所有企业项目下的资产请传参"all_granted_eps"。 **约束限制**: 开通企业项目功能后才需要配置企业项目ID参数。 **取值范围**: 字符长度1-256位 **默认取值**: 0，表示默认企业项目（default）。 | | asset_type | 是 | String | **参数解释**: 资产指纹类型 **约束限制**: 不涉及 **取值范围**: - users ：账号 - auto_launch ：自启动项 - database ：数据库 - jar_package ：中间件 - port ：开放端口 - process ：进程 - web_cms ：web应用 - web_framework ：web框架 - web_service ：web服务 - web_site ：web站点 - app ：软件 - kernel_module ：内核模块 **默认取值**: 不涉及 | | category | 是 | String | **参数解释**: 类别 **约束限制**: 不涉及 **取值范围**: - host ：主机 - container：容器 **默认取值**: host | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-32768位 **默认取值**: 不涉及 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | search_param | 否 | String | **参数解释**: 查询条件，json格式字符串，如{"port_string": "8080"} **约束限制**: 如下接口的请求参数的json格式 - users ：/v5/{project_id}/asset/users - auto_launch ：/v5/{project_id}/asset/auto-launchs - database ：/v5/{project_id}/asset/web-app-and-services - jar_package ：/v5/{project_id}/asset/midwares/detail - port ：/v5/{project_id}/asset/ports/detail - process ：/v5/{project_id}/asset/processes/detail - web_cms ：/v5/{project_id}/asset/web-app-and-services - web_framework ：/v5/{project_id}/asset/host/web-framework - web_service ：/v5/{project_id}/asset/web-app-and-services - web_site ：/v5/{project_id}/asset/host/web-site - app ：/v5/{project_id}/asset/apps - kernel_module ：/v5/{project_id}/asset/host/kernel-module **取值范围**: 字符长度0-128 **默认取值**: 不涉及 | | export_headers | 是 | Array of [ExportHead] objects | **参数解释**: 导出数据表头信息详情 **约束限制**: 表头信息应为如下格式\[\[字段1,表头1显示名称\],\[字段2,表头2显示名称\],\[字段3,表头3显示名称\]\] **取值范围**: 可从如下取值中选取部分或全部组成表头信息 所有资产都有如下字段： - host_name：主机服务器名 - host_ip：主机ip - users - user_name：用户名 - login_permission：是否有登录权限 - root_permission：是否有root权限 - user_group_name：用户组 - user_home_dir：用户目录 - shell：用户启动shell - recent_scan_time：最近扫描时间 - first_scan_time：首次扫描时间 - container_id：容器id - container_name：容器名称 - auto_launch - name：名称 - type：类型 - path：文件路径 - hash：文件hash - run_user：运行用户 - recent_scan_time：最近扫描时间 - container_id：容器id - container_name：容器名称 - database - web_cms - web_service - host_name: 主机名称 - host_ip：主机ip - name：软件名称 - version：软件版本 - install_path：安装路径 - config_path：配置文件路径 - uid：用户id - mode：软件文件权限 - pid：软件进程id - proc_path：软件进程路径 - record_time：扫描时间 - container_id：容器id - container_name：容器名称 - jar_package - name：名称 - file_name：文件名 - catalogue：类别 - file_type：文件类型 - version：版本 - path：文件路径 - hash：文件hash - uid：用户id - gid：用户组id - mode：文件权限 - pid：进程id - proc_path：进程路径 - is_embedded：是否为内层jar包 - package_path：外层jar包路径 - record_time：扫描时间 - container_id：容器id - container_name：容器名称 - port - port_status：端口是否需要处理 - port：端口号 - type：类型 - pid：进程ID - path：程序文件路径 - laddr：监听的ip - container_id：容器id - container_name：容器名称 - process - process_path：进程路径 - launch_params：启动参数 - launch_time：启动时间 - user_name：运行用户 - run_permission：运行权限 - process_pid：进程ID - hash：文件hash - container_id：容器id - container_name：容器名称 - web_framework - name：名称 - file_name：文件名 - catalogue：类别 - file_type：文件类型 - version：版本 - path：文件路径 - hash：文件hash - uid：用户id - gid：用户组id - mode：文件权限 - pid：进程id - proc_path：进程路径 - record_time：扫描时间 - container_id：容器id - container_name：容器名称 - web_site - domain：对外域名 - port：对外端口号 - url_path：url路径 - path：web目录 - mode：web目录文件权限 - uid：用户id - record_time：扫描时间 - is_https：是否为https - pid：进程id - cert_issuer：SSL证书颁发者 - cert_user：SSL证书使用者 - cert_issue_time：SSL证书颁发时间 - cert_expired_time：SSL证书到期时间 - container_id：容器id - container_name：容器名称 - app - app_name：软件名称 - version：版本号 - update_time：更新时间 - recent_scan_time：最近扫描时间 - container_id：容器id - container_name：容器名称 - kernel_module - name：名称 - version：版本 - srcversion：源码版本 - desc：描述 - path：文件路径 - size：文件大小 - mode：文件权限 - uid：用户id - ctime：文件创建时间 - mtime：最后修改时间 - hash：文件hash - record_time：扫描时间 其他资产类别特有字段： **默认取值**: 不涉及 | 表5ExportHead | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | \[数组元素\] | 否 | Array of strings | **参数解释**: 导出数据表头信息详情 **约束限制**: 表头信息应为如下格式\[\[字段1,表头1显示名称\],\[字段2,表头2显示名称\],\[字段3,表头3显示名称\]\] **取值范围**: 可从如下取值中选取部分或全部组成表头信息 所有资产都有如下字段： - host_name：主机服务器名 - host_ip：主机ip - users - user_name：用户名 - login_permission：是否有登录权限 - root_permission：是否有root权限 - user_group_name：用户组 - user_home_dir：用户目录 - shell：用户启动shell - recent_scan_time：最近扫描时间 - first_scan_time：首次扫描时间 - container_id：容器id - container_name：容器名称 - auto_launch - name：名称 - type：类型 - path：文件路径 - hash：文件hash - run_user：运行用户 - recent_scan_time：最近扫描时间 - container_id：容器id - container_name：容器名称 - database - web_cms - web_service - name：软件名称 - version：软件版本 - install_path：安装路径 - config_path：配置文件路径 - uid：用户id - mode：软件文件权限 - pid：软件进程id - proc_path：软件进程路径 - record_time：扫描时间 - container_id：容器id - container_name：容器名称 - jar_package - name：名称 - file_name：文件名 - catalogue：类别 - file_type：文件类型 - version：版本 - path：文件路径 - hash：文件hash - uid：用户id - gid：用户组id - mode：文件权限 - pid：进程id - proc_path：进程路径 - is_embedded：是否为内层jar包 - package_path：外层jar包路径 - record_time：扫描时间 - container_id：容器id - container_name：容器名称 - port - port_status：端口是否需要处理 - port：端口号 - type：类型 - pid：进程ID - path：程序文件路径 - laddr：监听的ip - container_id：容器id - container_name：容器名称 - process - process_path：进程路径 - launch_params：启动参数 - launch_time：启动时间 - user_name：运行用户 - run_permission：运行权限 - process_pid：进程ID - hash：文件hash - container_id：容器id - container_name：容器名称 - web_framework - name：名称 - file_name：文件名 - catalogue：类别 - file_type：文件类型 - version：版本 - path：文件路径 - hash：文件hash - uid：用户id - gid：用户组id - mode：文件权限 - pid：进程id - proc_path：进程路径 - record_time：扫描时间 - container_id：容器id - container_name：容器名称 - web_site - domain：对外域名 - port：对外端口号 - url_path：url路径 - path：web目录 - mode：web目录文件权限 - uid：用户id - record_time：扫描时间 - is_https：是否为https - pid：进程id - cert_issuer：SSL证书颁发者 - cert_user：SSL证书使用者 - cert_issue_time：SSL证书颁发时间 - cert_expired_time：SSL证书到期时间 - container_id：容器id - container_name：容器名称 - app - app_name：软件名称 - version：版本号 - update_time：更新时间 - recent_scan_time：最近扫描时间 - container_id：容器id - container_name：容器名称 - kernel_module - name：名称 - version：版本 - srcversion：源码版本 - desc：描述 - path：文件路径 - size：文件大小 - mode：文件权限 - uid：用户id - ctime：文件创建时间 - mtime：最后修改时间 - hash：文件hash - record_time：扫描时间 **默认取值**: 其他资产类别特有字段： 不涉及 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | **参数解释**： 导出任务ID **取值范围**： 字符长度0-128位 | #### 请求示例 导出资产指纹的相关数据。 ``` POST https://{endpoint}/v5/{project_id}/asset/export?asset_type=web_service&category=host&enterprise_project_id=all_granted_eps { "export_headers" : [ [ "host_name", "主机服务器名" ], [ "host_ip", "主机ip" ] ] } ``` #### 响应示例 **状态码：200** 请求已成功 ``` { "task_id" : "513d9747-6059-495f-be82-2db216e643ae" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 导出资产指纹的相关数据。 ``` 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 DownloadAssetFileSolution { 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("")) .build(); DownloadAssetFileRequest request = new DownloadAssetFileRequest(); DownloadAssetFileRequestBody body = new DownloadAssetFileRequestBody(); List listExportHeadersExportHeaders = new ArrayList<>(); listExportHeadersExportHeaders.add("host_ip"); listExportHeadersExportHeaders.add("主机ip"); List listExportHeadersExportHeaders1 = new ArrayList<>(); listExportHeadersExportHeaders1.add("host_name"); listExportHeadersExportHeaders1.add("主机服务器名"); List> listbodyExportHeaders = new ArrayList<>(); listbodyExportHeaders.add(listExportHeadersExportHeaders); listbodyExportHeaders.add(listExportHeadersExportHeaders1); body.withExportHeaders(listbodyExportHeaders); request.withBody(body); try { DownloadAssetFileResponse response = client.downloadAssetFile(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()); } } } ``` - [Python] 导出资产指纹的相关数据。 ``` # 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("")) \ .build() try: request = DownloadAssetFileRequest() listExportHeadersExportHeaders = [ "host_ip", "主机ip" ] listExportHeadersExportHeaders1 = [ "host_name", "主机服务器名" ] listExportHeadersbody = [ listExportHeadersExportHeaders, listExportHeadersExportHeaders1 ] request.body = DownloadAssetFileRequestBody( export_headers=listExportHeadersbody ) response = client.download_asset_file(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 导出资产指纹的相关数据。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.DownloadAssetFileRequest{} var listExportHeadersExportHeaders = []string{ "host_ip", "主机ip", } var listExportHeadersExportHeaders1 = []string{ "host_name", "主机服务器名", } var listExportHeadersbody = [][]string{ listExportHeadersExportHeaders, listExportHeadersExportHeaders1, } request.Body = &model.DownloadAssetFileRequestBody{ ExportHeaders: listExportHeadersbody, } response, err := client.DownloadAssetFile(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=DownloadAssetFile&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。