Obtenha cópias de segurança da localização de backup

Obtém a lista de cópias de segurança disponíveis para a entidade de backup especificada no local de backup especificado.

Obtém a lista de cópias de segurança disponíveis para a entidade de apoio especificado (Aplicação, Serviço ou Partição) no local de backup especificado (FileShare ou Azure Blob Storage).

Pedir

Método URI do pedido
POST /BackupRestore/$/GetBackups?api-version=6.4&timeout={timeout}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}

Parâmetros

Nome Tipo Necessário Localização
api-version string Sim Consulta
timeout inteiro (int64) No Consulta
ContinuationToken cadeia (de carateres) No Consulta
MaxResults inteiro (int64) No Consulta
GetBackupByStorageQueryDescription GetBackupByStorageQueryDescription Yes Corpo

api-version

Tipo: corda
Obrigatório: Sim
Predefinição:6.4

A versão da API. Este parâmetro é necessário e o seu valor deve ser '6.4'.

A versão API do Service Fabric REST baseia-se na versão de tempo de execução em que a API foi introduzida ou foi alterada. O tempo de funcionação do Tecido de Serviço suporta mais de uma versão da API. Esta versão é a mais recente versão suportada da API. Se uma versão API mais baixa for aprovada, a resposta devolvida pode ser diferente da documentada nesta especificação.

Além disso, o tempo de execução aceita qualquer versão que seja superior à versão mais recente suportada até à versão atual do tempo de execução. Assim, se a versão mais recente da API for 6.0 e o tempo de execução for 6.1, o tempo de execução aceitará a versão 6.1 para a API. No entanto, o comportamento da API será conforme a versão 6.0 documentada.


timeout

Tipo: inteiro (int64)
Obrigatório: Não
Predefinição:60
InclusiveMaximum:4294967295
InclusiveMinimum:1

O tempo limite do servidor para a realização da operação em segundos. Este prazo estipula a duração que o cliente está disposto a esperar pela conclusão da operação solicitada. O valor predefinido para este parâmetro é de 60 segundos.


ContinuationToken

Tipo: corda
Obrigatório: Não

O parâmetro de token de continuação é usado para obter o próximo conjunto de resultados. Um token de continuação com um valor não vazio é incluído na resposta da API quando os resultados do sistema não se enquadram numa única resposta. Quando este valor é passado para a próxima chamada da API, a API devolve o próximo conjunto de resultados. Se não houver mais resultados, então o token de continuação não contém um valor. O valor deste parâmetro não deve ser codificado por URL.


MaxResults

Tipo: inteiro (int64)
Obrigatório: Não
Predefinição:0
InclusiveMinimum:0

O número máximo de resultados a devolver como parte das consultas de página. Este parâmetro define o limite superior no número de resultados devolvidos. Os resultados devolvidos podem ser inferiores aos resultados máximos especificados se não encaixarem na mensagem de acordo com as restrições máximas do tamanho da mensagem definidas na configuração. Se este parâmetro for zero ou não especificado, a consulta paged inclui o maior número possível de resultados que se encaixam na mensagem de retorno.


GetBackupByStorageQueryDescription

Tipo: GetBackupByStorageQueryDescription
Obrigatório: Sim

Descreve os filtros e os detalhes de armazenamento de backup a serem utilizados para enumerar cópias de segurança.

Respostas

Código de Estado HTTP Descrição Esquema de Resposta
200 (OK) Uma operação bem sucedida devolverá 200 códigos de estado e uma lista de informações de backup.
PagedBackupInfoList
Todos os outros códigos de estado A resposta detalhada ao erro.
FabricError

Exemplos

Limitar os resultados máximos

Este exemplo mostra como obter a lista de cópias de segurança de aplicações a partir de uma localização de backup especificada. O número de resultados numa página é limitado ao máximo de dois utilizando o parâmetro MaxResult.

Pedir

POST http://localhost:19080/BackupRestore/$/GetBackups?api-version=6.4&MaxResults=2
Corpo
{
  "Storage": {
    "StorageKind": "AzureBlobStore",
    "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
    "ContainerName": "BackupContainer"
  },
  "BackupEntity": {
    "EntityKind": "Application",
    "ApplicationName": "fabric:/CalcApp"
  }
}

200 Resposta

Corpo
{
  "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
  "Items": [
    {
      "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
      },
      "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
      "BackupType": "Full",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "261",
      "CreationTimeUtc": "2018-01-01T09:00:55Z",
      "FailureError": null
    },
    {
      "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
      "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
      },
      "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
      "BackupType": "Incremental",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "446",
      "CreationTimeUtc": "2018-01-01T17:01:02Z",
      "FailureError": null
    }
  ]
}

Página usando token de continuação

Este exemplo mostra como obter a lista de backups de aplicações. O número de resultados numa página é limitado ao máximo de dois utilizando o parâmetro MaxResult. Este exemplo utiliza o parâmetro ContinuationToken. O valor deste parâmetro é fornecido a partir da consulta anterior; neste caso, o exemplo acima mostrado. A resposta contém os resultados restantes e uma ContinuationToken vazia. O Vazio ContinuationToken indica que os resultados adicionais não estão disponíveis.

Pedir

POST http://localhost:19080/BackupRestore/$/GetBackups?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd&MaxResults=2
Corpo
{
  "Storage": {
    "StorageKind": "AzureBlobStore",
    "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
    "ContainerName": "BackupContainer"
  },
  "BackupEntity": {
    "EntityKind": "Application",
    "ApplicationName": "fabric:/CalcApp"
  }
}

200 Resposta

Corpo
{
  "ContinuationToken": "",
  "Items": [
    {
      "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
      },
      "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
      "BackupType": "Full",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "161",
      "CreationTimeUtc": "2018-01-01T09:01:02Z",
      "FailureError": null
    },
    {
      "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
      "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
      },
      "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
      "BackupType": "Incremental",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "246",
      "CreationTimeUtc": "2018-01-01T17:00:34Z",
      "FailureError": null
    }
  ]
}