Obtención de enlaces para descargar registros extendidos (RDS for SQL Server)
Función
Esta API se utiliza para obtener enlaces para descargar registros extendidos.
- Antes de invocar a una API, debe entender la API de Autenticación.
Restricciones
Esta API solo es compatible con RDS for SQL Server.
URI
- Descripción de parámetro
Tabla 1 Parámetros Parámetro
Obligatorio
Descripción
project_id
Sí
ID de proyecto de un tenant en una región.
Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
instance_id
Sí
ID de la instancia que se va a consultar.
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
file_name |
Sí |
String |
Nombre del archivo que se va a descargar. El valor no puede ser nulo ni vacío. Puede contener solo letras mayúsculas, minúsculas, dígitos y guiones bajos (_) y termina con .xel. Puede obtener el nombre de archivo de Consulta de registros extendidos (RDS for SQL Server). |
Solicitud de ejemplo
Obtener enlaces para descargar registros extendidos
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/xellog-download { "file_name":"sqlserver_xellog_name.xel" }
Respuesta
- Respuesta normal
Tabla 3 Parámetros Parámetro
Tipo
Descripción
list
List
Lista de enlaces para descargar registros extendidos. Para obtener más información, consulte Tabla 4.
count
Integer
Número de enlaces de registro extendidos.
Tabla 4 descripción de la estructura de datos del campo linkInfo Parámetro
Tipo
Descripción
file_name
String
Nombre del archivo generado para descargar.
status
String
Estado de generación del enlace.
- FINISH: Se ha generado el enlace de descarga.
- EXPORTING: Se está generando el archivo.
- FAILED: El archivo de registro no se puede preparar.
file_size
String
Tamaño del archivo en KB.
file_link
String
Enlace de descarga. Si el estado de generación de enlace es EXPORTING o FAILED, no se devuelve ningún valor.
create_at
String
Tiempo de generación.
update_at
String
Tiempo de actualización.
- Ejemplo de respuesta normal
Generación de enlaces para descargar registros extendidos
{ "list": [ { "file_name": "HkEngineEventFile_0_133337769850300000.xel", "status": "EXPORTING", "file_size": "0", "create_at": "2023-08-14T03:35:24+0000", "update_at": "2023-08-14T03:35:24+0000" } ], "count": 1 }
Enlaces para descargar registros extendidos obtenidos correctamente{ "list": [ { "file_name": "HkEngineEventFile_0_133337769850300000.xel", "status": "SUCCESS", "file_size": "0", "file_link": "https://obs.xxx:443/xxx-7a95af72c4d54a31ae0663263f0e35ea/6e22b18b43a74e4486264194f6e09f66_EL_HkEngineEventFile_0_133337769850300000.xel?xxx", "create_at": "2023-08-14T03:35:41+0000", "update_at": "2023-08-14T03:35:41+0000" } ], "count": 1 }
- Respuesta anormal
Para obtener más información, consulte Resultados de solicitud anormales.
Código de estado
- Normal
- Anormal
Para obtener más información, consulte Códigos de estado.
Código de error
Para obtener más información, consulte Códigos de error.