Utilisation des services Web de Performance Center

Les exemples suivants présentes certaines procédures standards pour interagir avec les services Web RESTful de capm. Les procédures figurant dans ces exemples requièrent des droits d'accès d'administrateur.
capm250
Les exemples suivants présentes certaines procédures standards pour interagir avec les services Web RESTful de
DX NetOps Performance Management
. Les procédures figurant dans ces exemples requièrent des droits d'accès d'administrateur.
Exemples de service Web REST de base
Exemple d'une opération PUT simple qui met à jour le paramètre de description d'un client hébergé :
http://
PC_host
:8181/pc/center/webservice/tenants/tenantName/tenantName/tenantDescription/NewDescription
Remplacez les termes en italique par les valeurs appropriées. Certains paramètres sont requis :
  • tenantName
    Nom du client hébergé que vous souhaitez modifier.
  • tenantDescription
    Nouvelle description permettant d'identifier ce client hébergé.
Exemple d'opération GET simple qui renvoie une liste d'ID de client hébergé et de noms à l'aide du service Web tenants :
http://
PC_host
:8181/pc /center/webservice/tenants/idNames
Le code XML suivant est renvoyé :
<?xml version="1.0" encoding="UTF-8"?> <idNames> <idName value="tenantAccountId" /> <idName value="tenantItemId" /> <idName value="tenantName" /> </idNames>
Les requêtes HTTP renvoient toujours une réponse et un code de statut, même lorsqu'elles sont effectuées sans erreur. Le texte de réponse correspond au résultat attendu ou à un message d'erreur indiquant le problème. Le code de statut est 200 pour une réponse indiquant la réussite de l'opération ou un indicateur numérique d'erreur. Les plages de codes de réponse HTTP suivantes sont utilisées :
  • 200 : le statut de commande est OK.
  • 400 : une erreur utilisateur s'est produite. Les erreurs dans cette plage indiquent un problème au niveau du texte d'entrée (400) ou des informations d'identification de l'utilisateur (403) et peuvent être facilement corrigées dans la plupart des cas.
  • 500 : une erreur système s'est produite. Les erreurs dans cette plage indiquent généralement une panne du système. Elles peuvent requérir l'assistance de l'équipe de support technique de CA.
Pour plus d'informations sur les codes de statut HTTP, consultez le site Web de la communauté IETF à l'adresse ci-dessous :
Utilisation du client pour créer des rôles d'utilisateur
Il est recommandé de créer des rôles de compte d'utilisateur avant de créer des comptes d'utilisateurs. Le rôle est un paramètre du compte d'utilisateur qui permet à l'utilisateur d'accéder à certaines fonctionnalités administratives et d'effectuer les tâches sélectionnées.
Vous pouvez utiliser le client REST que vous avez configuré pour appeler le service Web de rôles CA
NetOps Portal
.
Procédez comme suit :
  1. Dans l'interface cliente REST, saisissez l'URL suivante dans le champ URL :
    http://
    PC_host
    :8181/pc/center/webservice/roles/
  2. Sélectionnez la méthode
    HTTP post
    .
  3. Saisissez le texte suivant dans le champ de texte Corps :
    <role> <name>{Name for the role}</name> <description>{Text to describe the role in the UI}</description> <enabled>{Whether the role is activated or disabled}</enabled> </role>
  4. Remplacez les valeurs par les valeurs que vous souhaitez utiliser pour le nouveau client hébergé.
    Fournissez, par exemple, les paramètres suivants :
    <role> <name>Data Center Manager</name> <description>Manages data center operations and performs troubleshooting</description> <enabled>True</enabled> </role>
  5. Cliquez sur
    Envoyer
    pour exécuter la méthode.
  6. Exécutez la méthode GET suivante pour obtenir l'ID du rôle qui a été automatiquement assigné au nouveau rôle :
    http://
    PC_host
    :8181/pc/center/webservice/roles/idNames
  7. Cliquez sur l'onglet (en surbrillance) Response Body (Corps de réponse) pour afficher la réponse.
    Les valeurs des propriétés
    roleId
    et
    roleName
    sont renvoyées.
    Vous pouvez remplacer l'une des valeurs
    roleID
    ou
    roleName
    pour la propriété
    {roleIdName}
    lorsqu'elle apparaît dans l'interface de documentation des services Web.
  8. (Facultatif) Vérifiez que le nouveau rôle a été créé en suivant les étapes suivantes :
    1. Connectez-vous à
      NetOps Portal
      en tant qu'administrateur global.
    2. Cliquez sur
      Administration
      ,
      Rôles
      .
    La page Gérer les rôles affiche la liste de rôles. Votre nouveau rôle s'affiche dans la liste.
Utilisation du client pour créer des comptes d'utilisateur
Vous pouvez utiliser le client REST que vous avez configuré pour ajouter un compte d'utilisateur. Fournissez l'ID de rôle pour le nouveau rôle que vous avez créé dans la procédure précédente.
Procédez comme suit :
  1. Dans le client REST, entrez l'URL correspondant à l'API des services Web RESTful de CA
    NetOps Portal
    . Utilisez la syntaxe suivante pour appeler le service Web d'utilisateurs :
    http://
    PC_host
    :8181/pc/center/webservice/users/role/
    {roleIdName}
    /
    {roleIdValue}
    /
    Pour
    {roleIdName}
    et
    {roleIdValue}
    , utilisez les valeurs qui ont été renvoyées lorsque vous avez exécuté la méthode rôles/idNames dans une procédure précédente.
    Vous pouvez remplacer l'une des valeurs
    roleID
    ou
    roleName
    pour la propriété
    {roleIdName}
    qui apparaît dans l'interface de documentation des services Web.
    Si vous déployez l'hébergement multiclient, le rôle que vous avez créé a automatiquement été associé au client hébergé auquel votre compte d'utilisateur est associé.
    1. Sélectionnez la
      méthode HTTP
      Post
      .
    2. Laissez
      'application/xml'
      configuré comme
      'Body Content-type'
      .
  2. Saisissez les paramètres suivants dans le champ de texte Corps :
    <user> <name>{UserName}</name> <description>{UserDescription}</description> <enabled>{UserEnabled}</enabled> <removable>{UserRemovable}</removable> <timezone>{UserTimeZone}</timezone> <culture>{UserCulture}</culture> </user>
    Remplacez toute valeur par les valeurs que vous souhaitez utiliser pour le nouveau compte d'utilisateur.
    Fournissez, par exemple, les paramètres suivants :
    <user> <name>Jane Doe</name> <description>User associated with the John Doe Corporation tenant.</description> <enabled>true</enabled> <removable>true</removable> <timezone>CST6CDT</timezone> <culture>en-US</culture> </user>
    Pour plus d'informations sur les paramètres d'utilisateur, consultez la section Paramètres de base de compte d'utilisateur.
  3. Exécutez la méthode.
  4. Répétez les étapes précédentes jusqu'à ce que vous ayez créé tous les utilisateurs de votre choix.