All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeSQLDetails

Last Updated:Oct 20, 2022

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

ParameterTypeRequiredDescriptionExample
TenantIdstringYes

The ID of the tenant.

t2mr3oae0****
SQLIdstringYes

SQLID.

8D6E84****0B8FB1823D199E2CA1****

Response parameters

ParameterTypeDescriptionExample
object

The return result of the request.

RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
SQLDetailsarray

The details of the SQL statement.

object
SQLTextstring

The SQL text.

SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC
DbNamestring

The name of the database.

testdb
UserNamestring

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 timeSummary of changesOperate
2022-01-17OpenAPI DescribeSQLDetails is offline
Change itemChange content
2022-01-17OpenAPI DescribeSQLDetails is offline
Change itemChange content
2022-01-17OpenAPI DescribeSQLDetails is offline
Change itemChange content
2022-01-17OpenAPI DescribeSQLDetails is offline
Change itemChange content