DescribeBackupJobs2 - Cloud Backup: Central de Documentação do Alibaba Cloud

Consulta os trabalhos de backup que atendem aos critérios especificados.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hbr:DescribeBackupJobs2

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página. As páginas começam a partir da página 1. O valor padrão é 1.	1
PageSize	integer	Não	O número de entradas por página. Valores válidos: 1 a 99. O valor padrão é 10.	10
SourceType	string	Não	O tipo da fonte de dados. Valores válidos: ECS_FILE: Faz backup de arquivos do Elastic Compute Service (ECS). OSS: Faz backup de buckets do Alibaba Cloud Object Storage Service (OSS). NAS: Faz backup de sistemas de arquivos do Alibaba Cloud Apsara File Storage NAS (NAS). OTS: Faz backup de instâncias do Alibaba Cloud Tablestore. UDM_ECS: Faz backup de instâncias ECS inteiras. UDM_ECS_DISK: Uma subtarefa para backup de disco em um trabalho de backup de instância ECS. COMMON_NAS: Uma fonte de dados NAS genérica. Isso inclui fontes de dados de NAS de arquivamento e NAS local. Use o parâmetro Values de Filters para especificar o tipo de fonte de dados. File: Faz backup de arquivos locais. SYNC: Sincronização de dados.	ECS_FILE
SortDirection	string	Não	A direção de classificação. Valores válidos: ASCEND: Ordem crescente. DESCEND (Padrão): Ordem decrescente.	DESCEND
Filters	array<object>	Não	Os pares chave-valor do filtro.
	object	Não	O filtro.
Key	string	Não	A chave do filtro. Valores válidos: RegionId: O ID da região. PlanId: O ID do plano de backup. JobId: O ID do trabalho de backup. VaultId: O ID do repositório. InstanceId: O ID da instância ECS. Bucket: O nome do bucket do OSS. FileSystemId: O ID do sistema de arquivos. Status: O status do trabalho. CreatedTime: A hora de início do trabalho. CompleteTime: A hora de término do trabalho. InstanceName: O nome da instância do Tablestore. BackupType: O tipo de backup. Este parâmetro é necessário apenas quando SourceType está definido como COMMON_NAS. ParentId: O ID do trabalho pai. Este parâmetro é necessário ao consultar subtarefas. Por exemplo, se você definir SourceType como UDM_ECS_DISK, deverá especificar o ID do trabalho UDM_ECS.	VaultId
Values	array	Não	O valor do filtro.
	string	Não	O valor do filtro. COMPLETE: Backup de NAS local. 0: ARCHIVE: Fonte de dados de NAS de arquivamento. 1: ARCHIVE_BY_SEARCH: Fonte de dados de NAS de arquivamento.	COMPLETE
Operator	string	Não	O operador de correspondência. O valor padrão é IN. Este parâmetro especifica o operador a ser usado para corresponder a Key e Value. Valores válidos: EQUAL: Igual a. NOT_EQUAL: Diferente de. GREATER_THAN: Maior que. GREATER_THAN_OR_EQUAL: Maior ou igual a. LESS_THAN: Menor que. LESS_THAN_OR_EQUAL: Menor ou igual a. BETWEEN: O valor é uma matriz JSON no formato `[start,end]`. IN: O valor é uma matriz. Nota O operador IN não é suportado quando você usa CompleteTime como chave para uma consulta.	IN
Edition	string	Não	A edição. Valores válidos: BASIC e STANDARD. O valor padrão é STANDARD.	STANDARD

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Code	string	O código de retorno. Um valor 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, successful será retornado. Se a solicitação falhar, uma mensagem de erro será retornada.	successful
PageNumber	integer	O número da página. As páginas começam a partir da página 1. O valor padrão é 1.	1
PageSize	integer	O número de entradas por página. Valores válidos: 1 a 99. O valor padrão é 10.	10
TotalCount	integer	O número total de trabalhos de backup que atendem aos critérios especificados.	8
BackupJobs	object
BackupJob	array<object>	A lista de trabalhos de backup que atendem aos critérios especificados.
	array<object>	Os detalhes do trabalho de backup.
