Guide de l'administrateur NetBackup™ pour Apache Cassandra

Last Published:
Product(s): NetBackup & Alta Data Protection (10.5)

Gestion, protection ou récupération de biens Cassandra à l'aide d'API

Le présent document porte sur les API NetBackup destinées aux opérations de charge de travail Cassandra. Ces opérations incluent la gestion des biens, le filtrage, le tri, la gestion de la récupération et des plans de protection. Pour chaque terminal client d'API, l'utilisateur trouvera dans ce document des informations détaillées sur les requêtes, les réponses, les erreurs et les charges utiles.

Pour plus d'informations sur les API, consultez les références suivantes :

Création ou mise à jour de biens Cassandra

L'API crée les biens Cassandra demandés : cluster Cassandra, nœud Cassandra, cluster DSS et nœud DSS.

La charge utile de la requête peut contenir des informations détaillées sur un bien spécifique ou une combinaison de plusieurs biens. Un bien Cassandra peut être créé ou mis à jour en deux étapes :

  • Exécution de la requête POST pour récupérer l'ID généré.

  • Exécution de la requête GET pour enregistrer le bien dans la base de données.

Tableau : 1. Paramètres de requête pour le cluster et les nœuds Cassandra

API

Options et variables importantes

https://PrimaryerverName

/netbackup/asset-service/queries/

  • Workloads : cassandra

  • assetType : définit le type de bien - cluster

  • credentialName : nom des informations d'authentification utilisé pour le service de biens

  • workloadType : cassandra

  • clusterName : nom valide du cluster Cassandra

https://PrimaryServerName
/netbackup/asset-service/queries/

  • Workloads : cassandra

  • assetType : définit le type de bien - node

  • workloadType : cassandra

Tableau : 2. 3. Paramètres de requête pour le cluster intermédiaire de données et les nœuds

API

Options et variables importantes

https://PrimaryServerName
/netbackup/asset-service/queries/

  • Workloads : cassandra

  • assetType : définit le type de bien - cluster, node, dataStagingCluster

  • workloadType : cassandra

  • clusterName : nom valide du cluster Cassandra

https://PrimaryServerName
/netbackup/asset-service/queries/

  • Workloads : cassandra

  • assetType : définit le type de bien - dataStagingNode

  • workloadType : cassandra

Tableau : Paramètres de réponse

API

Options et variables importantes

https://PrimaryServerName
/netbackup/asset-service/queries/
Response parameters

  • type : nom du type de réponse à la requête

  • id : ID de réponse pour la création/modification de biens

  • links : lien de bien complet

Méthode : GET

Les biens sont stockés à l'aide de cette API dans la base de données NetBackup. La méthode GET est utilisée avec un ID de réponse de bien valide dans l'URL.

Tableau : Réponse en cas de stockage des biens dans la base de données

API

Options et variables importantes

https://PrimaryServerName
/netbackup/asset-service/queries/
Asset Response ID

  • id : ID de bien de la réponse pour une demande de création ou de mise à jour de biens

  • status : état de réponse du bien - Succès, Échec et En cours

  • percentComplete : pourcentage d'achèvement

  • totalWorkItems : nombre d'éléments de réponse

  • totalSuccessfulWorkItems : nombre d'éléments terminés correctement

  • totalFailedWorkItems : nombre d'éléments ayant échoué

  • totalInProgressWorkItems

Suppression de la charge utile du bien

Cette API permet de supprimer un bien spécifique ou l'ensemble des biens de la base de données NetBackup. Il est possible de supprimer un bien de type assetType, tel que node ou dataStagingNode. Cette option supprime tous les nœuds enfants correspondants associés à un cluster ou à dataStagingCluster si vous utilisez cette API pour supprimer assetType en tant que cluster ou dataStagingCluster.

Tableau : Charge utile de demande pour la suppression de biens

Options d'API

Options et variables importantes

https://PrimaryServerName
/netbackup/asset-service/queries

  • type : nom du type de réponse à la requête

  • queryName : nom de la demande de création ou mise à jour de différents biens

  • workloads : cassandra

  • correlationId : il s'agit d'un identifiant pour le suivi d'un élément de travail

  • id : ID attribué au bien

  • assetType : type de bien {node, dataStagingNode, dataStagingCluster, cluster}

Charge utile de la demande pour la suppression de biens de la base de données

Cette API permet de supprimer les biens d'une base de données. Il s'agit de la 2e demande utilisée avec l'ID de réponse de suppression provenant de la demande précédente.

Tableau : 

Méthode

URL

GET

 
https://PrimaryServerName
/netbackup/asset-service/queries/
Asset Delete Response ID

Par exemple : bcc0eb1f-6613-427d-8101-19376fd689f7

Tableau : Réponse de la suppression de biens de la base de données

API

Options et variables importantes

https://PrimaryServerName
/netbackup/asset-service/queries/
Asset Delete Response ID

