product -Befehle verwenden

Mit den product -Befehlen können Sie die Produkte in Ihrem Developer Portal -Service abrufen und auflisten.

  1. Melden Sie sich wie im folgenden Beispiel als Provider-Organisation an.
    apic login --server management_server --realm provider/identity_provider --username provider_username --password provider_password
    Sie können bestimmen, welche Identitätsprovider im Parameter --realm verwendet werden sollen, indem Sie den folgenden Befehl eingeben, um eine Liste aller verfügbaren Identitätsprovider anzuzeigen (Sie müssen nicht angemeldet sein, um diesen Befehl zu verwenden):
    apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm
    Beispiel:
    apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm 
    total_results: 2
    results:
      - title: API Manager User Registry
        realm: provider/default-idp-2
      - title: Corporate LDAP user registry
        realm: provider/corporate-ldap
    Anhand des title-Werts können Sie bestimmen, welchen Identitätsprovider Sie verwenden müssen. Sie können dann den entsprechenden --realm-Parameter direkt aus dem angezeigten realm-Wert kopieren. Für alle Identitätsanbieter, die Ihr Administrator nach der Installation von API Connect erstellt hat, werden die Namen zum Zeitpunkt der Erstellung festgelegt. Die standardmäßige lokale Benutzerregistry für API Manager für die Anmeldung als Mitglied einer Providerorganisation ist default-idp-2.

    Ausführliche Informationen zum Befehl apic login finden Sie unter Bei einem Management-Server anmelden.

    Eine Zusammenfassung der allgemeinen Befehle und ihrer Verwendung finden Sie unter Developer Portal-CLI-Befehle.

  2. Rufen Sie eine Liste mit Produkten von einer Site ab.

    Beispiel:
    apic --mode portaladmin product:list --org orgid/name --server management_server --catalog catalogid/name
    • management_server ist die URL des Verwaltungsservers (erforderlich).
    • catalogid/name ist die ID oder der Name des Katalogs, zu dem die Site gehört (erforderlich)
    • orgid/name ist die ID oder der Name der Providerorganisation, zu der der Katalog gehört (erforderlich).
    • format_type ist das Ausgabeformat. Kann json, yaml, go-template=..., go-template-file=...sein. Der Standardwert ist yaml.
  3. Mit id oder name:versionkönnen Sie ein Produkt von einer Site abrufen.

    Beispiel:
    apic --mode portaladmin product:get --org orgid/name --server management_server --catalog catalogid/name id/name:version
    • id/name:version -Die ID oder der Name: Version eines bestimmten Produkts (erforderlich) Beispiel: id-of-product-called-example-3 oder example:3.0.0.
  4. Rufen Sie mithilfe von id oder name:versionein bestimmtes vollständiges Produktdokument aus dem Portal der bereitgestellten Organisation und des Katalogs ab.
    apic --mode portaladmin product:get-document --org orgid/name --server management_server --catalog catalogid/name --format format_type  id/name:version
    
    Beispiel:
    apic --mode portaladmin product:get-document --org ibm --server my.management.server.com --catalog portal-test --format yaml  intuiz-product:1.0.0
    
  5. Fügen Sie einen Anhang für Ihr Produkt im Developer Portalhinzu.

    Beispiel:

    apic --mode portaladmin product:add-attachment -s management_server --org orgid/name --catalog catalogid/name --attachment_name attachment.txt --attachment_description "Product documentation" awesome-sleek-soft-chips-product:1.0.0 ./attachment.txt
    Loading File (Large files may take a while)...
    
    Attachment successfully added to product awesome-sleek-soft-chips-product:1.0.0.
      This product now has 2 attachments.
    
    • attachment_name ist der Name, der dem Anhang beim Hochladen zugewiesen wird (erforderlich).
    • attachment_description ist die Beschreibung des Anhangs, der den Benutzern angezeigt wird.
  6. Legen Sie ein Symbol für Ihr Produkt im Developer Portalfest.

    Beispiel:

    apic --mode portaladmin product:set-icon -s management_server --org orgid/name --catalog catalogid/name --icon_description "product icon" awesome-sleek-soft-chips-product:1.0.0 ./icon.png
    Loading File (Large files may take a while)...
    
    Icon successfully set for product awesome-sleek-soft-chips-product:1.0.0
    
    • icon_description ist die Symbolbeschreibung, die Benutzern angezeigt werden soll, und wird als alternativer Text für das Bild verwendet (erforderlich).
  7. Fügen Sie einen Tag (Kategorie) für Ihr Produkt in Ihrem Developer Portalhinzu.

    Beispiel:

    apic --mode portaladmin product:add-tag -s management_server--org orgid/name --catalog catalogid/name --tag_name top_level_element/next_level_element/lower_level_element awesome-sleek-soft-chips-product:1.0.0
    Successfully set taxonomy tag top_level_element/next_level_element/lower_level_element
      for product api-connect-cassin-llc-awesome-sleek-soft-chips-product:1.0.0
    • tag_name ist der Tagname. Beispiel: top_level_element/next_level_element (erforderlich)