The connection management capability is provided by Management Center. APIs of Management Center are recommended.
Function
This API is used to import one or more connection files from OBS to the Data Development module. Before using this API, store connection files in OBS buckets.
- 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
Request parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
path |
Yes |
String |
With OBS deployed: OBS path for storing the connection definition file. For details about the format of the job definition file, see the response message of the exported connection. Without OBS deployed: local path for storing the connection definition file. |
params |
No |
List<Params> |
Connection parameter. By default, this parameter is left blank. |
sameNamePolicy |
No |
String |
Policy for specifying how to handle duplicate names. The options are as follows: |
Params connection parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
name |
Yes |
String |
Name of a connection. |
type |
Yes |
String |
Connection type. |
params |
No |
Map<String,Stri ng> |
Connection parameter. For details about parameter names, see the description of each type of connection configuration item. By default, this parameter is left blank. |
Response Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
taskId |
Yes |
String |
ID of the task. Used to call the API for querying system tasks to obtain the import status. |
Example Request
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/import
{
"path":"obs://00zyx/2019-07-02/DLF_All_DataConnections.zip",
"sameNamePolicy":"OVERWRITE",
"params":[
{
"name":"DWS",
"type":"DWS",
"params":{
"clusterName":"cluster1"
}
},
{
"name":"hive",
"type":"HIVE",
"params":{
"clusterName":"mrs_ymcc",
"connectionMethod":"agent",
"userName":"admin",
"agentName":"cdm-donotdelete",
"kmsKey":"KMS-42ab"
}
}
]
}
Example Response
Status Codes
See Status Codes.