GetQueryOptimizeRuleList - Database Autonomy Service - Alibaba Cloud Documentation Center

Queries the tags added by the query governance feature to specified database instances.

Operation description

If you use Alibaba Cloud SDK, make sure that the aliyun-sdk-core version is later than V2.1.8. We recommend that you use the latest version.
The version of your Database Autonomy Service (DAS) SDK must be V2.1.8 or later.
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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:GetQueryOptimizeRuleList	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Engine	string	Yes	The database engine. Valid values: MySQL PolarDBMySQL PostgreSQL	MySQL
InstanceIds	string	No	The instance IDs. Separate multiple IDs with commas (,).	rm-2ze8g2am97624****
TagNames	string	No	A reserved parameter.	None
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

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code returned.	200
Message	string	The returned message.	Successful
Data	object	The detailed information.
Total	long	The total number of entries returned.	1
PageNo	integer	A reserved parameter.	None
PageSize	integer	A reserved parameter.	None
Extra	string	A reserved parameter.	None
List	object []	The information about tags.
Type	string	The type of the tag. Predefined is returned, which indicates that the tag is added by the system.	Predefined
Name	string	The name of the tag.	LARGE_ROWS_EXAMINED
RuleId	string	A reserved parameter.	None
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "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"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

Change history

Change time

Summary of changes

Operation

2023-03-29

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Region