Ottenere informazioni di configurazione del backup dell'applicazione

Ottiene le informazioni di configurazione del backup dell'applicazione di Service Fabric.

Ottiene le informazioni di configurazione del backup di Service Fabric per l'applicazione e i servizi e le partizioni in questa applicazione.

Richiesta

Parametri

applicationId

Tipo: string
Obbligatorio: Sì

Identità dell'applicazione. Si tratta in genere del nome completo dell'applicazione senza lo schema URI "fabric:". A partire dalla versione 6.0, i nomi gerarchici sono delimitati dal carattere "~". Ad esempio, se il nome dell'applicazione è "fabric:/myapp/app1", l'identità dell'applicazione sarà "myapp~app1" nella versione 6.0 e successive e "myapp/app1" nelle versioni precedenti.

api-version

Tipo: string
Obbligatorio: Sì
Impostazione predefinita: 6.4

Versione dell'API. Questo parametro è obbligatorio e il relativo valore deve essere '6,4'.

La versione dell'API REST di Service Fabric è basata sulla versione di runtime in cui è stata introdotta o modificata l'API. Il runtime di Service Fabric supporta più versioni dell'API. Questa versione è la versione supportata più recente dell'API. Se viene passata una versione precedente dell'API, la risposta restituita può essere diversa da quella documentata in questa specifica.

Inoltre, il runtime accetta qualsiasi versione successiva alla versione supportata più recente fino alla versione corrente del runtime. Se quindi la versione più recente dell'API è 6.0 e il runtime è 6.1, il runtime accetterà la versione 6.1 per tale API. Tuttavia, il comportamento dell'API sarà in base alla versione 6.0 documentata.

ContinuationToken

Tipo: string
Obbligatorio: No

Il parametro del token di continuazione viene utilizzato per ottenere il set di risultati successivo. Un token di continuazione con un valore non vuoto è incluso nella risposta dell'API quando i risultati del sistema non rientrano in una singola risposta. Quando questo valore viene passato alla successiva chiamata API, l'API restituisce il set di risultati successivo. Se non sono presenti altri risultati, il token di continuazione non contiene alcun valore. Il valore di questo parametro non deve essere codificato in URL.

MaxResults

Tipo: integer (int64)
Obbligatorio: No
Impostazione predefinita: 0
InclusiveMinimum: 0

Il numero massimo di risultati che devono essere restituiti come parte delle query di paging. Questo parametro definisce il limite massimo di risultati restituiti. Se non rientrano nel messaggio in base ai limiti di dimensione massima per i messaggi definiti nella configurazione, il numero dei risultati restituiti può essere inferiore al numero massimo di risultati specificato. Se questo parametro è uguale a zero o non specificato, le query di paging includono il numero massimo di risultati possibili che rientrano nel messaggio restituito.

timeout

Tipo: integer (int64)
Obbligatorio: No
Impostazione predefinita: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata di attesa che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi.

Risposte

Esempio

Limitare i risultati massimi

Questo esempio illustra come ottenere l'elenco della configurazione di backup per questa applicazione ed entità (servizi e partizioni) in questa applicazione. Il numero di risultati in una pagina è limitato al massimo due usando il parametro MaxResult.

Richiesta

GET http://localhost:19080/Applications/CalcApp/$/GetBackupConfigurationInfo?api-version=6.4&MaxResults=2

200 Risposta

Corpo

{
  "ContinuationToken": "fabric:/CalcApp/CalcService",
  "Items": [
    {
      "Kind": "Application",
      "PolicyName": "BackupPolicy1",
      "PolicyInheritedFrom": "Application",
      "ApplicationName": "fabric:/CalcApp",
      "SuspensionInfo": {
        "IsSuspended": false,
        "SuspensionInheritedFrom": "Invalid"
      }
    },
    {
      "Kind": "Service",
      "PolicyName": "BackupPolicy2",
      "PolicyInheritedFrom": "Service",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "SuspensionInfo": {
        "IsSuspended": false,
        "SuspensionInheritedFrom": "Invalid"
      }
    }
  ]
}

Pagina che usa il token di continuazione

Questo esempio illustra come ottenere l'elenco della configurazione di backup per questa applicazione ed entità (servizi e partizioni) in questa applicazione. Il numero di risultati in una pagina è limitato al massimo due usando il parametro MaxResult. In questo esempio viene usato il parametro ContinuationToken. Il valore di questo parametro viene fornito dalla query precedente; in questo caso l'esempio illustrato in precedenza. La risposta contiene i risultati rimanenti e un oggetto ContinuationToken vuoto. Il valore ContinuationToken vuoto indica che i risultati aggiuntivi non sono disponibili.

Richiesta

GET http://localhost:19080/Applications/CalcApp/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService&MaxResults=2

200 Risposta

Corpo

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