Hämta konfigurationsinformation för tjänstsäkerhetskopiering

  • Artikel

Hämtar konfigurationsinformation för Service Fabric-tjänstsäkerhetskopiering.

Hämtar konfigurationsinformation för Service Fabric-säkerhetskopiering för tjänsten och partitionerna under den här tjänsten.

Förfrågan

Metod URI för förfrågan
GET /Services/{serviceId}/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parametrar

Namn Typ Obligatorisk Location
serviceId sträng Ja Sökväg
api-version sträng Ja Söka i data
ContinuationToken sträng No Söka i data
MaxResults heltal (int64) No Söka i data
timeout heltal (int64) No Söka i data

serviceId

Typ: sträng
Obligatoriskt: Ja

Tjänstens identitet. Det här ID:t är vanligtvis det fullständiga namnet på tjänsten utan URI-schemat "fabric:". Från och med version 6.0 avgränsas hierarkiska namn med tecknet "~". Om tjänstnamnet till exempel är "fabric:/myapp/app1/svc1" skulle tjänstidentiteten vara "myapp~app1~svc1" i 6.0+ och "myapp/app1/svc1" i tidigare versioner.

api-version

Typ: sträng
Obligatoriskt: Ja
Standard: 6.4

Versionen av API:et. Den här parametern krävs och dess värde måste vara "6.4".

Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Den här versionen är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som beskrivs i den här specifikationen.

Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds fram till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0 och körningen är 6.1 accepterar körningen version 6.1 för det API:et. Beteendet för API:et kommer dock att vara enligt den dokumenterade 6.0-versionen.

ContinuationToken

Typ: sträng
Obligatoriskt: Nej

Parametern fortsättningstoken används för att hämta nästa uppsättning resultat. En fortsättningstoken med ett icke-tomt värde ingår i API:ets svar när resultatet från systemet inte får plats i ett enda svar. När det här värdet skickas till nästa API-anrop returnerar API:et nästa uppsättning resultat. Om det inte finns några ytterligare resultat innehåller fortsättningstoken inget värde. Värdet för den här parametern ska inte vara URL-kodat.

MaxResults

Typ: heltal (int64)
Obligatoriskt: Nej
Standard: 0
InclusiveMinimum: 0

Det maximala antalet resultat som ska returneras som en del av de sidiga frågorna. Den här parametern definierar den övre gränsen för antalet returnerade resultat. Resultatet som returneras kan vara mindre än det angivna maximala resultatet om de inte får plats i meddelandet enligt de maximala begränsningarna för meddelandestorleken som definierats i konfigurationen. Om den här parametern är noll eller inte angiven innehåller den sidade frågan så många resultat som möjligt som får plats i returmeddelandet.

timeout

Typ: heltal (int64)
Obligatoriskt: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.

Svar

HTTP-statuskod Description Svarsschema
200 (OK) En lyckad åtgärd returnerar statuskoden 200 och en sidig lista över konfigurationsinformation för säkerhetskopiering för tjänsten och partitionerna under den här tjänsten, för vilka säkerhetskopieringskonfigurationen har åsidosatts.
 PagedBackupConfigurationInfoList
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError

Exempel

Begränsa maximalt resultat

Det här exemplet visar hur du hämtar en lista över säkerhetskopieringskonfigurationen för den här tjänsten och partitioner under den här tjänsten. Antalet resultat på en sida är begränsat till högst två med parametern MaxResult.

Förfrågan

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

200-svar

Brödtext
{
  "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"
      }
    }
  ]
}

Sida med fortsättningstoken

Det här exemplet visar hur du hämtar en lista över säkerhetskopieringskonfigurationen för den här tjänsten och partitioner under den här tjänsten. Antalet resultat på en sida är begränsat till högst två med parametern MaxResult. I det här exemplet används parametern ContinuationToken. Värdet för den här parametern anges från föregående fråga. i det här fallet exemplet som visas ovan. Svaret innehåller återstående resultat och en tom ContinuationToken. Den tomma ContinuationToken anger att ytterligare resultat inte är tillgängliga.

Förfrågan

GET http://localhost:19080/Services/CalcApp/CalcService/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d&MaxResults=2

200-svar

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