Help Center/ DataArts Insight/ API Reference/ Import and Export Parameters/ Setting Import and Export Parameters
Updated on 2025-02-25 GMT+08:00

Setting Import and Export Parameters

Function

This API is used to set import and export parameters.

URI

POST /v1/{project_id}/exports/config

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

For how to obtain a project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Workspace-Id

Yes

String

Workspace ID. For how to obtain it, see Obtaining a Workspace ID.

X-Auth-Token

Yes

String

User token.

Content-Type

Yes

String

Request body type and character set, which have fixed values.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

service_type

Yes

String

Service type.

obs_endpoint

Yes

String

OBS endpoint.

obs_bucket_name

Yes

String

OBS bucket name.

max_storage_days

Yes

Integer

Maximum storage duration of exported files in OBS.

obs_path_prefix

Yes

String

OBS path prefix.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

message

String

Description.

Example Request

POST https://{endpoint}/v1/{project_id}/exports/config

{
  "service_type" : "obs",
  "obs_endpoint" : "obs.xxx.com",
  "obs_bucket_name" : "xxxxx",
  "max_storage_days" : 1,
  "obs_path_prefix" : "/dataArts-insight"
}

Example Response

{
  "message" : "success"
}

Status Codes

Table 5 Status code

Status Code

Description

200

The configuration is successful.

Error Codes

See Error Codes.