All Products
Search

This Product

    ApsaraDB for OceanBase:DescribeOasSQLDetails

    Document Center

    ApsaraDB for OceanBase:DescribeOasSQLDetails

    Last Updated:Apr 29, 2024

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

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    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.

    string

    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
    2023-08-21The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DynamicSql