DescribeDataBackupSet - ApsaraDB for OceanBase (Deprecated) - Centro de documentación de Alibaba Cloud

Consulta la información de los conjuntos de respaldo de un clúster de OceanBase.

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

oceanbase:DescribeDataBackupSet

none

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID del clúster de OceanBase.	ob317v4uif****
Status	string	No	El estado de los conjuntos de respaldo que se van a consultar.	DONE
BackupObjectType	string	No	El tipo de objeto de los conjuntos de respaldo que se van a consultar.	tenant
StartTime	string	No	La hora de inicio del respaldo, en formato yyyy-MM-dd T HH:mm:ss Z (hora UTC).	2022-12-27T16:00:00Z
EndTime	string	No	La hora de finalización del respaldo.	2023-01-06T15:59:59Z
PageNumber	integer	No	El número de página, que surte efecto en una consulta paginada.	1
PageSize	integer	No	El número de filas que se devolverán en cada página. Valor máximo: 100. Valor predeterminado: 10.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El resultado devuelto por la solicitud.
TotalCount	integer	El recuento total.	2
RequestId	string	El ID de la solicitud.	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	array<object>	Los datos devueltos.
	array<object>	Los detalles de los conjuntos de respaldo.
EndTime	string	La hora de finalización del respaldo.	2023-04-13T03:38:10Z
Status	string	El estado del conjunto de respaldo.	RUNNING
Type	string	El tipo de respaldo.	manual
StartTime	string	La hora de inicio del respaldo.	2020-05-22T17:04:18
DataSize	integer	El tamaño del conjunto de respaldo.	31457280
Policy	string	La estrategia de respaldo.	automated
SetId	string	El ID del conjunto de respaldo.	imm-test-set-cb**ee-b7d7-11ed-956f-**3e10bd70
Method	string	El método de respaldo.	logical
Checkpoint	string	El punto de control.	2023-05-15T07:11:08Z
DataVersion	integer	La versión de los datos.	1678847020352
BackupObjectType	string	El tipo de objeto de respaldo.	cluster
BackupObjects	array<object>	Los objetos de respaldo.
	array<object>	Los detalles de los objetos de respaldo.
ClusterName	string	El nombre del clúster.	test-****way
TenantName	string	El nombre del inquilino.	ob2mr3oae0****
DatabaseTablesList	array<object>	Las bases de datos y tablas en el conjunto de respaldo.
	object	Los detalles de las bases de datos y tablas en el conjunto de respaldo.
Database	string	El nombre de la base de datos.	sms_pre
Tables	array	Las tablas.
	string	Los detalles de las tablas.	{'Tables': []}
BackupResults	array<object>	Los resultados del respaldo.
	array<object>	Los detalles de los resultados del respaldo.
ClusterName	string	El nombre del clúster.	container-opa-****-02
TenantName	string	El nombre del inquilino.	ob2mr3oae0****
TableBackupResults	array<object>	Los resultados del respaldo de tablas.
	object	Los detalles de los resultados del respaldo de tablas.
Database	string	El nombre de la base de datos.	order_ce****_online
Table	string	El nombre de la tabla.	tr_sale_order_****
Status	string	El estado del respaldo.	RUNNING
Message	string	La descripción del error.	Create tag success
DownloadTaskStatus	string	El estado de la tarea de descarga correspondiente al conjunto de respaldo de destino.	not_exist
DownloadTaskId	integer	El ID de la tarea de descarga correspondiente al conjunto de respaldo de destino.	100***012
Validity	string	La validez, que puede dejarse vacía.	VALID
Progress	string	El progreso del respaldo.	52
StorageClass	string	El tipo del conjunto de respaldo. Valores válidos: standard: respaldo de nivel 1 archive: segundo respaldo	standard

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalCount": 2,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "EndTime": "2023-04-13T03:38:10Z",
      "Status": "RUNNING",
      "Type": "manual",
      "StartTime": "2020-05-22T17:04:18",
      "DataSize": 31457280,
      "Policy": "automated",
      "SetId": "imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70",
      "Method": "logical",
      "Checkpoint": "2023-05-15T07:11:08Z",
      "DataVersion": 1678847020352,
      "BackupObjectType": "cluster",
      "BackupObjects": [
        {
          "ClusterName": "test-****way",
          "TenantName": "ob2mr3oae0****",
          "DatabaseTablesList": [
            {
              "Database": "sms_pre",
              "Tables": [
                "{'Tables': []}"
              ]
            }
          ]
        }
      ],
      "BackupResults": [
        {
          "ClusterName": "container-opa-****-02",
          "TenantName": "ob2mr3oae0****\n",
          "TableBackupResults": [
            {
              "Database": "order_ce****_online",
              "Table": "tr_sale_order_****",
              "Status": "RUNNING",
              "Message": "Create tag success"
            }
          ]
        }
      ],
      "DownloadTaskStatus": "not_exist",
      "DownloadTaskId": 0,
      "Validity": "VALID",
      "Progress": "52",
      "StorageClass": "standard"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
500	InternalError	The request processing has failed due to some unknown 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.