DescribeSQLDetails - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the SQL text of an SQL statement based on the SQL ID.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TenantId	string	Yes	The ID of the tenant.	t2mr3oae0****
SQLId	string	Yes	SQLID.	8D6E84**0B8FB1823D199E2CA1**

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
SQLDetails	array	The details of the SQL statement.
	object
SQLText	string	The SQL text.	SELECT ** FROM WHERE = ? AND = ? ORDER BY ** ASC
DbName	string	The name of the database.	testdb
UserName	string	The username.	tester

Example

Normal return example

JSONFormat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "SQLDetails": [
    {
      "SQLText": "SELECT  ****   FROM ****   WHERE **** = ? AND **** = ?   ORDER BY **** ASC",
      "DbName": "testdb",
      "UserName": "tester"
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.

Change history

Change time

Summary of changes

Operate

2022-01-17

OpenAPI DescribeSQLDetails is offline

Change item	Change content

2022-01-17

OpenAPI DescribeSQLDetails is offline

Change item	Change content

2022-01-17

OpenAPI DescribeSQLDetails is offline

Change item	Change content

2022-01-17

OpenAPI DescribeSQLDetails is offline

Change item	Change content