Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs/ Connection Management APIs/ Exporting a Connection
Updated on 2022-09-15 GMT+08:00
View PDF

Exporting a Connection

Function

This API is used to export all connection information that is compressed in ZIP format.

URI

  • URI format

    POST /v1/{project_id}/connections/export

  • Parameter description
    Table 1 URI parameter

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain a project ID, see Project ID and Account ID.

Request

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

workspace

No

String

Workspace ID.

  • If this parameter is not set, data in the default workspace is queried by default.
  • To query data in other workspaces, this header must be carried.

Response

The value of Content-Type in the response message is application/octet-stream that needs to be converted into a file. For details, see Parsing a Stream in a Response Message. Response messages are compressed as a file. The file name format is DLF_All_DataConnections.zip. The file directory is as follows:

connections
├─{dwsConnection}.conn

Example

Export a connection.

  • Request 
    POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/export
  • Success response

    HTTP status code 200

    Response messages are compressed as a file. The file directory is as follows:
connections
├─{dwsConnection}.conn
  • Failure response

    HTTP status code 400

    {
    "error_code":"DLF.6322",
    "error_msg":"The data connection does not exist."
}

Status Codes

See Status Codes.