ListTagMetaAsset - Data Management - Alibaba Cloud Documentation Center

Lists Database and Table assets associated with a specific Tag in a DataAgent Workspace.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The tenant ID. Note You can obtain your tenant ID by hovering your cursor over your profile picture in the upper-right corner of the console. For more information, see View tenant information.	3***
TagName	string	Yes	The Tag name. To retrieve Database and Table information from a DataAgent Workspace, specify the Tag in the following format: `sys::DMS-DA::${DataAgentRegionId}::space:${DataAgentWorkspaceId}`.	sys::DMS-DA::cn-hangzhou::space:abcde
MetaType	string	Yes	To retrieve a list of Databases, set this parameter to `META_DATABASE`. To retrieve a list of Tables in a specific Database, set this parameter to `META_TABLE`.	META_DATABASE
MetaParentId	string	No	The ID of the parent asset. Omit this parameter to retrieve a list of Databases. To retrieve a list of Tables in a specific Database, set this parameter to the Database's `dbId`.	123456
SearchKey	string	No	The keyword for a fuzzy search.	test
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page.	50

Response elements

Element	Type	Description	Example
	object
RequestId	string	The Request ID.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code returned if the request fails.	UnknownError
ErrorMessage	string	The error message returned if the request fails.	UnknownError
Success	boolean	Indicates if the request succeeded. Valid values: true: The request succeeded. false: The request failed.	true
Data	array<object>	A list of the returned assets.
	array<object>
MetaType	string	`META_DATABASE`: The asset is a Database. `META_TABLE`: The asset is a Table.	META_DATABASE
MetaEntityAttrs	object	Contains the following fields if `MetaType` is `META_DATABASE`: `schemaName`: The name of the Database. For PostgreSQL-compatible databases, this is the schema name. `catalogName`: The name of the Database for PostgreSQL-compatible databases. `dbId`: The ID of the Database in Data Management (DMS). `instanceResourceId`: The resource ID of the Instance. If the Instance is an ApsaraDB RDS instance, this is the RDS instance ID. `dbType`: The Database type in DMS. `schemaName`: The name of the database, or the name of the schema for PostgreSQL-based databases. catalogName: The database name for PostgreSQL-compatible databases. dbId: The database ID in DMS dbType: The database type in DMS. `tableName`: The name of the table. tableSchemaName: The schema name of the table. Valid only for SQLServer.	{"schemaName": "test"}
TotalCount	integer	The total number of matching entries.	100

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": [
    {
      "MetaType": "META_DATABASE",
      "MetaEntityAttrs": {
        "schemaName": "test"
      }
    }
  ],
  "TotalCount": 100
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.