All Products
Search

This Product

    Database Autonomy Service:GetQueryOptimizeShareUrl

    Document Center

    Database Autonomy Service:GetQueryOptimizeShareUrl

    Last Updated:Mar 13, 2026

    Queries a share URL provided by the query governance feature.

    Operation description

    • If you use Alibaba Cloud SDK or Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.

    • If you use an SDK to call API operations of DAS, you must set the region ID to cn-shanghai.

    • This operation supports the following database engines:

      • ApsaraDB RDS for MySQL

      • PolarDB for MySQL

      • ApsaraDB RDS for PostgreSQL

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    hdm:GetQueryOptimizeShareUrl

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Engine

    string

    Yes

    The database engine. Valid values:

    • MySQL: ApsaraDB RDS for MySQL

    • PolarDBMySQL: PolarDB for MySQL

    • PostgreSQL: ApsaraDB RDS for PostgreSQL

    MySQL
    InstanceIds

    string

    No

    The instance IDs. Separate multiple IDs with commas (,).

    rm-2ze1jdv45i7l6****
    TagNames

    string

    No

    A reserved parameter.

    None
    Keywords

    string

    No

    The keywords of the SQL template. Separate multiple keywords with spaces.

    select update
    LogicalOperator

    string

    No

    The logical relationship between multiple keywords. Valid values:

    • or

    • and

    or
    Rules

    string

    No

    The tags that are used to filter SQL templates. Separate multiple tags with commas (,). For more information, see Query governance.

    DAS_NOT_IMPORTANT
    DbNames

    string

    No

    The name of the database to be queried.

    testdb01
    Time

    integer

    Yes

    The date to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1642953600000
    PageSize

    integer

    No

    The number of entries per page. Default value: 10.

    10
    PageNo

    integer

    No

    The page number. Pages start from page 1. Default value: 1.

    1
    OrderBy

    string

    No

    The field by which to sort the returned entries. Default value: count. Valid values:

    • count: the number of executions.

    • maxQueryTime: the longest execution duration.

    • avgQueryTime: the average execution duration.

    • maxLockTime: the longest lock wait duration.

    • avgLockTime: the average lock wait duration.

    • maxRowsExamined: the largest number of scanned rows.

    • avgRowsExamined: the average number of scanned rows.

    • maxRowsSent: the largest number of returned rows.

    • avgRowsSent: the average number of returned rows.

    count
    Asc

    boolean

    No

    Specifies whether to sort the returned entries in ascending order. Default value: true. Valid values:

    • true

    • false

    true
    OnlyOptimizedSql

    boolean

    No

    Specifies whether to query only SQL templates that need to be optimized. Default value: false. Valid values:

    • true

    • false

    true
    SqlIds

    string

    No

    The SQL template IDs. You can call the GetQueryOptimizeExecErrorStats operation to obtain the SQL template IDs.

    6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0****
    Region

    string

    No

    The region in which the instance resides. Valid values:

    • cn-china: Chinese mainland

    • cn-hongkong: China (Hong Kong)

    • ap-southeast-1: Singapore

    This parameter takes effect only if InstanceIds is left empty. If you leave InstanceIds empty, the system obtains data from the region set by Region. By default, Region is set to cn-china. If you specify InstanceIds, Region does not take effect and the system obtains data from the region in which the first specified instance resides.****

    Note

    If your instances reside in the regions in the Chinese mainland, set this parameter to cn-china.

    cn-china
    User

    string

    No

    The account of the database to be queried.

    testUser

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    The HTTP status code returned.

    200
    Message

    string

    The returned message.

    Note

    If the request was successful, Successful is returned. If the request failed, an error message that contains information such as an error code is returned.

    Successful
    RequestId

    string

    The request ID.

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    string

    Indicates whether the request was successful. Valid values:

    • true

    • false

    true
    Data

    string

    The share URL.

    https://hdm.console.alibabacloud.com/#/queryOptimize****

    Examples

    Success response

    JSON format

    {
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": "https://hdm.console.alibabacloud.com/#/queryOptimize****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParams The request parameters are invalid.
    403 NoPermission You are not authorized to do this action.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.