Partilhar via

Obter Informações de Configuração da Cópia de Segurança do Serviço

  • Artigo

Obtém as informações de configuração da cópia de segurança do serviço Service Fabric.

Obtém as informações de configuração da cópia de segurança do Service Fabric para o serviço e as partições neste serviço.

Pedir

Método URI do pedido
GET /Services/{serviceId}/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parâmetros

Nome Tipo Necessário Localização
serviceId string Yes Caminho
api-version string Yes Consulta
ContinuationToken cadeia (de carateres) No Consulta
MaxResults número inteiro (int64) No Consulta
timeout número inteiro (int64) No Consulta

serviceId

Tipo: cadeia
Obrigatório: Sim

A identidade do serviço. Normalmente, este ID é o nome completo do serviço sem o esquema de URI "fabric:". A partir da versão 6.0, os nomes hierárquicos são delimitados com o caráter "~". Por exemplo, se o nome do serviço for "fabric:/myapp/app1/svc1", a identidade do serviço será "myapp~app1~svc1" em 6.0+ e "myapp/app1/svc1" em versões anteriores.

api-version

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

A versão da API. Este parâmetro é obrigatório e o respetivo valor tem de 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 alterada. O runtime do Service Fabric suporta mais do que uma versão da API. Esta versão é a versão suportada mais recente da API. Se for transmitida uma versão inferior da API, a resposta devolvida poderá ser diferente da documentada nesta especificação.

Além disso, o runtime aceita qualquer versão superior à versão suportada mais recente até à versão atual do runtime. Por isso, se a versão mais recente da API for a 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 6.0 documentada.

ContinuationToken

Tipo: cadeia
Obrigatório: Não

O parâmetro do token de continuação é utilizado 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 cabem numa única resposta. Quando este valor é transmitido para a próxima chamada à API, a API devolve o próximo conjunto de resultados. Se não existirem mais resultados, 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: número inteiro (int64)
Obrigatório: Não
Predefinição: 0
InclusiveMinimum: 0

O número máximo de resultados a devolver como parte das consultas paginadas. 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 caberem na mensagem de acordo com as restrições de tamanho máximo de mensagens definidas na configuração. Se este parâmetro for zero ou não for especificado, a consulta paginada inclui o maior número possível de resultados que cabem na mensagem de retorno.

timeout

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

O tempo limite do servidor para executar a operação em segundos. Este tempo limite especifica a duração de tempo que o cliente está disposto a aguardar que a operação pedida seja concluída. O valor predefinido para este parâmetro é 60 segundos.

Respostas

Código de Estado HTTP Description Esquema de Resposta
200 (OK) Uma operação bem-sucedida devolverá 200 códigos de estado e uma lista paginada de informações de configuração de cópia de segurança para o serviço e as partições neste serviço, para as quais a configuração da cópia de segurança foi substituída.
 PagedBackupConfigurationInfoList
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError

Exemplos

Limitar os resultados máximos

Este exemplo mostra como obter uma lista de configuração de cópia de segurança para este serviço e partições neste serviço. O número de resultados numa página está limitado ao máximo de dois com o parâmetro MaxResult.

Pedir

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 com o token de continuação

Este exemplo mostra como obter uma lista de configuração de cópia de segurança para este serviço e partições neste serviço. O número de resultados numa página está limitado ao máximo de dois com 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 mostrado acima. A resposta contém os resultados restantes e um ContinuationToken vazio. O ContinuationToken vazio indica que não estão disponíveis resultados adicionais.

Pedir

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"
      }
    }
  ]
}