# 导出资产列表 - ExportResources #### 功能介绍 导出资产列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI POST /v1/{project_id}/workspaces/{workspace_id}/sa/resources/export 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间id。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | 资产类型 | | provider | 否 | String | 资产提供商 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Language | 是 | String | **参数解释：** 语言，参考值：zh-cn、en-us **约束限制：** 不涉及 **取值范围：** zh-cn：中文环境 en-us：英文环境 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | content-type | 是 | String | **参数解释：** 内容类型 - application/json;charset=UTF-8 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json;charset=UTF-8 **默认取值：** 不涉及 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | data_object_filters_form | 是 | [ResourceDataobjectSearch] object | **参数解释:** 搜索列表条件 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | title | 是 | Array of strings | 导出字段 | 表5ResourceDataobjectSearch | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释:** 分页查询参数，用于指定一次查询最多的结果数，从1开始。 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | offset | 否 | Integer | **参数解释:** 分页查询参数。用于指定查询结果的起始位置，从0开始 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | sort_by | 否 | String | **参数解释:** 排序字段：create_time \| update_time **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | order | 否 | String | **参数解释:** 排序方式：升序/降序 **约束限制**: 不涉及 **取值范围**: DESC: 降序 ASC： 升序 **默认取值**: 不涉及 | | from_date | 否 | String | **参数解释:** 搜索起始时间 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | to_date | 否 | String | **参数解释:** 搜索结束时间 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | condition | 否 | [condition] object | **参数解释:** 搜索条件表达式 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | 表6condition | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | conditions | 否 | Array of [conditions] objects | **参数解释:** 表达式列表 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | logics | 否 | Array of strings | **参数解释:** 表达式名称列表 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | 表7conditions | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释:** 表达式名称 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | data | 否 | Array of strings | **参数解释:** 表达式内容列表 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | #### 响应参数 **状态码：200** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | File | 资产列表导出结果文件 | #### 请求示例 ``` https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/sa/resources/export?type=cloudservers,vm,pm { "data_object_filters_form" : { "limit" : 10000, "offset" : 0, "condition" : { "conditions" : [ ], "logics" : [ ] } }, "title" : [ "name", "type", "environment.region_id", "private_ips", "department.name", "business.name", "business.owner", "environment.vendor_type", "protected_status", "import_time", "region_id", "domain_id", "resource_id", "provider" ] } ``` #### 响应示例 **状态码：200** 资产列表导出结果文件 ``` "resource.xlsx" ``` #### 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.secmaster.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; import java.util.List; import java.util.ArrayList; public class ExportResourcesSolution { 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); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("")) .build(); ExportResourcesRequest request = new ExportResourcesRequest(); request.withWorkspaceId("{workspace_id}"); ExportResourcesRequestBody body = new ExportResourcesRequestBody(); List listbodyTitle = new ArrayList<>(); listbodyTitle.add("name"); listbodyTitle.add("type"); listbodyTitle.add("environment.region_id"); listbodyTitle.add("private_ips"); listbodyTitle.add("department.name"); listbodyTitle.add("business.name"); listbodyTitle.add("business.owner"); listbodyTitle.add("environment.vendor_type"); listbodyTitle.add("protected_status"); listbodyTitle.add("import_time"); listbodyTitle.add("region_id"); listbodyTitle.add("domain_id"); listbodyTitle.add("resource_id"); listbodyTitle.add("provider"); ResourceDataobjectSearchCondition conditionDataObjectFiltersForm = new ResourceDataobjectSearchCondition(); conditionDataObjectFiltersForm.withConditions() .withLogics(); ResourceDataobjectSearch dataObjectFiltersFormbody = new ResourceDataobjectSearch(); dataObjectFiltersFormbody.withLimit(10000) .withOffset(0) .withCondition(conditionDataObjectFiltersForm); body.withTitle(listbodyTitle); body.withDataObjectFiltersForm(dataObjectFiltersFormbody); request.withBody(body); try { ExportResourcesResponse response = client.exportResources(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 huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v1 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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("")) \ .build() try: request = ExportResourcesRequest() request.workspace_id = "{workspace_id}" listTitlebody = [ "name", "type", "environment.region_id", "private_ips", "department.name", "business.name", "business.owner", "environment.vendor_type", "protected_status", "import_time", "region_id", "domain_id", "resource_id", "provider" ] conditionDataObjectFiltersForm = ResourceDataobjectSearchCondition( ) dataObjectFiltersFormbody = ResourceDataobjectSearch( limit=10000, offset=0, condition=conditionDataObjectFiltersForm ) request.body = ExportResourcesRequestBody( title=listTitlebody, data_object_filters_form=dataObjectFiltersFormbody ) response = client.export_resources(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" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/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 := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ExportResourcesRequest{} request.WorkspaceId = "{workspace_id}" var listTitlebody = []string{ "name", "type", "environment.region_id", "private_ips", "department.name", "business.name", "business.owner", "environment.vendor_type", "protected_status", "import_time", "region_id", "domain_id", "resource_id", "provider", } conditionDataObjectFiltersForm := &model.ResourceDataobjectSearchCondition{ } limitDataObjectFiltersForm:= int32(10000) offsetDataObjectFiltersForm:= int32(0) dataObjectFiltersFormbody := &model.ResourceDataobjectSearch{ Limit: &limitDataObjectFiltersForm, Offset: &offsetDataObjectFiltersForm, Condition: conditionDataObjectFiltersForm, } request.Body = &model.ExportResourcesRequestBody{ Title: listTitlebody, DataObjectFiltersForm: dataObjectFiltersFormbody, } response, err := client.ExportResources(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=ExportResources&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 资产列表导出结果文件 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。