调用GetQueryOptimizeDataStats接口,获取查询治理模板数据。
- 在使用阿里云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代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetQueryOptimizeDataStats | 系统规定参数。取值:GetQueryOptimizeDataStats。 |
| Engine | String | 是 | MySQL | 数据库引擎,取值:
|
| InstanceIds | String | 否 | rm-2ze8g2am97624**** | 实例ID,多个实例ID用逗号分隔。 |
| TagNames | String | 否 | None | 备用参数。 |
| Keywords | String | 否 | select update | SQL文本关键词,多个关键词以空格分隔。 |
| LogicalOperator | String | 否 | or | 多个SQL文本关键词的逻辑关系。
|
| Rules | String | 否 | DAS_NOT_IMPORTANT | 需要过滤的规则,多个规则以逗号分隔。具体信息请参见查询治理。 |
| DbNames | String | 否 | testdb01 | 需要查询的数据库名。 |
| Time | String | 是 | 1642953600000 | 查询数据的日期,格式为Unix时间戳,单位为毫秒。 |
| PageSize | String | 否 | 10 | 分页查询每页最大记录数,默认为10。 |
| PageNo | String | 否 | 1 | 分页查询的页码,从1开始,默认为1。 |
| OrderBy | String | 否 | count | 排序字段,默认为count。
|
| Asc | String | 否 | true | 是否升序排序,默认为true。
|
| OnlyOptimizedSql | String | 否 | false | 是否只查询待优化的SQL,默认为false。
|
| SqlIds | String | 否 | 2e8147b5ca2dfc640dfd5e43d96a**** | SQL模板ID,您可调用GetQueryOptimizeExecErrorStats接口查询SQL模板ID。 |
| Region | String | 否 | cn-china | 实例所属地域,取值:
此参数只有在请求参数InstanceIds为空时有效。如果请求参数InstanceIds为空时,按照Region参数设置的地域获取数据,系统默认实例所属地域为cn-china;如果请求参数InstanceIds不为空时,即使设置了Region参数,也以InstanceIds所传入的第一个实例所在地域为准获取数据。 说明 在中国内地各地域创建的实例,传入此参数时,都为cn-china。 |
| User | String | 否 | testUser | 需要查询的数据库账号。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | 200 | 返回的状态码。 |
| Message | String | Successful | 请求返回消息。 |
| Data | Object | 详细信息列表。 |
|
| Total | Long | 10 | 总数据量。 |
| PageNo | Integer | None | 备用参数。 |
| PageSize | Integer | None | 备用参数。 |
| Extra | String | None | 备用参数。 |
| List | Array of QueryOptimizeDataStats | 模板数据列表。 |
|
| InstanceId | String | rm-2ze8g2am97624**** | 实例ID。 |
| Dbname | String | testdb01 | SQL所属数据库名。 |
| SqlId | String | 2e8147b5ca2dfc640dfd5e43d96a**** | SQL模板ID。 |
| SqlType | String | INSERT | SQL类别。 |
| Psql | String | select 1 | SQL模板。 |
| SqlSample | String | select 2 | SQL模板下执行最慢的SQL样本。 |
| Count | Integer | 100 | SQL执行次数。 |
| MaxQueryTime | double | 1.1 | 最大查询时间,单位为秒。 |
| AvgQueryTime | double | 1.1 | 平均查询时间,单位为秒。 |
| MaxLockTime | double | 0.1 | 最大锁等待时间,单位为秒。 |
| AvgLockTime | double | 0.1 | 平均锁等待时间,单位为秒。 |
| MaxRowsExamined | Long | 100000 | 最大扫描行数。 |
| AvgRowsExamined | double | 100.1 | 平均扫描行数。 |
| MaxRowsSent | Long | 10000 | 最大返回行数。 |
| AvgRowsSent | double | 100.1 | 平均返回行数。 |
| MaxRowsAffected | Long | 10000 | 最大影响行数。 说明 取值为-1说明暂未采集到该字段。 |
| AvgRowsAffected | double | 100.1 | 平均影响行数。 说明 取值为-1说明暂未采集到该字段。 |
| RuleList | Array of Rules | 规则列表。 |
|
| Name | String | DAS_NOT_IMPORTANT | 规则名,具体信息请参见查询治理。 |
| Type | String | Predefined | 规则类别:
|
| User | String | testUser | 数据库账号。 |
| RequestId | String | B6D17591-B48B-4D31-9CD6-9B9796B2**** | 请求ID。 |
| Success | String | true | 请求是否执行成功:
|
示例
请求示例
http(s)://das.cn-shanghai.aliyuncs.com/?Action=GetQueryOptimizeDataStats
&Engine=MySQL
&InstanceIds=rm-2ze8g2am97624****
&TagNames=None
&Keywords=select update
&LogicalOperator=or
&Rules=DAS_NOT_IMPORTANT
&DbNames=testdb01
&Time=1642953600000
&PageSize=10
&PageNo=1
&OrderBy=count
&Asc=true
&OnlyOptimizedSql=false
&SqlIds=2e8147b5ca2dfc640dfd5e43d96a****
&Region=cn-china
&User=testUser
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetQueryOptimizeDataStatsResponse>
<Code>200</Code>
<Message>Successful</Message>
<Data>
<Total>10</Total>
<Extra>None</Extra>
<List>
<InstanceId>rm-2ze8g2am97624****</InstanceId>
<Dbname>testdb01</Dbname>
<SqlId>2e8147b5ca2dfc640dfd5e43d96a****</SqlId>
<SqlType>INSERT</SqlType>
<Psql>select 1</Psql>
<SqlSample>select 2</SqlSample>
<Count>100</Count>
<MaxQueryTime>1.1</MaxQueryTime>
<AvgQueryTime>1.1</AvgQueryTime>
<MaxLockTime>0.1</MaxLockTime>
<AvgLockTime>0.1</AvgLockTime>
<MaxRowsExamined>100000</MaxRowsExamined>
<AvgRowsExamined>100.1</AvgRowsExamined>
<MaxRowsSent>10000</MaxRowsSent>
<AvgRowsSent>100.1</AvgRowsSent>
<MaxRowsAffected>10000</MaxRowsAffected>
<AvgRowsAffected>100.1</AvgRowsAffected>
<RuleList>
<Name>DAS_NOT_IMPORTANT</Name>
<Type>Predefined</Type>
</RuleList>
</List>
</Data>
<RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
<Success>true</Success>
</GetQueryOptimizeDataStatsResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Code" : "200",
"Message" : "Successful",
"Data" : {
"Total" : 10,
"Extra" : "None",
"List" : [ {
"InstanceId" : "rm-2ze8g2am97624****",
"Dbname" : "testdb01",
"SqlId" : "2e8147b5ca2dfc640dfd5e43d96a****",
"SqlType" : "INSERT",
"Psql" : "select 1",
"SqlSample" : "select 2",
"Count" : 100,
"MaxQueryTime" : 1.1,
"AvgQueryTime" : 1.1,
"MaxLockTime" : 0.1,
"AvgLockTime" : 0.1,
"MaxRowsExamined" : 100000,
"AvgRowsExamined" : 100.1,
"MaxRowsSent" : 10000,
"AvgRowsSent" : 100.1,
"MaxRowsAffected" : 10000,
"AvgRowsAffected" : 100.1,
"RuleList" : [ {
"Name" : "DAS_NOT_IMPORTANT",
"Type" : "Predefined"
} ]
} ]
},
"RequestId" : "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success" : "true"
}
错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
访问错误中心查看更多错误码。