全部产品
Search

搜索本产品

    数据库自治服务 DAS：GetQueryOptimizeRuleList - 获取规则列表

    文档中心

    数据库自治服务 DAS：GetQueryOptimizeRuleList - 获取规则列表

    更新时间：Mar 13, 2026

    调用GetQueryOptimizeRuleList接口，获取规则列表。

    接口说明

    • 在使用阿里云 SDK 时，需要保证 aliyun-sdk-core 的版本大于 2.1.8，建议使用最新版本。

    • 使用 DAS 的 SDK 的版本为 2.1.8 或以上。

    • 在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。

    • 本接口适用的数据库引擎为：

      • RDS MySQL

      • PolarDB MySQL 版

      • RDS PostgreSQL

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    hdm:GetQueryOptimizeRuleList

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    Engine

    string

    是

    数据库引擎，取值：

    • MySQL

    • PolarDBMySQL

    • PostgreSQL

    MySQL
    InstanceIds

    string

    否

    实例 ID，多个实例 ID 用逗号分隔。

    rm-2ze8g2am97624****
    TagNames

    string

    否

    备用参数。

    None
    Region

    string

    否

    实例所属地域，取值：

    • cn-china：中国内地。

    • cn-hongkong：中国香港。

    • ap-southeast-1：新加坡。

    此参数只有在请求参数 InstanceIds 为空时有效。如果请求参数 InstanceIds 为空时，按照 Region 参数设置的地域获取数据，系统默认实例所属地域为cn-china；如果请求参数 InstanceIds 不为空时，即使设置了 Region 参数，也以 InstanceIds 所传入的第一个实例所在地域为准获取数据。

    说明

    在中国内地各地域创建的实例，传入此参数时，都为cn-china。

    cn-china

    返回参数

    名称

    类型

    描述

    示例值

    object

    Code

    string

    返回的状态码。

    200
    Message

    string

    请求返回消息。

    Successful
    Data

    object

    详细信息列表。

    Total

    integer

    总数据量。

    1
    PageNo

    integer

    备用参数。

    None
    PageSize

    integer

    备用参数。

    None
    Extra

    string

    备用参数。

    None
    List

    array<object>

    规则数据列表。

    object

    规则数据列表。

    Type

    string

    规则类型，当前只支持 Predefined（系统预定义）。

    Predefined
    Name

    string

    规则名，具体信息请参见查询治理。

    LARGE_ROWS_EXAMINED
    RuleId

    string

    备用参数。

    None
    RequestId

    string

    请求 ID。

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

    string

    请求是否执行成功：

    • true：执行成功。

    • false：执行失败。

    true

    示例

    正常返回示例

    JSON格式

    {
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 1,
    "PageNo": 0,
    "PageSize": 0,
    "Extra": "None",
    "List": [
      {
        "Type": "Predefined",
        "Name": "LARGE_ROWS_EXAMINED",
        "RuleId": "None"
      }
    ]
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 InvalidParams The request parameters are invalid. 请求参数错误
    403 NoPermission You are not authorized to do this action. 没有权限执行该操作

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。