GetDataSourceMeta-DataWorks(DataWorks)-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to obtain the ID.	10000
DatasourceName	string	Yes	The name of the data source.	mysql_name
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
EnvType	string	No	The environment in which the data source resides. Valid values: 0: development environment 1: production environment	1

Response elements

Element	Type	Description	Example
	object	The returned result.
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	0000-ABCD-EFG
Data	object	The returned result.
Status	string	Indicates whether the metadata of the data source is obtained. Valid values: success: The metadata of the data source is obtained. fail: The metadata of the data source failed to be obtained. You can troubleshoot issues based on the Message parameter.	success
Message	string	The reason why the metadata of the data source fails to be obtained. If the metadata of the data source is obtained, no value is returned for this parameter.	read datasource time out
Meta	string	The returned metadata of the data source. The returned metadata is in the JSON format. `{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}` Parameter description: dbName: the name of the database in which the data source resides. schema: the schema of the database. enable: indicates whether the database is available. The valid values are true and false. The value true indicates that the database is available. The value false indicates that the database is unavailable. tableName: the name of the table in the database. tableInfos: the information about the table in the database.	{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}

Examples

Success response

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.
500	InternalError.DI.Parameter	A DI internal error occurred.
403	Forbidden.DI.NoPrivilege	No access.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.