Übersicht über das Management API-Handbuch

Eine Übersicht über die Management API. Die API stellt Managementfunktionen für Clouds und für Integrationseinheiten (Integration Appliances) bereit.

Die Management API wird als Web-Service implementiert. Über diesen Web-Service erhalten Sie die Möglichkeit, Projekte mit WebSphere DataPower Cast Iron Appliances (Integrationseinheiten bzw. Integrationseinheiten) und WebSphere Cast Iron Cloud (Cloud) über Ihre Anwendungen oder Scripts zu verwalten.

Die API ermöglicht die Verwaltung von Integrationseinheiten (Integration Appliances) und Clouds in den folgenden Bereichen:

Implementierung
Stellt Operationen zum Erstellen, Abrufen und Löschen von Konfigurationen, Regeln und Projekten bereit. Sie können Jobs starten, anhalten, stoppen und abbrechen. Sie können Repositorys importieren und exportieren.
Sicherheit
Stellt Operationen zum Erstellen, Abrufen, Auflisten und Löschen von Benutzern, Rollen und Berechtigungen bereit. Die An- und Abmeldung kann durch Verwendung der Security-WSDL erfolgen.
Bereitstellung
Prüft, ob die Bereitstellungsdatenbank gestartet wurde und startet bzw. stoppt sie. (Dies gilt ausschließlich für Einheiten.)
Systemverwaltung
Definiert den Einheitennamen oder die Netzkonfiguration oder ruft diese(n) ab. Außerdem können Sie auch Systembefehle ausführen oder Systeminformationen abrufen. (Dies gilt ausschließlich für Einheiten.)
Jobüberwachung
Sucht nach Jobs, ruft die Anzahl von Jobs ab und bezieht Jobdetails. Außerdem können Sie auch Jobüberwachungseigenschaften definieren und abrufen.
Protokolle und Benachrichtigungen
Speichert, ruft Benachrichtigungsrichtlinien ab und löscht Benachrichtigungsrichtlinien. Außerdem können Sie auch E-Mail- und SNMP-Endpunkte abrufen und definieren, Protokollebenen abrufen und definieren sowie den Protokollzähler abrufen.

Die Management API entspricht den folgenden Standards für Web-Services:

Sie können Clientanwendungen erstellen, die Web-Service-Operationen zum Verwalten und Überwachen von Projekten mit Integrationseinheiten (Integration Appliances) und Clouds aufrufen. Die Kommunikation zwischen der Clientanwendung und dem Integrationseinheits- oder Cloud-Projekt wird über HTTP oder HTTPS sichergestellt.

Die Management API wird in WSDL-Dateien definiert. Clientanwendungen rufen Web-Service-Operationen durch Senden von SOAP-Nachrichten auf. SOAP-Nachrichten werden in XML formatiert und sind somit programmiersprachenneutral.

Beispiele für SOAP-Nachrichten

Dieser Abschnitt enthält Beispiele für das Anmelden, das Abrufen eines Benutzers und das Abmelden anhand der Security-WSDL der Management API.

Bei dem folgenden Code handelt es sich um ein Beispiel für eine SOAP-Anforderung zum Anmelden.
Anmerkung: Wenn Sie die Management-API für Cast Iron Live verwenden, müssen Sie in den Feldern für den Benutzernamen und das Kennwort Ihren Berechtigungsnachweis der IBM ID eingeben.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
 <soapenv:Header/>
 <soapenv:Body>
  <sec:login>
   <sec:username>webuser@mycompany.com</sec:username>
   <sec:password>D3nu9noB</sec:password>
  </sec:login>
 </soapenv:Body>
</soapenv:Envelope>
Bei dem folgenden Code handelt es sich um ein Beispiel für eine SOAP-Antwort auf die Anforderung zum Anmelden.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:loginResponse xmlns:ns2="http://www.approuter.com/schemas/2008/1/
  security" xmlns:ns3="http://www.approuter.com/schema/router/1000/security/03">
   <ns2:sessionId>8F059BEEA3611033D277773A95404641</ns2:sessionId>
  </ns2:loginResponse>
 </S:Body>
</S:Envelope>
Die sessionId ist erforderlich, um nach der erfolgten Anmeldung bei einer Integrationseinheit (Integration Appliance) oder der Cloud weitere SOAP-Operationen ausführen zu können.
Bei dem folgenden Code handelt es sich um ein Beispiel für eine SOAP-Anforderung zum Abrufen eines Benutzers.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
 <soapenv:Header>
  <sec:sessionId>8F059BEEA3611033D277773A95404641</sec:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <sec:getUser>
   <sec:username>webuser</sec:username>
  </sec:getUser>
 </soapenv:Body>
