DescribeBackupTasks - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

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

dds:DescribeBackupTasks

none

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia.	dds-2zeb2d64cb46xxxx
BackupJobId	string	No	El ID del trabajo de respaldo. Nota Si llama a CreateBackup para realizar un respaldo manual, puede pasar el ID de respaldo devuelto para consultar el progreso del respaldo.	170034

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.
RequestId	string	El ID de la solicitud.	D648B367-15B6-1B42-BD4B-47507C9CC****
BackupJobs	array<object>	Los detalles de los trabajos de respaldo.
	object	Los detalles del trabajo de respaldo.
BackupjobId	string	El ID del trabajo de respaldo.	170034
BackupSetStatus	string	El estado del trabajo de respaldo. Scheduled: El trabajo de respaldo está programado. Esto incluye trabajos de respaldo regulares que no han comenzado. Checking: La instancia se está verificando antes del respaldo. Backuping: El respaldo está en curso. Finished: El respaldo ha finalizado.	Scheduled
BackupStartTime	string	La hora de inicio del respaldo.	2024-01-16T11:04:56Z
Progress	string	El progreso del respaldo en porcentaje. El progreso se muestra solo para los trabajos de respaldo en ejecución.	18%
JobMode	string	El modo de respaldo. Valores válidos: Automated: respaldo automático. Manual: respaldo manual.	Manual

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "D648B367-15B6-1B42-BD4B-47507C9CC****",
  "BackupJobs": [
    {
      "BackupjobId": "170034\n",
      "BackupSetStatus": "Scheduled",
      "BackupStartTime": "2024-01-16T11:04:56Z",
      "Progress": "18%",
      "JobMode": "Manual"
    }
  ]
}

Códigos de error

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.