All Products
Search

This Product

    ApsaraDB for OceanBase:CreateOasOutlineTask

    Document Center

    ApsaraDB for OceanBase:CreateOasOutlineTask

    Last Updated:Nov 14, 2025

    You can call this operation to initiate outline binding tasks.

    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

    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.

    		ob2mr3oae0****
    SqlTextstringYes

    The SQL text.

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

    The name of the database.

    		test_data
    TableNamestringNo

    The name of the table.

    		test_1
    SqlIdstringNo

    The ID of the SQL statement.

    		8D6E84****0B8FB1823D199E2CA1****
    IsConcurrentLimitbooleanNo
    • When the value is set to True, the throttling information in the database is queried based on the SQL ID.
    • When the value is set to False, the bound index or execution plan in the database is queried based on the SQL ID.
    		true
    DynamicSqlbooleanNo

    Specifies whether the specified SQL statements are dynamic SQL statements.

    Note This parameter specifies whether the values of the SqlId parameter are the IDs of dynamic SQL statements.
    		false
    UIdstringNo

    The user identifier (UID) of the OceanBase database.

    		139*************
    PlanDatastringNo

    The execution plan.

    		********
    IndexNamestringNo

    The name of the index.

    		idx_a
    MaxConcurrentintegerNo

    The maximum number of outline binding tasks that can be initiated at a time.

    		2
    StartTimestringNo

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

    		2025-05-13T15:40:43Z
    EndTimestringNo

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

    		2025-05-13T16:40:43Z
    StatementIdstringNo

    The ID of the SQL template.

    		********
    BySqlIdbooleanNo

    Specifies whether to bind by SQLID/SQLText. Default value: true.

    		true

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

    		EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
    Successboolean

    Indicates whether the call is successful.

    		true
    Messagestring

    The error description.

    		successful

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Success": true,
  "Message": "successful"
}

    Error codes

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