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

Consulta um ou mais trabalhos de backup que atendem às condições especificadas.

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

*Todos os recursos.

*

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 em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valores válidos: 1 a 99. Valor padrão: 10.	10
SourceType	string	Não	O tipo de fonte de dados. Valores válidos: ECS_FILE: arquivos do ECS OSS: Alibaba Cloud OSS NAS: Alibaba Cloud NAS OTS: Alibaba Cloud Tablestore UDM_ECS: instâncias do ECS UDM_ECS_DISK: nós filhos de backup de disco em nuvem para backup de instância do ECS COMMON_NAS: fontes de dados gerais do NAS, incluindo fontes de dados do NAS de arquivamento e fontes de dados do NAS local. Você deve usar o parâmetro Values de Filters para especificar o tipo de fonte de dados. File: File Backup local SYNC: sincronização de dados	ECS_FILE
SortDirection	string	Não	A ordem de classificação. Valores válidos: ASCEND: ordem crescente DESCEND (padrão): ordem decrescente	DESCEND
Filters	array<object>	Não	Os pares chave-valor no filtro de consulta.
	object	Não	O filtro de consulta.
Key	string	Não	A chave no filtro de consulta. 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 cofre InstanceId: o ID da instância do 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 trabalho de backup. Este parâmetro é necessário apenas quando SourceType é definido como COMMON_NAS. ParentId: o ID do trabalho pai. Este parâmetro é necessário ao consultar subtarefas. Por exemplo, se SourceType estiver definido como UDM_ECS_DISK, você deve especificar o ID de um trabalho UDM_ECS.	VaultId
Values	array	Não	Os valores da variável de filtro.
	string	Não	Os valores da variável de filtro. COMPLETE: backup de NAS local 0: ARCHIVE: fonte de dados do NAS de arquivamento 1: ARCHIVE_BY_SEARCH: fonte de dados do NAS de arquivamento	COMPLETE
Operator	string	Não	O modo de correspondência. Valor padrão: IN. O modo de correspondência especifica o operador usado para corresponder à chave e ao valor no filtro. 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: entre. O valor é um array JSON no formato [limite inferior, limite superior]. IN: em. O valor é um array. Nota Ao usar CompleteTime como chave, o operador IN não é suportado.	IN
Edition	string	Não	A edição. Valores válidos: BASIC e STANDARD. 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. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Code	string	O código da resposta. O valor 200 indica sucesso.	200
Message	string	A mensagem da resposta. Se a solicitação for bem-sucedida, "successful" será retornado. Se ocorrer um erro, a mensagem de erro correspondente será retornada.	successful
PageNumber	integer	O número da página. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	O número de entradas por página. Valores válidos: 1 a 99. Valor padrão: 10.	10
TotalCount	integer	O número total de trabalhos de backup que atendem às condições de consulta.	8
BackupJobs	object
BackupJob	array<object>	A lista de trabalhos de backup que atendem às condições de consulta.
	array<object>	Os detalhes do trabalho de backup.
