Updated on 2025-10-22 GMT+08:00

Exporting Assets in Batches

Function

Exporting Assets in Batches.

  • This API is used to create a job for exporting assets that meet given conditions.

  • A maximum of 100 applications and tasks are supported.

  • A user can create only one asset export job at a time. Ensure that no job in the Running state when the user creates such a job.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v2/{project_id}/instances/{instance_id}/assets/export

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see "Appendix" > "Obtaining a Project ID" in the API Reference.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

apps

Yes

Array of apps objects

Applications.

tasks

Yes

Array of tasks objects

Tasks.

Table 4 apps

Parameter

Mandatory

Type

Description

id

No

String

Application ID.

Table 5 tasks

Parameter

Mandatory

Type

Description

id

No

String

Task ID.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

job_id

String

ID of an asset export job, which can be used to query the job progress.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_details

String

Error information.

request_id

String

Request ID.

Example Requests

Export integration applications and data integration tasks in bathes.

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/assets/export

{
  "apps" : [ {
    "id" : "b1e6b1e6-4f3f-4a80-bb45-f4b9039f95a3"
  }, {
    "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a4"
  } ],
  "tasks" : [ {
    "id" : "b2e6a456-1234-4a80-aa45-f4b8029f95a4"
  }, {
    "id" : "123456648-4f3f-4a80-aa45-f4b00005a42"
  } ]
}

Example Responses

Status code: 200

OK

{
  "job_id" : "ff8080814dbd65d7014dbe0d84db0013"
}

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

Status Codes

Status Code

Description

200

OK

403

Forbidden

Error Codes

See Error Codes.