GetQueryOptimizeShareUrl - Database Autonomy Service

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:GetQueryOptimizeShareUrl	get	All Resources ``	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	long	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 parameters

Parameter	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.aliyun.com/#/queryOptimize?Keywords=&OnlyOptimizedSql=true&Time=1684771200000&Engine=MySQL&InstanceIds=&Rules=&PageNo=1&PageSize=10&OrderBy=count&Asc=false&SqlIds=&dbNames=&region=cn-china&user=

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": "https://hdm.console.aliyun.com/#/queryOptimize?Keywords=&OnlyOptimizedSql=true&Time=1684771200000&Engine=MySQL&InstanceIds=&Rules=&PageNo=1&PageSize=10&OrderBy=count&Asc=false&SqlIds=&dbNames=&region=cn-china&user="
}

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

No change history