Querying DataArts Factory Data Connections That Support Fine-grained Authentication

Function

This API is used to query the fine-grained data development connection list (full).

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/security/fgac/dlf/datawarehouses

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of items displayed on each page
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
workspace	Yes	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
X-Auth-Token	Yes	String	IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This parameter is mandatory for token authentication.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
dw_lists	Array of DataWareHouseDTO objects	Fine-grained connection list for data development.

**Table 5** DataWareHouseDTO
Parameter	Type	Description
dw_id	String	Data connection ID.
dw_name	String	Name of a data connection.
dw_type	String	Data connection type. The options are as follows: Hive data source DWS Data Source Spark data source
dw_config	dw_config object	Fine-grained connection configuration information for data development.

**Table 6** dw_config
Parameter	Type	Description
fgac_flag	Boolean	Whether to enable fine-grained authentication. true indicates that fine-grained authentication is enabled, and false indicates that fine-grained authentication is disabled.
fgac_type	String	Specifies the fine-grained authentication type. This parameter is valid only when fine-grained authentication is enabled. The value 0 indicates fine-grained authentication in the development state, which supports fine-grained script running and job test running. The value 1 indicates fine-grained authentication in the scheduling state, which supports fine-grained script running, job test running, and job execution scheduling.
fgac_conn_status	String	Data source connectivity test status: UNKNOWN: The connectivity is not tested. TESTING: The connectivity is being tested. SUCCESS: The connectivity test is successful. FAILED: The connectivity test fails.
fgac_conn_test_time	Long	Indicates the time of the latest connectivity test.
fgac_conn_test_error	String	Connectivity test failure information. If the connectivity test is successful or the connectivity test is not performed, the failure information is an empty string.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

v1/0833a5737480d53b2f25c010dc1a7b88/security/fgac/dlf/datawarehouses

Example Responses

Status code: 200

{
  "dw_lists" : [ {
    "dw_config" : {
      "fgac_conn_status" : "SUCCESS",
      "fgac_conn_test_error" : "",
      "fgac_conn_test_time" : 1709175082675,
      "fgac_flag" : false,
      "fgac_type" : "0"
    },
    "dw_id" : "7c8a2d85d917492bb3195377cd9c36be",
    "dw_name" : "hive",
    "dw_type" : "HIVE"
  } ]
}