Status	string	The status of the backup job. Valid values: COMPLETE: The job is successful. PARTIAL_COMPLETE: The job is partially successful. FAILED: The job failed.	COMPLETE
ErrorMessage	string	The error message for the backup job.	PARTIAL_COMPLETE
ActualItems	integer	This parameter is valid only when SourceType is set to ECS_FILE. It indicates the actual number of items in the backup job.	6
VaultId	string	The ID of the backup repository.	v-0006******q
ActualBytes	integer	The actual data volume of the backup job after deduplication. Unit: bytes.	600
CreateTime	integer	This parameter is valid only when SourceType is set to NAS. It indicates the time when the file system was created. This value is a UNIX timestamp. Unit: seconds.	1607436917
BackupType	string	The backup type. The value COMPLETE indicates a full backup.	COMPLETE
Prefix	string	This parameter is valid only when SourceType is set to OSS. It indicates the prefix of the backup object.	example/
SourceType	string	The type of the data source. Valid values: ECS_FILE: Backs up ECS files. OSS: Backs up Alibaba Cloud OSS buckets. NAS: Backs up Alibaba Cloud NAS file systems.	ECS_FILE
Options	string	This parameter is required only when SourceType is set to ECS_FILE. It indicates whether to use Volume Shadow Copy Service (VSS) to define the backup path. This feature is available only for Windows ECS instances. If data in the backup source is changed, set this parameter to `{"UseVSS":true}` to ensure data consistency between the backup and the source. After you enable VSS, you cannot back up multiple file directories at the same time.	{"UseVSS":false}
ClientId	string	This parameter is valid only when SourceType is set to ECS_FILE. It indicates the ID of the backup client.	c-*********************
ItemsDone	integer	This parameter is valid only when SourceType is set to ECS_FILE. It indicates the number of backup items.	8
BytesTotal	integer	The total data volume of the data source. Unit: bytes.	1000
Exclude	string	This parameter is required only when SourceType is set to ECS_FILE. It indicates the path to files that do not need to be backed up. All files in this path are excluded. The path can be up to 255 characters long.	["/var", "/proc"]
JobName	string	The name of the backup job.	jobname
CompleteTime	integer	The time when the backup job was completed. This value is a UNIX timestamp. Unit: seconds.	1554347313
CreatedTime	integer	The time when the backup job was created. This value is a UNIX timestamp. Unit: seconds.	1554347313
Bucket	string	This parameter is valid only when SourceType is set to OSS. It indicates the name of the OSS bucket.	hbr-backup-oss
Progress	integer	The backup progress. The value is calculated as 100% × 100.	10000
SpeedLimit	string	This parameter is required only when SourceType is set to ECS_FILE. It indicates the traffic shaping settings for the backup. The format is `{start}\|{end}\|{bandwidth}`. Use the `\|` character to separate multiple traffic shaping configurations. The time ranges of the configurations cannot overlap. start: The start hour. end: The end hour. bandwidth: The throttling speed. Unit: KB/s.	0:24:5120
InstanceId	string	This parameter is valid only when SourceType is set to NAS. It indicates the ECS instance ID.	i-*********************
PlanId	string	The backup plan ID.	plan-20********35
FileSystemId	string	This parameter is valid only when SourceType is set to NAS. It indicates the file system ID.	005494
StartTime	integer	The time when the backup job started. This value is a UNIX timestamp. Unit: seconds.	1554347313
UpdatedTime	integer	The time when the backup job was updated. This value is a UNIX timestamp. Unit: seconds.	1554347313
JobId	string	The backup job ID.	job-000g********w7
ItemsTotal	integer	This parameter is valid only when SourceType is set to ECS_FILE. It indicates the total number of items in the data source.	10
Include	string	The source paths included in the backup job.	["/home/alice/.pdf", "/home/bob/.txt"]
BytesDone	integer	The data volume of the incremental backup. Unit: bytes.	800
Paths	object
Path	array	The source path of the backup.
	string	The source path.	"/home"
Detail	object	The details of the ECS instance backup job.
DoCopy	boolean	Indicates whether a remote replication is performed.	true
DestinationNativeSnapshotId	string	The ID of the remote replication snapshot.	s-******************
DestinationNativeSnapshotProgress	integer	The progress of the remote replication.	85
DestinationNativeSnapshotStatus	string	The status of the remote replication.	COMPLETE
DestinationRetention	integer	The retention period of the remote replication backup.	30
DestinationSnapshotId	string	The ID of the remote replication backup.	s-******************
DestinationNativeSnapshotErrorMessage	string	The error message for the failed remote replication.	ECS.CreatingSnapshot
NativeSnapshotId	string	The snapshot ID.	s-******************
DiskNativeSnapshotIdList	object
DiskNativeSnapshotId	array	The mapping between snapshots and disks.
	string	The snapshot ID.	s-******************
InstanceInfos	object	The information about the ECS instance, including the instance name and instance type.	{ "i-xxxxxxxx": { "hostName": "test", "instanceName": "test", "instanceType": "ecs.c7.xlarge", "osType": "linux", "diskIds": [ "d-xxxxxxxx01", "d-xxxxxxxx02" ], "osNameEn": "Rocky Linux 8.8 64 bit", "osName": "Rocky Linux 8.8 64position", "platform": "Rocky Linux" } }
InstanceName	string	The name of the Tablestore instance.	instancename
OtsDetail	object	The details of the Tablestore instance.
TableNames	object
TableName	array	The list of data table names in the Tablestore instance.
	string	The name of a data table in the Tablestore instance.	["table1", "table2", "table3"]
