SearchSemanticViews-阿里云帮助中心

Searches for semantic views.

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 syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL cluster.	am-bp*****
QueryText	string	No	The search query.	销售额
TopK	integer	No	The number of the most relevant semantic views to return.	3

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Data	array	A list of semantic view objects.
	SemanticViewModel	A semantic view object.	-

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Data": [
    {
      "ViewSchema": "",
      "Definition": "",
      "ViewName": "",
      "Comment": "",
      "Score": 0
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MDS.CatalogAlreadyExist	The catalog already exists.	Catalog already exists
400	MDS.IllegalArgument	Invalid argument.	An invalid parameter is used.
400	MDS.InvalidPrivilege	No permissions.	You are not authorized to perform this operation.
400	MDS.MetaSchemaAlreadyExist	The database already exists.	The specified database already exists.
400	MDS.MetaSchemaNotExist	The database does not exist.	The specified database does not exist.
400	MDS.MetaTableAlreadyExist	The table already exists.	The specified table already exists.
400	MDS.MetaTableNotExist	The table is not found.	The specified table does not exist.
400	MDS.SemanticViewAlreadyExist	The semantic view already exists.	Semantic view already exists
400	MDS.SemanticViewNotExist	This semantic view does not exist.	This semantic view does not exist
500	MDS.InternalError	An internal MDS error occurred.	An internal error occurred.
500	MDS.MetaVisitError	Failed to access metadata.	Failed to access the metadata.
403	MDS.RamAuthAccessDenied	ram auth access denied.	RAM authentication failed
404	MDS.InstanceNotExist	ADB instance does not exist.	ADB instance does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.