Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs (V1)/ Connection Management APIs (To Be Taken Offline)/ Exporting Connections (to Be Taken Offline)
Updated on 2024-11-06 GMT+08:00
View PDF
Share

Exporting Connections (to Be Taken Offline)

The connection management capability is provided by Management Center. This API is no longer maintained. You are advised to use the APIs in Management Center for connection management.

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 Parameters

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 Parameters

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 Request

Export a connection. 
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/export

Example Response

  • 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.

Parent Topic: Connection Management APIs (To Be Taken Offline)