Status	string	O status do trabalho de backup. Valores válidos: COMPLETE: O trabalho de backup foi bem-sucedido. PARTIAL_COMPLETE: O trabalho de backup foi parcialmente bem-sucedido. FAILED: O trabalho de backup falhou.	COMPLETE
ErrorMessage	string	A mensagem de erro do trabalho de backup.	PARTIAL_COMPLETE
ActualItems	integer	O número real de itens no trabalho de backup. Este parâmetro é válido apenas quando SourceType está definido como ECS_FILE.	6
VaultId	string	O ID do cofre de backup.	v-0006******q
ActualBytes	integer	A quantidade real de dados no trabalho de backup após a desduplicação. Unidade: bytes.	600
CreateTime	integer	A hora de criação do sistema de arquivos. Este parâmetro é válido apenas quando SourceType está definido como NAS. O horário é um carimbo de data e hora UNIX. Unidade: segundos.	1607436917
BackupType	string	O tipo de backup. O valor COMPLETE indica um backup completo.	COMPLETE
Prefix	string	O prefixo dos objetos de backup. Este parâmetro é válido apenas quando SourceType está definido como OSS.	example/
SourceType	string	O tipo da fonte de dados. Valores válidos: ECS_FILE: Arquivos ECS. OSS: Alibaba Cloud OSS. NAS: Alibaba Cloud NAS.	ECS_FILE
Options	string	Especifica se deve ser usado o Volume Shadow Copy Service (VSS) do Windows para definir o caminho de origem. Este parâmetro é necessário apenas quando SourceType está definido como ECS_FILE. Este recurso é suportado apenas para instâncias ECS Windows. Se os dados na origem do backup forem alterados e você precisar garantir a consistência dos dados entre os dados de backup e os dados de origem, defina este parâmetro como `["UseVSS":true]`. Após ativar o VSS, você não pode fazer backup de várias pastas ao mesmo tempo.	{"UseVSS":false}
ClientId	string	O ID do cliente de backup. Este parâmetro é válido apenas quando SourceType está definido como ECS_FILE.	c-*********************
ItemsDone	integer	O número de itens com backup realizado. Este parâmetro é válido apenas quando SourceType está definido como ECS_FILE.	8
BytesTotal	integer	A quantidade total de dados na fonte de dados. Unidade: bytes.	1000
Exclude	string	Os caminhos que não precisam de backup. Todos os arquivos nesses caminhos são excluídos do backup. Este parâmetro é necessário apenas quando SourceType está definido como ECS_FILE. O valor pode ter até 255 caracteres.	["/var", "/proc"]
JobName	string	O nome do trabalho de backup.	jobname
CompleteTime	integer	A hora de conclusão do trabalho de backup. O horário é um carimbo de data e hora UNIX. Unidade: segundos.	1554347313
CreatedTime	integer	A hora de criação do trabalho de backup. O horário é um carimbo de data e hora UNIX. Unidade: segundos.	1554347313
Bucket	string	O nome do bucket do OSS que passou por backup. Este parâmetro é válido apenas quando SourceType está definido como OSS.	hbr-backup-oss
Progress	integer	O progresso do backup. O valor é a porcentagem multiplicada por 100.	10000
SpeedLimit	string	O limitador de tráfego de backup. Este parâmetro é necessário apenas quando SourceType está definido como ECS_FILE. O formato é `{start}\|{end}\|{bandwidth}`. Separe várias configurações de limitação com barras verticais (`\|`). Os períodos de tempo nas configurações não podem se sobrepor. start: a hora de início. end: a hora de término. bandwidth: o limite de largura de banda. Unidade: KB/s.	0:24:5120
InstanceId	string	O ID da instância ECS. Este parâmetro é válido apenas quando SourceType está definido como NAS.	i-*********************
PlanId	string	O ID do plano de backup.	plan-20********35
FileSystemId	string	O ID do sistema de arquivos. Este parâmetro é válido apenas quando SourceType está definido como NAS.	005494
StartTime	integer	A hora de início do trabalho de backup. O horário é um carimbo de data e hora UNIX. Unidade: segundos.	1554347313
UpdatedTime	integer	A hora de atualização do trabalho de backup. O horário é um carimbo de data e hora UNIX. Unidade: segundos.	1554347313
JobId	string	O ID do trabalho de backup.	job-000g********w7
ItemsTotal	integer	O número total de itens na fonte de dados. Este parâmetro é válido apenas quando SourceType está definido como ECS_FILE.	10
Include	string	Os caminhos de backup incluídos no trabalho de backup.	["/home/alice/.pdf", "/home/bob/.txt"]
BytesDone	integer	A quantidade de dados no backup incremental. Unidade: bytes.	800
Paths	object
Path	array	O caminho de backup.
	string	O caminho de backup.	"/home"
