Updated on 2025-10-29 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

No

ResourceDataobjectSearch object

Search criteria.

title

No

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

Exported resource list.

None

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Exported resource list.

Error Codes

See Error Codes.