Speed	integer	The actual average backup speed. Unit: KB/s.	500
TableName	string	The name of the data table in the Tablestore instance.	table1
CrossAccountType	string	The type of the cross-account backup. Valid values: SELF_ACCOUNT: Backs up data within the same account. CROSS_ACCOUNT: Backs up data across accounts.	SELF_ACCOUNT
CrossAccountUserId	integer	The ID of the source account that is managed by the current account for cross-account backup.	158975xxxxx4625
CrossAccountRoleName	string	The name of the RAM role that is created in the source account for cross-account backup and managed by the current account.	BackupRole
Report	object	The job report.
TotalFiles	string	The list of all files. This parameter is not returned for data synchronization.	/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv
SuccessFiles	string	The list of successful files.	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip
FailedFiles	string	The list of failed files.	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip
SkippedFiles	string	The list of skipped files.	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip
ReportTaskStatus	string	The status of report generation.	COMPLETE
Identifier	string	This parameter is returned only when SourceType is set to CONTAINER. It indicates the ID of the cluster that is backed up by the container backup job. If the cluster is a Container Service for Kubernetes (ACK) cluster, this parameter indicates the ACK cluster ID.	c83**************************b76
DestSourceType	string	The type of the destination data source. This parameter is required only for synchronization.	OSS
DestDataSourceId	string	The ID of the destination data source. This parameter is required only for synchronization.	ds-000cov4ufudxklj24zdk
DestDataSourceDetail	string	The details of the destination data source. This parameter is required only for synchronization.	{\"prefix\":\"/\"}
ChangeListPath	string	The configuration of the incremental file synchronization list. This parameter is required only for synchronization.	{"dataSourceId": "ds-123456789", "path": "/changelist"}
FilesTotal	integer	The total number of files to be processed.	10
FilesDone	integer	The number of processed files.	9
ActualFiles	integer	The actual number of processed files.	8
TriggerMode	string

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "BackupJobs": {
    "BackupJob": [
      {
        "Status": "COMPLETE",
        "ErrorMessage": "PARTIAL_COMPLETE",
        "ActualItems": 6,
        "VaultId": "v-0006******q",
        "ActualBytes": 600,
        "CreateTime": 1607436917,
        "BackupType": "COMPLETE",
        "Prefix": "example/",
        "SourceType": "ECS_FILE",
        "Options": "{\"UseVSS\":false}",
        "ClientId": "c-*********************",
        "ItemsDone": 8,
        "BytesTotal": 1000,
        "Exclude": "[\"/var\", \"/proc\"]",
        "JobName": "jobname",
        "CompleteTime": 1554347313,
        "CreatedTime": 1554347313,
        "Bucket": "hbr-backup-oss",
        "Progress": 10000,
        "SpeedLimit": "0:24:5120",
        "InstanceId": "i-*********************",
        "PlanId": "plan-20********35",
        "FileSystemId": "005494",
        "StartTime": 1554347313,
        "UpdatedTime": 1554347313,
        "JobId": "job-000g********w7",
        "ItemsTotal": 10,
        "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
        "BytesDone": 800,
        "Paths": {
          "Path": [
            "\"/home\""
          ]
        },
        "Detail": {
          "DoCopy": true,
          "DestinationNativeSnapshotId": "s-******************",
          "DestinationNativeSnapshotProgress": 85,
          "DestinationNativeSnapshotStatus": "COMPLETE",
          "DestinationRetention": 30,
          "DestinationSnapshotId": "s-******************",
          "DestinationNativeSnapshotErrorMessage": "ECS.CreatingSnapshot",
          "NativeSnapshotId": "s-******************",
          "DiskNativeSnapshotIdList": {
            "DiskNativeSnapshotId": [
              "s-******************"
            ]
          },
          "InstanceInfos": {
            "test": "test",
            "test2": 1
          }
        },
        "InstanceName": "instancename",
        "OtsDetail": {
          "TableNames": {
            "TableName": [
              "[\"table1\", \"table2\", \"table3\"]"
            ]
          }
        },
        "Speed": 500,
        "TableName": "table1",
        "CrossAccountType": "SELF_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "BackupRole",
        "Report": {
          "TotalFiles": "/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv",
          "SuccessFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip",
          "FailedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip",
          "SkippedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip",
          "ReportTaskStatus": "COMPLETE"
        },
        "Identifier": "c83**************************b76",
        "DestSourceType": "OSS",
        "DestDataSourceId": "ds-000cov4ufudxklj24zdk",
        "DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
        "ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
        "FilesTotal": 10,
        "FilesDone": 9,
        "ActualFiles": 8,
        "TriggerMode": ""
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.