首页 数据库自治服务 DAS API参考指南 API目录 查询治理 GetQueryOptimizeRuleList - 获取规则列表

GetQueryOptimizeRuleList - 获取规则列表

调用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:GetQueryOptimizeRuleListRead
  • DAS
    acs:hdm:*:{#accountId}:*

请求参数

名称类型必填描述示例值
Enginestring

数据库引擎,取值:

  • MySQL
  • PolarDBMySQL
  • PostgreSQL
MySQL
InstanceIdsstring

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

rm-2ze8g2am97624****
TagNamesstring

备用参数。

None

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

Successful
Dataobject

详细信息列表。

Totallong

总数据量。

1
PageNointeger

备用参数。

None
PageSizeinteger

备用参数。

None
Extrastring

备用参数。

None
Listarray

规则数据列表。

object

规则数据列表。

Typestring

规则类型,当前只支持 Predefined(系统预定义)。

Predefined
Namestring

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

LARGE_ROWS_EXAMINED
RuleIdstring

备用参数。

None
RequestIdstring

请求ID。

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

请求是否执行成功:

  • 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错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误

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

阿里云首页 数据库自治服务 相关技术圈