</soapenv:Envelope>
Bei dem folgenden Code handelt es sich um ein Beispiel für eine SOAP-Antwort auf die Anforderung zum Abrufen eines Benutzers.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:getUserResponse xmlns:ns2="http://www.approuter.com/schemas/2008/1/
  security" xmlns:ns3="http://www.approuter.com/schema/router/1000/security/03">
   <ns2:user>
    <ns3:id>8F059BEEA3611033D277773A95404641</ns3:id>
    <ns3:name>webuser</ns3:name>
    <ns3:encPasswd>{SHA}clO20r2ZJMJcDrNwXQzhWB8YcdI=</ns3:encPasswd>
    <ns3:displayName>WebServiceUser</ns3:displayName>
    <ns3:isActive>true</ns3:isActive>
    <ns3:isMutable>true</ns3:isMutable>
    <ns3:isVisible>true</ns3:isVisible>
    <ns3:email>webuser@mycompany.com</ns3:email>
    <ns3:createdTime>2010-03-02T22:11:32.935Z</ns3:createdTime>
    <ns3:failedLoginCount>0</ns3:failedLoginCount>
    <ns3:scopeId>B47EAECF6AD14AA028B4EA038CB742D0</ns3:scopeId>
    <ns3:scopeType>Tenant</ns3:scopeType>
   </ns2:user>
  </ns2:getUserResponse>
 </S:Body>
</S:Envelope>
Bei dem folgenden Code handelt es sich um ein Beispiel für eine SOAP-Anforderung zum Abmelden.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
 <soapenv:Header>
  <sec:sessionId>8F059BEEA3611033D277773A95404641</sec:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <sec:logout/>
 </soapenv:Body>
</soapenv:Envelope>

Cloud-Beispiele

Die folgenden Beispiele gelten ausschließlich für die Cloud.

Bei den vorherigen Beispielen wurden SOAP-Operationen verwendet, deren Ausführung in einem Nutzer in der Cloud (Integration Appliance) oder einer Integrationseinheit erfolgte. Um Operationen in Umgebungen mit einem Nutzer in der Cloud ausführen zu können, definieren Sie anhand der Operation setCurrentScope als Geltungsbereich (Wirkungsbereich) diejenige Umgebung, in der Sie SOAP-Operationen ausführen wollen.

Im folgenden Beispiel wird die Entwicklungsumgebung als Geltungsbereich definiert und anschließend ein Projekt gestartet, das sich in der Entwicklungsumgebung befindet.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
 <soapenv:Header>
  <sec:sessionId>63Y93HD6D856EB5812EB71216C3547W7</sec:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <sec:setCurrentScope>
   <sec:scopeName>Development</sec:scopeName>
  </sec:setCurrentScope>
 </soapenv:Body>
</soapenv:Envelope>
Beim folgenden Beispiel handelt es sich um die SOAP-Antwort auf die Anforderung.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:setCurrentScopeResponse xmlns:ns2="http://www.approuter.com/
  schemas/2008/1/security" xmlns:ns3="http://www.approuter.com/schema/
  router/1000/security/03">
   <ns2:success>true</ns2:success>
  </ns2:setCurrentScopeResponse>
 </S:Body>
</S:Envelope>
Beim folgenden Beispiel handelt es sich um eine SOAP-Anforderung zum Starten einer Konfiguration in der Entwicklungsumgebung.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:dep="http://www.approuter.com/schemas/2008/1/deployment">
 <soapenv:Header>
  <dep:sessionId>63Y93HD6D856EB5812EB71216C3547W7</dep:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <dep:start>
   <dep:projectName>HTTP_363i</dep:projectName>
   <dep:version>1.0</dep:version>
   <dep:configName>HTTP_363j</dep:configName>
  </dep:start>
 </soapenv:Body>
</soapenv:Envelope>
Beim folgenden Beispiel handelt es sich um die SOAP-Antwort auf die Anforderung.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:startResponse xmlns:ns2="http://www.approuter.com/schemas/2008/1/
  deployment" xmlns:ns3="http://www.approuter.com/schemas/2008/1/deployment/
  types" xmlns:ns4="http://www.approuter.com/schema/router/1000/security/03"
  xmlns:ns5="http://www.approuter.com/schemas/2008/1/util/types">
   <ns2:success>true</ns2:success>
  </ns2:startResponse>
 </S:Body>
</S:Envelope>