All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeOasSQLDetails

Last Updated:Oct 23, 2024

You can call this API to query detailed information about the SQL, including the SQL text, related table names, and so on.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oceanbase:DescribeOasSQLDetailsnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****
TenantIdstringYes

The ID of the tenant.

t4louaeei****
SqlIdstringYes

SQL ID.

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

The name of the database.

test_db
StartTimestringYes

The start time of querying the SQL execution plan.
The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.

2023-04-12T04:38:38Z
EndTimestringYes

The end time of querying the SQL execution plan.
The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.

2023-04-12T05:38:38Z

Response parameters

ParameterTypeDescriptionExample
object

Returned response.

RequestIdstring

The request ID.

EE205C00-30E4-****-****-87E3A8A2AA0C
Dataobject

The list of the SQL execution plan.

Fulltextstring

SQL text.

select a from b
Tablesarray

The table name related to the SQL.

Tablesstring

The table name.

[{"xxxx","xxxx","xxxx"},{...}...]
UserNamestring

The username.

test_user
Statementstring

Parameterized text.

select a from b
DbNamestring

The name of the database.

test_db

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "Fulltext": "select a from b",
    "Tables": [
      "[{\"xxxx\",\"xxxx\",\"xxxx\"},{...}...]"
    ],
    "UserName": "test_user",
    "Statement": "select a from b",
    "DbName": "test_db"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-15The request parameters of the API has changedView Change Details
2023-08-21The request parameters of the API has changedView Change Details