GetQueryOptimizeShareUrl - Database Autonomy Service - Centro de documentación de Alibaba Cloud

Consulta una URL para compartir proporcionada por la función de gobernanza de consultas.

Descripción de la operación

Si utiliza el SDK de Alibaba Cloud o el SDK de Database Autonomy Service (DAS) para llamar a esta operación, se recomienda que utilice la versión más reciente del SDK.
Si utiliza un SDK para llamar a operaciones de API de DAS, debe establecer el ID de región en cn-shanghai.
Esta operación admite los siguientes motores de base de datos:
- ApsaraDB RDS for MySQL
- PolarDB for MySQL
- ApsaraDB RDS for PostgreSQL

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

hdm:GetQueryOptimizeShareUrl

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Engine	string	Sí	El motor de base de datos. Valores válidos: MySQL: ApsaraDB RDS for MySQL PolarDBMySQL: PolarDB for MySQL PostgreSQL: ApsaraDB RDS for PostgreSQL	MySQL
InstanceIds	string	No	Los ID de las instancias. Separe varios ID con comas (,).	rm-2ze1jdv45i7l6****
TagNames	string	No	Un parámetro reservado.	None
Keywords	string	No	Las palabras clave de la plantilla SQL. Separe varias palabras clave con espacios.	select update
LogicalOperator	string	No	La relación lógica entre varias palabras clave. Valores válidos: or and	or
Rules	string	No	Las etiquetas que se utilizan para filtrar plantillas SQL. Separe varias etiquetas con comas (,). Para obtener más información, consulte Gobernanza de consultas.	DAS_NOT_IMPORTANT
DbNames	string	No	El nombre de la base de datos que se va a consultar.	testdb01
Time	integer	Sí	La fecha que se va a consultar. Establezca este parámetro en una marca de tiempo UNIX que represente el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC.	1642953600000
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10.	10
PageNo	integer	No	El número de página. Las páginas comienzan desde la página 1. Valor predeterminado: 1.	1
OrderBy	string	No	El campo por el cual ordenar las entradas devueltas. Valor predeterminado: count. Valores válidos: count: el número de ejecuciones. maxQueryTime: la duración de ejecución más larga. avgQueryTime: la duración promedio de ejecución. maxLockTime: la duración de espera de bloqueo más larga. avgLockTime: la duración promedio de espera de bloqueo. maxRowsExamined: el mayor número de filas examinadas. avgRowsExamined: el número promedio de filas examinadas. maxRowsSent: el mayor número de filas devueltas. avgRowsSent: el número promedio de filas devueltas.	count
Asc	boolean	No	Especifica si se deben ordenar las entradas devueltas en orden ascendente. Valor predeterminado: true. Valores válidos: true false	true
OnlyOptimizedSql	boolean	No	Especifica si se deben consultar solo las plantillas SQL que necesitan optimización. Valor predeterminado: false. Valores válidos: true false	true
SqlIds	string	No	Los ID de las plantillas SQL. Puede llamar a la operación GetQueryOptimizeExecErrorStats para obtener los ID de las plantillas SQL.	6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0****
Region	string	No	La región en la que reside la instancia. Valores válidos: cn-china: China continental cn-hongkong: China (Hong Kong) ap-southeast-1: Singapur Este parámetro solo surte efecto si InstanceIds se deja vacío. Si deja InstanceIds vacío, el sistema obtiene los datos de la región establecida por Region. De forma predeterminada, Region se establece en cn-china. Si especifica InstanceIds, Region no surte efecto y el sistema obtiene los datos de la región en la que reside la primera instancia especificada.** Nota Si sus instancias residen en regiones de China continental, establezca este parámetro en cn-china**.	cn-china
User	string	No	La cuenta de la base de datos que se va a consultar.	testUser

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
Code	string	El código de estado HTTP devuelto.	200
Message	string	El mensaje devuelto. Nota Si la solicitud fue exitosa, se devuelve Successful. Si la solicitud falló, se devuelve un mensaje de error que contiene información como un código de error.	Successful
RequestId	string	El ID de la solicitud.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indica si la solicitud fue exitosa. Valores válidos: true false	true
Data	string	La URL para compartir.	https://hdm.console.alibabacloud.com/#/queryOptimize****

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.