GetQueryOptimizeShareUrl-阿里云帮助中心

Retrieves the share URL for Query Governance.

Operation description

Use the latest version of the Alibaba Cloud or DAS SDK.
Specify cn-shanghai as the region when calling DAS by using the SDK.
This operation is applicable to the following database engines:
- RDS MySQL
- PolarDB for MySQL
- RDS PostgreSQL

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:GetQueryOptimizeShareUrl

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Engine	string	Yes	The database engine. Valid values: MySQL: RDS MySQL PolarDBMySQL: PolarDB for MySQL PostgreSQL: RDS PostgreSQL	MySQL
InstanceIds	string	No	The instance IDs. Separate multiple instance IDs with commas.	rm-2ze1jdv45i7l6****
TagNames	string	No	The reserved parameter.	None
Keywords	string	No	The keywords in the SQL text. Separate multiple keywords with spaces.	select update
LogicalOperator	string	No	The logical relationship between multiple keywords in the SQL text. Valid values: or: The OR logical relationship. and: The AND logical relationship.	or
Rules	string	No	The rules to be filtered. Separate multiple rules with commas. For more information, see Query Governance.	DAS_NOT_IMPORTANT
DbNames	string	No	The names of the databases to be queried.	testdb01
Time	integer	Yes	The date when the data is queried. The value is a UNIX timestamp in milliseconds.	1642953600000
PageSize	integer	No	The maximum number of records per page in a paging query. Default value: 10.	10
PageNo	integer	No	The page number of the paging query. Pages start from 1. Default value: 1.	1
OrderBy	string	No	The field by which to sort the results. Default value: count. Valid values: count: The number of executions. maxQueryTime: The maximum execution time. avgQueryTime: The average execution time. maxLockTime: The maximum lock wait time. avgLockTime: The average lock wait time. maxRowsExamined: The maximum number of scanned rows. avgRowsExamined: The average number of scanned rows. maxRowsSent: The maximum number of returned rows. avgRowsSent: The average number of returned rows.	count
Asc	boolean	No	Specifies whether to sort the results in ascending order. Default value: true. Valid values: true: Yes. false: No.	true
OnlyOptimizedSql	boolean	No	Specifies whether to query only the SQL statements that need to be optimized. Default value: false. Valid values: true: Yes. false: No.	true
SqlIds	string	No	The SQL template IDs. You can call the GetQueryOptimizeDataStats operation to query the SQL template IDs.	6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0****
Region	string	No	The region where the instance resides. Valid values: cn-china: The Chinese mainland. cn-hongkong: Hong Kong (China). ap-southeast-1: Singapore. This parameter is valid only when the InstanceIds request parameter is empty. If the InstanceIds request parameter is empty, data is retrieved based on the region specified by the Region parameter, and the default region is cn-china. If the InstanceIds request parameter is not empty, data is retrieved based on the region of the first instance specified in InstanceIds, regardless of the value of the Region parameter. Note For instances created in regions in the Chinese mainland, set this parameter to cn-china.	cn-china
User	string	No	The database account to be queried.	testUser

Response elements

Element	Type	Description	Example
	object
Code	string	The returned status code.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
RequestId	string	The unique identifier generated by Alibaba Cloud for the request.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	string	The share URL.	https://hdm.console.aliyun.com/#/queryOptimize****

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": "https://hdm.console.aliyun.com/#/queryOptimize****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permission to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.