Share via

Obter informações de configuração de backup de serviço

  • Artigo

Obtém as informações de configuração de backup de serviço do Service Fabric.

Obtém as informações de configuração de backup do Service Fabric para o serviço e as partições nesse serviço.

Solicitação

Método URI da solicitação
GET /Services/{serviceId}/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parâmetros

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

serviceId

Tipo: string
Obrigatório: sim

A identidade do serviço. Normalmente, essa ID é o nome completo do serviço sem o esquema de 'malha' do URI. A partir da versão 6.0, nomes hierárquicos são delimitados pelo caractere "~". Por exemplo, se o nome do serviço for "fabric:/myapp/app1/svc1", a identidade do serviço será "myapp~app1~svc1" na versão 6.0 e superiores e and "myapp/app1/svc1" em versões anteriores.

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 é baseada na versão de runtime na qual a API foi introduzida ou 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 nessa especificação.

Além disso, o runtime aceita qualquer versão maior 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 informações de configuração de backup para o serviço e as partições nesse serviço, para as quais a configuração de backup foi substituída.
 PagedBackupConfigurationInfoList
Todos os outros códigos status A resposta de erro detalhada.
 FabricError

Exemplos

Limitar os resultados máximos

Este exemplo mostra como obter uma lista de configurações de backup para esse serviço e partições nesse serviço. 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/Services/CalcApp/CalcService/$/GetBackupConfigurationInfo?api-version=6.4&MaxResults=2

Resposta 200

Corpo
{
  "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
  "Items": [
    {
      "Kind": "Service",
      "PolicyName": "BackupPolicy1",
      "PolicyInheritedFrom": "Application",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "SuspensionInfo": {
        "IsSuspended": false,
        "SuspensionInheritedFrom": "Invalid"
      }
    },
    {
      "Kind": "Partition",
      "PolicyName": "BackupPolicy2",
      "PolicyInheritedFrom": "Partition",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
      "SuspensionInfo": {
        "IsSuspended": false,
        "SuspensionInheritedFrom": "Invalid"
      }
    }
  ]
}

Página usando token de continuação

Este exemplo mostra como obter uma lista de configurações de backup para esse serviço e partições nesse serviço. O número de resultados em uma página é limitado ao máximo de dois usando o parâmetro MaxResult. 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/Services/CalcApp/CalcService/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d&MaxResults=2

Resposta 200

Corpo
{
  "ContinuationToken": "",
  "Items": [
    {
      "Kind": "Partition",
      "PolicyName": "BackupPolicy1",
      "PolicyInheritedFrom": "Application",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionId": "7216486c-1ee9-4b00-99b2-92b26fcb07f6",
      "SuspensionInfo": {
        "IsSuspended": true,
        "SuspensionInheritedFrom": "Partition"
      }
    }
  ]
}