Par exemple : bcc0eb1f-6613-427d-8101-19376fd689f7

  • type : nom du type de réponse de l'opération

  • id : ID de réponse pour les demandes génériques de suppression de biens

  • status : état de réponse du bien - SUCCÈS

  • percentComplete  : pourcentage d'achèvement

  • totalWorkItems  : nombre total d'éléments de travail de réponse

  • totalSuccessfulWorkItems : nombre total d'éléments de travail corrects

  • totalFailedWorkItems : nombre total d'éléments de travail ayant échoué

  • totalInProgressWorkItems : nombre total d'éléments de travail en cours

  • correlationId : il s'agit d'un identifiant pour le suivi d'un élément de travail

  • status : état de réponse du bien

  • message : message de réponse du bien

  • percentComplete : pourcentage d'achèvement

  • offset

  • limit

  • hasNext

  • first

Tableau : Demande d'obtention de tous les biens

 

https://PrimaryServerName
/netbackup/asset-service/
workloads/cassandra/assets

Assets

Réponse pour l'obtention de tous les biens

Tous les biens sont classés dans l'ordre décroissant par défaut. Consultez la table Obtention de bien par ID pour plus d'informations sur les paramètres de réponse. Selon la table Obtention de bien par ID, tous les biens sont répertoriés dans l'ordre décroissant par défaut.

Obtention de bien par ID

Cette API permet d'obtenir des informations spécifiques sur des biens. Des informations sur les biens spécifiques peuvent être obtenues à l'aide de cette API.

Méthode : GET

Tableau : 

API

Options et variables importantes

https://PrimaryServerName/
netbackup/asset-service/workloads/
cassandra/assets/Asset ID

  • type : nom du type de réponse de l'opération

  • id : ID de réponse pour les demandes génériques de suppression de biens

  • assetType : définit le type de bien

  • displayName : nom du bien

  • providerGeneratedId : ID généré automatiquement pour le bien

https://PrimaryServerName/
netbackup/asset-service/workloads/
cassandra//Asset ID

  • parentProviderGeneratedId : ID généré automatiquement pour les nœuds et dataStagingNodes

  • clusterName : cassandra

Filtres

Il est possible de filtrer les terminaux clients d'API ci-dessous :

  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'node'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'dataStagingCluster'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'dataStagingNode'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'node' and parentProviderGeneratedId eq '
CASSANDRA_cluster_Cassandra10'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster' and commonAssetAttributes/
providerGeneratedId eq 'CASSANDRA_cluster_Cassandra1'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster' and 
dataStagingClusterName eq 'DSS1'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster' and 
backupDataCenterName eq 'earthCenter'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'node' and 
nodeIp eq '10.221.110.234'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=(assetType eq 'cluster') and 
(contains(tolower(clusterName), 'cassandra1'))
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=(assetType eq 'cluster') and 
(clusterName eq 'Cassandra1')&meta=accessControlId
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster' and 
clusterName eq 'Cassandra10'

Tableau : 

Paramètres

de filtre

Critères de filtre

Valeur

Description

assetType/
queryName/
workloads/
correlationId/
credentialName/
workloadType/
displayName/
clusterName/
dataStaging
ClusterName/
backupData
CenterName/
nodeDownThreshold
Percentage/
parentProvider
Generated

eq

cluster, node, dataStagingCluster and dataStagingNode

Filtre de bien basé sur les types de bien

eq

'node' and parentProviderGeneratedId

eq 'CASSANDRA_cluster_Cassandra1'

 

eq

'cluster' and commonAssetAttributes/

providerGeneratedId eq 'CASSANDRA_cluster_Cassandra1'

 

eq

'cluster' and dataStagingClusterName

eq 'DSS1'

 

eq

'cluster' and backupDataCenterName

eq 'earthCenter'

 

eq

'node' and nodeIp

eq '10.221.105.94'

 

eq

(assetType eq 'cluster') and

(contains(tolower(clusterName), 'cassandra1'))

 

eq

(assetType eq 'cluster') and

(clusterName eq

'Cassandra1')&meta=accessControlId

 
Tri

Il est possible de trier les terminaux clients d'API ci-dessous :

  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster'&sort=clusterName
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster'&sort=-clusterName
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster'&sort=commonAssetAttributes.
credentials.credentialName
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster'&sort=-commonAssetAttributes
.credentials.credentialName
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'node'&sort=
parentProviderGeneratedId
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'node'&sort=
-parentProviderGeneratedId

Tableau : 

Paramètres de filtre

Critères de filtre

Valeur

Description

assetType

eq

cluster'&sort=clusterName

 

assetType

eq

'node' and parentProviderGeneratedId eq 'CASSANDRA_cluster_Cassandra1'

 

assetType

eq

cluster'&sort=

commonAssetAttributes

.credentials.credentialName

 

assetType

eq

'cluster'&sort=-commonAssetAttributes.

