Todos os produtos
Search

Este produto

    Cloud Backup:SearchHistoricalSnapshots

    Central de documentação

    Cloud Backup:SearchHistoricalSnapshots

    Última atualização: Aug 27, 2026

    Obtém um ou mais snapshots de backup históricos 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:SearchHistoricalSnapshots

    get

    *Todos os recursos.

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    SourceType

    string

    Não

    O tipo da fonte de dados. Valores válidos:

    • ECS_FILE: snapshots de backup de arquivos ECS.

    • OSS: snapshots de backup do Alibaba Cloud OSS.

    • NAS: snapshots de backup do Alibaba Cloud NAS.

    ECS_FILE
    Query

    array

    Sim

    As condições de consulta. Exemplo de Query:

    [
  {
    "field": "VaultId",
    "value": "v-0003rf9m*****qx5",
    "operation": "MATCH_TERM"
  },
  {
    "field": "InstanceId",
    "value": "i-bp1i20zq2*****e9368m",
    "operation": "MATCH_TERM"
  },
  {
    "field": "PlanId",
    "value": "plan-0005vk*****gkd1iu4f",
    "operation": "MATCH_TERM"
  },
  {
    "field": "CompleteTime",
    "value": "1626769913",
    "operation": "GREATER_THAN_OR_EQUAL"
  }
]

    • Campos suportados:

      • VaultId: obrigatório. O ID do cofre.

      • InstanceId: obrigatório apenas quando SourceType=ECS_FILE. O ID da instância ECS.

      • Bucket: obrigatório apenas quando SourceType=OSS. O nome do bucket OSS.

      • FileSystemId: obrigatório apenas quando SourceType=NAS. O ID do sistema de arquivos NAS.

      • CreateTime: obrigatório apenas quando SourceType=NAS. A hora de criação do sistema de arquivos NAS.

      • CompleteTime: a hora em que o snapshot foi concluído.

      • PlanId: o ID do plano de backup.

    • Operações suportadas:

      • MATCH_TERM: correspondência exata.

      • 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: intervalo. O valor é uma matriz JSON [limite inferior, limite superior].

      • IN: no conjunto. O valor é uma matriz.

      • NOT_IN: não está no conjunto. O valor é uma matriz.

    [ { "field": "VaultId", "value": "v-0003rf9m17pap3ltpqx5", "operation": "MATCH_TERM" }, { "field": "InstanceId", "value": "i-bp1i20zq2wuzdie9368m", "operation": "MATCH_TERM" }, { "field": "PlanId", "value": "plan-0005vkqhpesqgkd1iu4f", "operation": "MATCH_TERM" }, { "field": "CompleteTime", "value": 1626769913, "operation": "GREATER_THAN_OR_EQUAL" } ]

    any

    Não

    As condições de consulta. Exemplo de Query:

    [
  {
    "field": "VaultId",
    "value": "v-0003rf9m*****qx5",
    "operation": "MATCH_TERM"
  },
  {
    "field": "InstanceId",
    "value": "i-bp1i20zq2*****e9368m",
    "operation": "MATCH_TERM"
  },
  {
    "field": "PlanId",
    "value": "plan-0005vk*****gkd1iu4f",
    "operation": "MATCH_TERM"
  },
  {
    "field": "CompleteTime",
    "value": "1626769913",
    "operation": "GREATER_THAN_OR_EQUAL"
  }
]

    • Campos suportados:

      • VaultId: obrigatório. O ID do cofre.

      • InstanceId: obrigatório apenas quando SourceType=ECS_FILE. O ID da instância ECS.

      • Bucket: obrigatório apenas quando SourceType=OSS. O nome do bucket OSS.

      • FileSystemId: obrigatório apenas quando SourceType=NAS. O ID do sistema de arquivos NAS.

      • CreateTime: obrigatório apenas quando SourceType=NAS. A hora de criação do sistema de arquivos NAS.

      • CompleteTime: a hora em que o snapshot foi concluído.

      • PlanId: o ID do plano de backup.

    • Operações suportadas:

      • MATCH_TERM: correspondência exata.

      • 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: intervalo. O valor é uma matriz JSON [limite inferior, limite superior].

      • IN: no conjunto. O valor é uma matriz.

      • NOT_IN: não está no conjunto. O valor é uma matriz.

    [ { "field": "VaultId", "value": "v-0003rf9m17pap3ltpqx5", "operation": "MATCH_TERM" }, { "field": "InstanceId", "value": "i-bp1i20zq2wuzdie9368m", "operation": "MATCH_TERM" }, { "field": "PlanId", "value": "plan-0005vkqhpesqgkd1iu4f", "operation": "MATCH_TERM" }, { "field": "CompleteTime", "value": 1626769913, "operation": "GREATER_THAN_OR_EQUAL" } ]
    Limit

    integer

    Não

    O número máximo de resultados a serem retornados para esta consulta. Se você quiser obter apenas a contagem de linhas sem os dados reais, defina limit=0 para não retornar nenhuma linha.

    10
    NextToken

    string

    Não

    O token necessário para recuperar a próxima página de snapshots.

    caeba0bbb2be03f84eb48b699f0a****
    SortBy

    string

    Não

    O campo usado para ordenação.

    CreatedTime
    Order

    string

    Não

    A ordem de classificação. Valor padrão: ASC.

    • ASC: ordem crescente.

    • DESC: ordem decrescente.

    ASC
    Edition

    string

    Não

    O tipo de edição. Valores válidos: BASIC e STANDARD. Valor padrão: STANDARD.

    BASIC

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    NextToken

    string

    O token necessário para recuperar a próxima página de snapshots.

    BE
    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
    Limit

    integer

    O número de snapshots históricos exibidos na página atual.

    10
    Code

    string

    O código de resposta. Um valor de 200 indica sucesso.

    200
    Message

    string

    A mensagem retornada. O valor "successful" é retornado para solicitações bem-sucedidas. Uma mensagem de erro é retornada para solicitações com falha.

    successful
    TotalCount

    integer

    O número total de snapshots que atendem às condições especificadas.

    20
    Snapshots

    object

    Snapshot

    array<object>

    A lista de snapshots históricos.

    array<object>

    Status

    string

    O status do trabalho de snapshot de backup. Valores válidos:

    • COMPLETE: Bem-sucedido.

    • PARTIAL_COMPLETE: Parcialmente bem-sucedido.

    • FAILED: Falhou.

    COMPLETE
    SnapshotHash

    string

    O valor de hash do snapshot.

    f2fe...
    VaultId

    string

    O ID do cofre que armazena o snapshot de backup.

    v-0003rf9m17pap3ltpqx5
    ActualItems

    integer

    O número real de itens no snapshot.

    Nota

    Atualmente disponível apenas para Backup de Arquivos.

    6
    BackupType

    string

    O tipo de backup. O valor é COMPLETE, que indica um backup completo.

    COMPLETE
    CreateTime

    integer

    Este parâmetro é válido apenas quando SourceType está definido como NAS. A hora de criação do sistema de arquivos. Este valor é um carimbo de data/hora UNIX. Unidade: segundos.

    1607436917
    ActualBytes

    integer

    O volume real de dados do snapshot após a desduplicação. Unidade: bytes.

    600
    SourceType

    string

    O tipo da fonte de dados. Valores válidos:

    • ECS_FILE: snapshots de backup de arquivos ECS.

    • OSS: snapshots de backup do Alibaba Cloud OSS.

    • NAS: snapshots de backup do Alibaba Cloud NAS.

    ECS_FILE
    Prefix

    string

    Este parâmetro é válido apenas quando SourceType está definido como OSS. O prefixo de backup.

    example/
    ClientId

    string

    Este parâmetro é válido apenas quando SourceType está definido como ECS_FILE. O ID do cliente de backup.

    c-*********************
    BytesTotal

    integer

    O volume total da fonte de dados. Unidade: bytes.

    1000
    ItemsDone

    integer

    O número de itens com backup realizado.

    Nota

    Atualmente disponível apenas para Backup de Arquivos.

    8
    CompleteTime

    integer

    A hora em que o snapshot de backup foi concluído. Este valor é um carimbo de data/hora UNIX. Unidade: segundos.

    1554347313
    Retention

    integer

    O período de retenção do snapshot de backup. Unidade: dias.

    7
    CreatedTime

    integer

    A hora em que o snapshot de backup foi criado. Este valor é um carimbo de data/hora UNIX. Unidade: segundos.

    1554347313
    Bucket

    string

    Este parâmetro é válido apenas quando SourceType está definido como OSS. O nome do bucket OSS.

    hbr-backup-oss
    ParentSnapshotHash

    string

    O valor de hash do snapshot de backup pai.

    f2fe..
    InstanceId

    string

    Este parâmetro é válido apenas quando SourceType está definido como ECS_FILE. O ID da instância ECS.

    i-*********************
    FileSystemId

    string

    Este parâmetro é válido apenas quando SourceType está definido como NAS. O ID do sistema de arquivos.

    005494
    ErrorFile

    string

    O arquivo que registra informações de falha de backup, incluindo informações sobre backups parcialmente concluídos.

    Item Error Message C:\data\app\service.dat Open: open \\?\C:\data\app\service.dat: The process cannot access the file because it is being used by another process
    StartTime

    integer

    A hora em que o snapshot começou. Este valor é um carimbo de data/hora UNIX. Unidade: segundos.

    1554347313
    UpdatedTime

    integer

    A hora em que o snapshot de backup foi atualizado pela última vez. Este valor é um carimbo de data/hora UNIX. Unidade: segundos.

    1554347313
    SnapshotId

    string

    O ID do snapshot de backup.

    s-*********************
    JobId

    string

    O ID do trabalho de backup.

    v-*********************
    Path

    string

    Este parâmetro é válido apenas quando SourceType está definido como ECS_FILE. O caminho do arquivo de backup.

    ["/home"]
    ItemsTotal

    integer

    O número total de itens na fonte de dados.

    Nota

    Atualmente disponível apenas para Backup de Arquivos.

    10
    BytesDone

    integer

    O volume de dados de backup incremental. Unidade: bytes.

    800
    Paths

    object

    Path

    array

    A lista de caminhos de arquivos de backup.

    "/home"

    string

    Este parâmetro é válido apenas quando SourceType está definido como NAS. O caminho do arquivo de backup.

    "/home"
    InstanceName

    string

    O nome da instância Tablestore.

    instancename
    TableName

    string

    O nome da tabela de dados na instância Tablestore.

    table2
    RangeStart

    integer

    A hora em que o trabalho de backup começou. Este valor é um carimbo de data/hora UNIX. Unidade: milissegundos.

    1642492553038
    RangeEnd

    integer

    A hora em que o trabalho de backup terminou. Este valor é um carimbo de data/hora UNIX. Unidade: milissegundos.

    1642521709966
    ExpireTime

    integer

    A hora em que o snapshot expira. Este valor é um carimbo de data/hora UNIX. Unidade: segundos.

    1640334062
    SourceSnapshotHash

    string

    O valor de hash do snapshot antes do arquivamento.

    qwer***
    SourceParentSnapshotHash

    string

    O valor de hash do snapshot pai antes do arquivamento.

    qwer***
    StorageClass

    string

    A classe de armazenamento. Valores válidos:

    • Standard: padrão.

    • Archive: arquivo.

    • ColdArchive: arquivo frio.

    STANDARD
    ArchiveTime

    integer

    A hora em que o snapshot foi arquivado.

    1640334062
    UseCommonNas

    boolean

    Indica se o NAS local é utilizado.

    false
    Include

    string

    Os caminhos de origem incluídos no trabalho de backup.

    [\"/test/example_cn-huhehaote_3.txt\", \"/test/example_cn-huhehaote_9.txt\", \"/test/example_cn-huhehaote_5.txt\", \"/test/example_cn-huhehaote_1.txt\", \"/test/example_cn-huhehaote_7.txt\"]
    Exclude

    string

    Os caminhos de origem excluídos do trabalho de backup.

    [\"/test/example_cn-hangzhou_7.txt\", \"/test/example_cn-hangzhou_1.txt\", \"/test/example_cn-hangzhou_3.txt\", \"/test/example_cn-hangzhou_9.txt\", \"/test/example_cn-hangzhou_6.txt\"]
    ProtectedDataSize

    integer

    O volume de dados de origem protegidos, em bytes. Quando SourceType=ECS_FILE, isso indica a capacidade do disco em nuvem protegido.

    42949672960

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "NextToken": "BE",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Limit": 10,
  "Code": "200",
  "Message": "successful",
  "TotalCount": 20,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "COMPLETE",
        "SnapshotHash": "f2fe...",
        "VaultId": "v-0003rf9m17pap3ltpqx5",
        "ActualItems": 6,
        "BackupType": "COMPLETE",
        "CreateTime": 1607436917,
        "ActualBytes": 600,
        "SourceType": "ECS_FILE",
        "Prefix": "example/",
        "ClientId": "c-*********************",
        "BytesTotal": 1000,
        "ItemsDone": 8,
        "CompleteTime": 1554347313,
        "Retention": 7,
        "CreatedTime": 1554347313,
        "Bucket": "hbr-backup-oss",
        "ParentSnapshotHash": "f2fe..",
        "InstanceId": "i-*********************",
        "FileSystemId": "005494",
        "ErrorFile": "Item\tError Message C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.3.558.0000.105\\Bin\\service.dat\tOpen: open \\\\?\\C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.3.558.0000.105\\Bin\\service.dat: The process cannot access the file because it is being used by another process. C:\\ProgramData\\McAfee\\Agent\\data\\InstallerFiles\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini\tOpen: open \\\\?\\C:\\ProgramData\\McAfee\\Agent\\data\\InstallerFiles\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini: Access is denied",
        "StartTime": 1554347313,
        "UpdatedTime": 1554347313,
        "SnapshotId": "s-*********************",
        "JobId": "v-*********************",
        "Path": "[\"/home\"]",
        "ItemsTotal": 10,
        "BytesDone": 800,
        "Paths": {
          "Path": [
            "\"/home\""
          ]
        },
        "InstanceName": "instancename",
        "TableName": "table2",
        "RangeStart": 1642492553038,
        "RangeEnd": 1642521709966,
        "ExpireTime": 1640334062,
        "SourceSnapshotHash": "qwer***",
        "SourceParentSnapshotHash": "qwer***",
        "StorageClass": "STANDARD",
        "ArchiveTime": 1640334062,
        "UseCommonNas": false,
        "Include": "[\\\"/test/example_cn-huhehaote_3.txt\\\", \\\"/test/example_cn-huhehaote_9.txt\\\", \\\"/test/example_cn-huhehaote_5.txt\\\", \\\"/test/example_cn-huhehaote_1.txt\\\", \\\"/test/example_cn-huhehaote_7.txt\\\"]",
        "Exclude": "[\\\"/test/example_cn-hangzhou_7.txt\\\", \\\"/test/example_cn-hangzhou_1.txt\\\", \\\"/test/example_cn-hangzhou_3.txt\\\", \\\"/test/example_cn-hangzhou_9.txt\\\", \\\"/test/example_cn-hangzhou_6.txt\\\"]",
        "ProtectedDataSize": 42949672960
      }
    ]
  }
}

    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.