Compartilhar via

Obter backup de todas as entidades por política

  • Artigo

Obtém a lista de entidades de backup associadas a essa política.

Retorna uma lista de aplicativos, serviços ou partições do Service Fabric associados a essa política de backup.

Solicitação

Método URI da solicitação
GET /BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parâmetros

Nome Type Obrigatório Location
backupPolicyName string Sim Caminho
api-version string Sim Consulta
ContinuationToken string Não Consulta
MaxResults inteiro (int64) Não Consulta
timeout inteiro (int64) Não Consulta

backupPolicyName

Tipo: string
Obrigatório: sim

O nome da política de backup.

api-version

Tipo: string
Obrigatório: sim
Padrão: 6.4

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

A versão da API REST do Service Fabric baseia-se na versão de runtime na qual a API foi introduzida ou foi alterada. O runtime do Service Fabric dá suporte a mais de uma versão da API. Esta versão é a versão mais recente com suporte da API. Se uma versão inferior da API for passada, a resposta retornada poderá ser diferente daquela documentada nesta especificação.

Além disso, o runtime aceita qualquer versão que seja maior do que a versão mais recente com suporte até a versão atual do runtime. Portanto, se a versão mais recente da API for 6.0 e o runtime for 6.1, o runtime aceitará a versão 6.1 para essa API. No entanto, o comportamento da API será de acordo com a versão documentada 6.0.

ContinuationToken

Tipo: string
Obrigatório: não

O parâmetro do token de continuação é usado para obter o próximo conjunto de resultados. Um token de continuação com um valor não vazio será incluso na resposta da API quando os resultados do sistema não couberem em uma única resposta. Quando esse valor for passado para a próxima chamada de API, a API retornará o próximo conjunto de resultados. Se não houver mais resultados, o token de continuação não conterá um valor. O valor desse parâmetro não deve ser codificado em URL.

MaxResults

Tipo: inteiro (int64)
Obrigatório: não
Padrão: 0
InclusiveMinimum: 0

O número máximo de resultados a serem retornados como parte das consultas paginadas. Esse parâmetro define o limite superior no número de resultados retornados. Os resultados retornados podem ser inferiores aos resultados máximos especificados se não couberem na mensagem, de acordo com as restrições de tamanho máximo de mensagem definidas na configuração. Se esse parâmetro for zero, ou não for especificado, a consulta paginada incluirá o máximo de resultados possível na mensagem de retorno.

timeout

Tipo: inteiro (int64)
Obrigatório: não
Padrão: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Tempo limite do servidor para executar a operação em segundos. Especifica o tempo que o cliente está disposto a esperar para que operação solicitada seja concluída. O valor padrão desse parâmetro é 60 segundos.

Respostas

Código de status HTTP Descrição Esquema de Resposta
200 (OK) Uma operação bem-sucedida retornará 200 status código e uma lista paginada de entidades do Service Fabric associadas a essa política.
 PagedBackupEntityList
Todos os outros códigos de status A resposta de erro detalhada.
 FabricError

Exemplos

Limitar o máximo de resultados

Este exemplo mostra como obter a lista de entidades de backup que estão atualmente associadas a uma política de backup. O número de resultados em uma página é limitado ao máximo de dois usando o parâmetro MaxResult.

Solicitação

GET http://localhost:19080/BackupRestore/BackupPolicies/DailyAzureBackupPolicy/$/GetBackupEnabledEntities?api-version=6.4&MaxResults=2

Resposta 200

Corpo
{
  "ContinuationToken": "fabric:/DemoApp",
  "Items": [
    {
      "EntityKind": "Application",
      "ApplicationName": "fabric:/CalcApp"
    },
    {
      "EntityKind": "Application",
      "ApplicationName": "fabric:/DemoApp"
    }
  ]
}

Página usando token de continuação

Este exemplo mostra como obter a lista de entidades de backup que estão atualmente associadas a uma política de backup. Este exemplo usa o parâmetro ContinuationToken. O valor desse parâmetro é fornecido da consulta anterior; nesse caso, o exemplo mostrado acima. A resposta contém os resultados restantes e um ContinuationToken vazio. O ContinuationToken vazio indica que resultados adicionais não estão disponíveis.

Solicitação

GET http://localhost:19080/BackupRestore/BackupPolicies/DailyAzureBackupPolicy/$/GetBackupEnabledEntities?api-version=6.4&ContinuationToken=fabric:/DemoApp&MaxResults=2

Resposta 200

Corpo
{
  "ContinuationToken": "",
  "Items": [
    {
      "EntityKind": "Service",
      "ServiceName": "fabric:/VotingApp/VotingActorService"
    }
  ]
}