Partager via

Obtenir les informations de configuration de la sauvegarde du service

  • Article

Obtient les informations de configuration de la sauvegarde du service Service Fabric.

Obtient les informations de configuration de sauvegarde Service Fabric pour le service et les partitions sous ce service.

Requête

Méthode URI de demande
GET /Services/{serviceId}/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Paramètres

Nom Type Obligatoire Emplacement
serviceId string Oui Chemin d’accès
api-version string Oui Requête
ContinuationToken string Non Requête
MaxResults integer (int64) Non Requête
timeout integer (int64) Non Requête

serviceId

Type : chaîne
Obligatoire : Oui

Identité du service. Cet ID est généralement le nom complet du service sans le schéma d’URI « fabric: ». Depuis la version 6.0, les noms hiérarchiques sont séparés par le caractère « ~ ». Par exemple, si un service est nommé « fabric:/myapp/app1/svc1 », son identité de service est « myapp~app1~svc1 » dans les versions 6.0 et ultérieures et « myapp/app1/svc1 » dans les versions antérieures.

api-version

Type : chaîne
Obligatoire : Oui
Par défaut : 6.4

Version de l’API. Ce paramètre est obligatoire et sa valeur doit être « 6.4 ».

La version de l’API REST Service Fabric est basée sur la version du runtime dans laquelle l’API a été introduite ou a été modifiée. Le runtime Service Fabric prend en charge plusieurs versions de l’API. Cette version est la dernière version prise en charge de l’API. Si une version inférieure de l’API est passée, la réponse retournée peut être différente de celle documentée dans cette spécification.

En outre, le runtime accepte toute version supérieure à la dernière version prise en charge jusqu’à la version actuelle du runtime. Par conséquent, si la dernière version de l’API est 6.0 et que le runtime est 6.1, le runtime accepte la version 6.1 pour cette API. Toutefois, le comportement de l’API sera conformément à la version 6.0 documentée.

ContinuationToken

Type : chaîne
Obligatoire : Non

Le paramètre de jeton de liaison permet d’obtenir le jeu de résultats suivant. Un jeton de liaison avec une valeur non vide est inclus dans la réponse de l’API quand les résultats du système ne tiennent pas dans une seule réponse. Lorsque cette valeur est transmise à l’appel d’API suivant, l’API retourne le jeu de résultats suivant. S’il n’existe pas de résultats supplémentaires, le jeton de liaison ne contient pas de valeur. La valeur de ce paramètre ne doit pas être codée URL.

MaxResults

Type : integer (int64)
Obligatoire : Non
Par défaut : 0
InclusiveMinimum : 0

Nombre maximal de résultats à renvoyer dans le cadre des requêtes paginées. Ce paramètre définit la limite supérieure du nombre de résultats renvoyés. Le nombre de résultats renvoyés peut être inférieur au nombre maximal de résultats spécifié s’ils ne tiennent pas dans le message conformément aux restrictions de taille maximale définies dans la configuration. Si ce paramètre est défini sur zéro ou n’est pas spécifié, la requête paginée comprend le nombre maximal de résultats pouvant tenir dans le message renvoyé.

timeout

Type : integer (int64)
Obligatoire : Non
Par défaut : 60
InclusiveMaximum : 4294967295
InclusiveMinimum : 1

Délai d’attente du serveur pour l’exécution de l’opération en secondes. Il spécifie la durée pendant laquelle le client attend la fin de l’opération demandée. La valeur par défaut de ce paramètre est de 60 secondes.

Réponses

Code d’état HTTP Description Schéma de réponse
200 (OK) Une opération réussie renvoie 200 status code et une liste paginée des informations de configuration de sauvegarde pour le service et les partitions sous ce service, pour lesquelles la configuration de sauvegarde a été remplacée.
 PagedBackupConfigurationInfoList
Tous les autres codes status Réponse d’erreur détaillée.
 FabricError

Exemples

Limiter le nombre maximal de résultats

Cet exemple montre comment obtenir la liste de la configuration de sauvegarde pour ce service et les partitions sous ce service. Le nombre de résultats dans une page est limité à deux au maximum à l’aide du paramètre MaxResult.

Requête

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

Réponse 200

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

Page utilisant le jeton de continuation

Cet exemple montre comment obtenir la liste de la configuration de sauvegarde pour ce service et les partitions sous ce service. Le nombre de résultats dans une page est limité à deux au maximum à l’aide du paramètre MaxResult. Cet exemple utilise le paramètre ContinuationToken. La valeur de ce paramètre est fournie à partir de la requête précédente ; dans ce cas, l’exemple ci-dessus. La réponse contient les résultats restants et un ContinuationToken vide. La valeur ContinuationToken vide indique que des résultats supplémentaires ne sont pas disponibles.

Requête

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

Réponse 200

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