Detail	object	Os detalhes do trabalho de backup da instância ECS.
DoCopy	boolean	Especifica se a replicação entre regiões é realizada.	true
DestinationNativeSnapshotId	string	O ID do snapshot de replicação entre regiões.	s-******************
DestinationNativeSnapshotProgress	integer	O progresso da replicação entre regiões.	85
DestinationNativeSnapshotStatus	string	O status da replicação entre regiões.	COMPLETE
DestinationRetention	integer	O período de retenção do backup de replicação entre regiões.	30
DestinationSnapshotId	string	O ID do backup de replicação entre regiões.	s-******************
DestinationNativeSnapshotErrorMessage	string	A mensagem de erro para falha na replicação entre regiões.	ECS.CreatingSnapshot
NativeSnapshotId	string	O ID do snapshot.	s-******************
DiskNativeSnapshotIdList	object
DiskNativeSnapshotId	array	O mapeamento entre snapshots e discos em nuvem.
	string	O ID do snapshot.	s-******************
InstanceInfos	object	As informações da instância ECS, incluindo o nome da instância e o tipo de instância.	{ "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 64-bit", "platform": "Rocky Linux" } }
InstanceName	string	O nome da instância do Tablestore.	instancename
OtsDetail	object	Os detalhes da instância do Tablestore.
TableNames	object
TableName	array	A lista de nomes de tabelas de dados na instância do Tablestore.
	string	O nome da tabela de dados na instância do Tablestore.	["table1", "table2", "table3"]
Speed	integer	A velocidade média real de backup. Unidade: KB/s.	500
TableName	string	O nome da tabela de dados na instância do Tablestore.	table1
CrossAccountType	string	O tipo de backup entre contas. Valores válidos: SELF_ACCOUNT: Backups dentro da conta atual. CROSS_ACCOUNT: Backups entre contas.	SELF_ACCOUNT
CrossAccountUserId	integer	O ID da conta original para o backup entre contas gerenciado pela conta atual.	158975xxxxx4625
CrossAccountRoleName	string	O nome da função criada no RAM da conta original para o backup entre contas gerenciado pela conta atual.	BackupRole
Report	object	O relatório do trabalho.
TotalFiles	string	A lista de todos os arquivos. Este campo não é retornado para sincronização de dados.	/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv
SuccessFiles	string	A lista de arquivos bem-sucedidos.	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip
FailedFiles	string	A lista de arquivos com falha.	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip
SkippedFiles	string	A lista de arquivos ignorados.	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip
ReportTaskStatus	string	O status de geração do relatório.	COMPLETE
Identifier	string	O identificador do cluster para o trabalho de backup de contêiner. Este campo é retornado apenas quando SourceType está definido como CONTAINER. Se o tipo de cluster for um cluster do Alibaba Cloud Container Service for Kubernetes, o valor será o ID do cluster Kubernetes.	c83**************************b76
DestSourceType	string	O tipo da fonte de dados de destino. Este parâmetro é necessário apenas para sincronização.	OSS
DestDataSourceId	string	O ID da fonte de dados de destino. Este parâmetro é necessário apenas para sincronização.	ds-000cov4ufudxklj24zdk
DestDataSourceDetail	string	Os detalhes da fonte de dados de destino. Este parâmetro é necessário apenas para sincronização.	{\"prefix\":\"/\"}
ChangeListPath	string	A configuração da lista de sincronização de arquivos incrementais. Este parâmetro é necessário apenas para sincronização.	{"dataSourceId": "ds-123456789", "path": "/changelist"}
FilesTotal	integer	O número total de arquivos a serem processados.	10
FilesDone	integer	O número de arquivos que foram processados.	9
ActualFiles	integer	O número real de arquivos processados.	8
TriggerMode	string	O modo de acionamento do trabalho de backup.	MANUAL

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": {
            "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 64位",
              "platform": "Rocky Linux"
            }
          }
        },
        "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": "MANUAL"
      }
    ]
  }
}

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.