Référence de l'API de services Web

Sommaire
casp1032
A propos de l'API de services Web
DX NetOps Spectrum
L'API de services Web
DX NetOps Spectrum
fournit une interface de service Web HTTP RESTful dans
DX NetOps Spectrum
. Cette API répartie fournit un point d'intégration basé sur HTTP au modèle de données
DX NetOps Spectrum
, permettant un accès en lecture/écriture centré sur le Web aux unités, aux modèles, aux relations, aux attributs, aux actions et aux alarmes. L'API de services Web
DX NetOps Spectrum
est un composant
DX NetOps Spectrum
principal qui est installé avec le produit
DX NetOps Spectrum
de base.
A l'aide de l'API de services Web
DX NetOps Spectrum
, vous pouvez accéder aux données
DX NetOps Spectrum
directement à partir d'un navigateur ou les intégrer à votre propre application. En raison des normes inhérentes à l'architecture REST, l'API de services Web
DX NetOps Spectrum
met le modèle de données
DX NetOps Spectrum
accessible à de nombreux environnements et méthodes de développement externes différents. L'API de services Web
DX NetOps Spectrum
peut être utilisée avec tout langage qui sait comment gérer l'intégration HTTP et fournit une alternative légère aux services SOAP.
Grâce à l'API de services Web
DX NetOps Spectrum
, vous pouvez tirer parti des fonctionnalités fournies par le serveur OneClick, telles que l'utilisation de son infrastructure de recherche pour trouver plus facilement des groupes de modèles. Vous pouvez également exécuter de nombreuses fonctions
DX NetOps Spectrum
standard pour un environnement
SpectroSERVER
unique ou dans un environnement
SpectroSERVER
distribué (DSS), comme suit :
  • Accès aux unités, aux modèles, aux relations, aux attributs, aux actions et aux alarmes
  • Gestion des unités, des ports, des conteneurs, des services et des liens
  • Lecture, mise à jour et effacement des alarmes
  • Gestion des abonnements et des notifications
Vous pouvez utiliser l'API de services Web
DX NetOps Spectrum
pour exécuter ces fonctions et plus encore, de la même manière que les autres outils API
DX NetOps Spectrum
tels que l'interface de ligne de commande (CLI), Modeling Gateway, AlarmNotifier, Southbound Gateway ou l'interface SpectroSERVER Object Request Broker (SSORB).
Architecture REST
REST (Representational State Transfer) est un style architectural logiciel qui favorise les comportements normalisés entre les éléments d'interaction, les clients et les serveurs. La conformité aux contraintes REST est appelée RESTful.
L'architecture REST est une approche légère basée sur HTTP/HTTPS pour les services Web SOAPless à l'aide des opérations Create (POST), Read (GET), Update (PUT) et Delete (supprimer), ou des verbes.
L'architecture et les applications RESTful sont sans état, ce qui signifie qu'aucune information de contexte client n'est stockée entre les demandes. Chaque demande contient toutes les informations nécessaires pour traiter la demande.
L'API de services Web
DX NetOps Spectrum
prend en charge l'architecture REST.
Technologies prises en charge
L'API de services Web
DX NetOps Spectrum
fournit une approche RESTful flexible et légère pour l'intégration des données
DX NetOps Spectrum
dans votre application. En tant qu'alternative à l'intégration de CORBA, l'API de services Web
DX NetOps Spectrum
est indépendante du langage et peut être intégrée à n'importe quelle plate-forme de développement prenant en charge l'intégration HTTP, par exemple :
  • Java
  • Perl
  • Ruby on Rails
  • .net
L'API de services Web
DX NetOps Spectrum
fournit une interface HTTP/HTTPS, est à la fois basée sur HTTP et XML/JSON, et fournit Java Beans pour le développement du client.
Remarques relatives aux performances
L'API de services Web
DX NetOps Spectrum
est un client, très similaire à OneClick. Etant donné que l'API de services Web
DX NetOps Spectrum
réutilise la plupart du code du serveur OneClick, les performances d'un client API unique doivent généralement imiter les performances de l'opération OneClick comparable. L'API de services Web
DX NetOps Spectrum
ne doit pas altérer les performances
SpectroSERVER
, sauf via la charge de demande normale.
Des problèmes de performances peuvent survenir dans les cas suivants :
  • Etant donné que les données sont mises en cache dans le serveur OneClick, les demandes de données volumineuses sur plusieurs clients peuvent entraîner une détérioration des performances.
  • Il se peut que vous rencontriez des problèmes de détérioration des performances, voire que SpectroSERVER se bloque, si vous créez et exécutez de nouvelles recherches peu performantes via l'API de services Web
    DX NetOps Spectrum
    .
    Pour plus d'informations, consultez la section Dépannage des problèmes liés à l'API de services Web.
Limites
Les éléments suivants doivent être pris en compte lors de l'utilisation de l'API de services Web
DX NetOps Spectrum
 :
  • L'API de services Web
    DX NetOps Spectrum
    ne fournit pas d'interfaces pour le catalogue de modélisation dans lequel les données sont généralement statiques.
  • Même si vous pouvez créer une application HTML ou de navigateur sur l'API de services Web
    DX NetOps Spectrum
    , l'API de services Web
    DX NetOps Spectrum
    elle-même ne fournit pas de code HTML.
  • L'API de services Web
    DX NetOps Spectrum
    accepte le code XML uniquement pour l'entrée et produit des données XML ou JSON pour la sortie. Si vous choisissez la sortie JSON, vous devrez peut-être l'analyser et générer du code XML pour la demande suivante.
L'API de services Web
DX NetOps Spectrum
peut être utilisée pour les CLI simples et les commandes ad hoc et comme alternative à la génération de scripts de CLI complexes.
L'API de services Web
DX NetOps Spectrum
est un outil puissant. Elle ne fournit pas les mêmes garanties que OneClick, en particulier en ce qui concerne la modélisation. Elle ne doit être utilisée que par les administrateurs
DX NetOps Spectrum
qui comprennent les effets potentiellement nuisibles sur un schéma de modélisation de réseau permettant de créer et de détruire des modèles et de modifier des attributs de modèle de façon aléatoire.