Updated on 2026-02-05 GMT+08:00

Exporting the Resource List

Function

This API is used to export the resource list.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/sa/resources/export

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Resource type.

provider

No

String

Resource provider.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

Yes

String

Definition

Language. Reference value: zh-cn or en-us.

Constraints

N/A

Range

zh-cn: Chinese environment

en-us: English environment

Default Value

N/A

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

data_object_filters_form

Yes

ResourceDataobjectSearch object

Search criteria.

title

Yes

Array of strings

Exported fields.

Table 5 ResourceDataobjectSearch

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page.

offset

No

Integer

Offset.

sort_by

No

String

Sorting field: create_time | update_time.

order

No

String

Sorting order. Options: DESC and ASC.

from_date

No

String

Search start time, for example, 2023-02-20T00:00:00.000Z.

to_date

No

String

Search end time, for example, 2023-02-27T23:59:59.999Z.

condition

No

condition object

Search condition expression.

Table 6 condition

Parameter

Mandatory

Type

Description

conditions

No

Array of conditions objects

Expression list.

logics

No

Array of strings

Expression name list.

Table 7 conditions

Parameter

Mandatory

Type

Description

name

No

String

Expression name.

data

No

Array of strings

Expression content list.

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

-

File

Exported resource list.

Example Requests

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" ]
}

Example Responses

Status code: 200

Exported resource list.

"resource.xlsx"

SDK Sample Code

The SDK sample code is as follows.

 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
66
67
68
69
70
71
72
73
74
75
76
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("<YOUR REGION>"))
                .build();
        ExportResourcesRequest request = new ExportResourcesRequest();
        request.withWorkspaceId("{workspace_id}");
        ExportResourcesRequestBody body = new ExportResourcesRequestBody();
        List<String> 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());
        }
    }
}
 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
# 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("<YOUR REGION>")) \
        .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)
 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
66
67
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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)
    }
}

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

Exported resource list.

Error Codes

See Error Codes.