Queries the metadata of a specified data source.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ProjectId | long | Yes | The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the ID. | 10000 |
DatasourceName | string | Yes | The name of the data source. | mysql_name |
PageNumber | long | Yes | The page number. | 1 |
PageSize | long | Yes | The number of entries per page. | 10 |
EnvType | string | No | The environment in which the data source resides. Valid values:
| 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"Success": true,
"RequestId": "0000-ABCD-EFG\t",
"Data": {
"Status": "success",
"Message": "read datasource time out",
"Meta": "{\"dbTables\":[{\"dbName\":\"testdb\",\"schema\":[{\"tableInfos\":[{\"dbName\":\"testdb\",\"enable\":true,\"table\":\"table1\",\"tableName\":\"table1\"}]},{\"tableInfos\":[{\"dbName\":\"testdb\",\"enable\":true,\"table\":\"table2\",\"tableName\":\"table2\"}]}]}]}"
}
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | Invalid.DI.Parameter | The parameter is invalid. |
403 | Forbidden.DI.NoPrivilege | No access. |
500 | InternalError.DI.Parameter | A DI internal error occurred. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-11-14 | The Error code has changed | View Change Details |