credentials.credentialName

 

assetType

eq

'node'&sort=

 

assetType

eq

parentProvider

GeneratedId

 

assetType

eq

'node'

&sort=-parentProvider

GeneratedId

 
Plan de protection

Les API ci-dessous créent ou mettent à jour la politique utilisée pour déclencher l'opération de sauvegarde sur le bien associé. Ces API permettent de créer ou de mettre à jour la politique aussi bien pour la sauvegarde incrémentielle que complète. Selon les politiques créées, les travaux de sauvegarde sont automatiquement déclenchés en fonction des détails de planification fournis.

Tableau : Créer un objectif de niveau de service : sauvegardes complètes et incrémentielles différentielles

Méthode

Post

https://PrimaryServerName/
netbackup/servicecatalog/slos
 

Tableau :  Charge utile de demande pour la création d'objectif de niveau de service :

API

Options et variables importantes

https://PrimaryServerName
/netbackup/servicecatalog/slos

  • name

  • scheduleType

  • backupStorageUnit

  • dayOfWeek

  • startSeconds

  • durationSeconds

  • frquencySeconds

  • workloadType

  • policyNamePrefix

  • policyDefinition

Tableau : Réponse de la création d'objectif de niveau de service

API

Options et variables importantes

https://PrimaryServerName/
netbackup/servicecatalog/slos

  • 201 : création de la définition d'objectif de niveau de service réussie

  • 400 : demande incorrecte

  • 401 : l'en-tête d'autorisation est manquant, le jeton n'est pas valide ou vous n'êtes pas autorisé à exécuter cette action.

  • 409 : un objectif de niveau de service portant le même nom existe déjà.

  • 500 : une erreur système inattendue est survenue.

Création d'un abonnement

Tableau : 

Méthode

Post

https://{{hostname}}/netbackup/
servicecatalog/slos/
{{newsloid}}/subscriptions
 

Tableau : Charge utile de demande pour la création d'abonnement :

API

Options et variables importantes

https://{{hostname}}/netbackup/
servicecatalog/slos/
{{newsloid}}/subscriptions

  • selectionId

  • selectionType

Tableau : Réponse de création d'abonnement

API

Options et variables importantes

https://{{hostname}}/netbackup/
servicecatalog/slos/
{{newsloid}}/subscriptions

  • 201 : la création de l'abonnement s'est déroulée correctement

  • 400 : demande incorrecte

  • 401 : l'en-tête d'autorisation est manquant, le jeton n'est pas valide ou vous n'êtes pas autorisé à exécuter cette action.

  • 409 : un objectif de niveau de service portant le même nom existe déjà.

  • 500 : une erreur système inattendue est survenue.

Découverte

Les API de découverte permettent de lancer ou d'arrêter la découverte sur un bien donné.

Tableau : Commencer la découverte

API

Options et variables importantes

https://{{HOSTNAME}}/netbackup/
admin/discovery/workloads/cassandra/start

  • Data

  • Type

  • Attribute

  • serverName

Tableau :  Arrêter la découverte

API

Options et variables importantes

https://{{HOSTNAME}}/netbackup/admin/
discovery/workloads/cassandra/stop

  • Data

  • Type

  • Attribute

  • serverName

Demande de récupération

Les API de récupération permettent de récupérer un bien Cassandra spécifique à partir d'informations relatives au point de récupération, à la source, à la destination, etc.

Tableau : 

API

Options et variables importantes

POST /recovery/workloads/cassandra/
scenarios/cluster/recover

  • Data

  • Type

  • Attribute

  • recoveryPoint

  • client

  • filter

  • backupId

  • recoveryObject

  • clusterNewName

  • recoveryOptions

  • backupHost

  • additionalBackupHosts

  • nbu-backup-host2

  • nbu-backup-host3

  • nbu-backup-host4

  • overwrite

  • restoreSelections

  • selectionType

  • selectionCriteria

  • keyspace

Tableau : Réponse de l'API de récupération

API

Codes de réponse importants

POST /recovery/workloads/cassandra/
scenarios/cluster/recover

  • 201 : le travail de récupération a démarré correctement

  • 400 : certains attributs obligatoires sont introuvables ou le client, l'image de sauvegarde ou l'entrée JSON spécifié n'était pas valide

  • 401 : l'en-tête d'autorisation est manquant, le jeton n'est pas valide ou vous n'êtes pas autorisé à exécuter cette action.

  • 404 : le client ou l'image de sauvegarde spécifié est introuvable

  • 406 : type d'acceptation non valide. Assurez-vous que l'en-tête Accept correspond à ce que produit cette API

  • 415 : type de média non pris en charge. Le type de média spécifié dans l'en-tête Content-Type n'est pas pris en charge par cette API.

  • 500 : erreur de serveur interne. Échec du démarrage de la récupération.

  • 503 : le serveur est indisponible. Échec du démarrage de la récupération.