Utilisation des commandes custom-translation

Vous pouvez utiliser les commandes custom-translation pour créer une tâche d'importation ou d'exportation qui va importer ou exporter un .tgz de traductions personnalisées pour un site Developer Portal . Vous pouvez également supprimer les tâches d'exportation et d'importation, obtenir le statut d'une tâche d'exportation ou d'importation et obtenir un artefact d'exportation de traduction personnalisé.

  1. Connectez-vous en tant qu'organisation de type fournisseur :
    apic login --server management_server --realm provider/identity_provider --username provider_username --password provider_password
    Vous pouvez choisir le fournisseur d'identité à utiliser avec le paramètre --realm en entrant la commande suivante qui permet d'afficher la liste de tous les fournisseurs d'identité disponibles (vous n'avez pas besoin d'être connecté pour utiliser cette commande) :
    apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm
    Exemple :
    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
    La valeur title devrait vous aider à déterminer le fournisseur d'identité à utiliser. Vous pouvez copier le paramètre --realm correspondant directement à partir de la valeur realm affichée. Pour tous les fournisseurs d'identité que votre administrateur a créés après l'installation de API Connect , les noms sont déterminés au moment de la création. Le registre d'utilisateurs local d'API Manager par défaut pour la connexion en tant que membre d'une organisation de type fournisseur est default-idp-2.

    Pour plus de détails sur la commande apic login , voir Connexion à un serveur de gestion.

  2. Exportez vos traductions personnalisées.
    La commande custom-translation:create-export crée une tâche d'exportation sur le portail des catalog et orgspécifiés, pour exporter une archive des traductions personnalisées du site. La commande interroge ensuite le statut de la tâche jusqu'à ce qu'elle ait FINISHED et que les artefacts soient retransmis. L'ID tâche est imprimé sur le terminal.
    Remarque :
    • La commande continue l'interrogation jusqu'à ce que le délai d'interrogation maximal soit atteint (15 minutes). A ce stade, vous pouvez utiliser les commandes custom-translation:get-export-status et custom-translation:get-export pour obtenir le statut et potentiellement un artefact.
    • L'archive .tgz de traduction est sauvegardée dans le répertoire dans lequel vous avez exécuté la commande.
    • Le fichier .tgz sauvegardé a le format custom_translation_createExport-20210217134637.tgz.
    • Vous pouvez sauvegarder les exportations dans le système de gestion de contrôle des changements.
    apic --mode portaladmin custom-translation:create-export --catalog catalogid/name --org orgid/name --server management_server
    • catalogid/name est l'ID ou le nom du catalogue auquel appartient le site (obligatoire).
    • orgid/name est l'ID ou le nom de l'organisation de type fournisseur à laquelle appartient le catalogue (obligatoire).
    • management_server est l' URL du point final du serveur de gestion (obligatoire).
    • --langcodes est une liste de codes de langue séparés par des virgules, par exemple es,zh-hans. Vous pouvez utiliser cette option pour spécifier les traductions personnalisées à exporter.
    • --no-poll peut être utilisé pour arrêter la commande d'interrogation de la tâche et renvoyer simplement l'ID de tâche.
    Par exemple :
    apic --mode portaladmin custom-translation:create-export --catalog dev --org ibm --server api.stagingexample.com
  3. Importez vos traductions personnalisées.
    La commande custom-translation:create-import utilise le fichier .tgz fourni pour créer une tâche permettant d'importer les traductions personnalisées dans le portail des catalog et orgspécifiés. La commande interroge ensuite le statut de la tâche jusqu'à ce que la tâche soit FINISHED réussie ou qu'elle échoue en raison d'une erreur. L'ID tâche est imprimé sur le terminal.
    Remarque :
    • L'archive .tgz ne doit contenir que des fichiers de traduction .po et rien d'autre.
    • La commande continue l'interrogation jusqu'à ce que le délai d'interrogation maximal soit atteint (15 minutes). A ce stade, vous pouvez utiliser la commande custom-translation:get-import-status pour obtenir le statut de l'importation.
    • Si vous importez une traduction personnalisée qui existe déjà, la traduction personnalisée existante est remplacée.
    apic --mode portaladmin custom-translation:create-import --catalog catalogid/name --org orgid/name --server management_server /PATH/TO/MODULE/TGZ
    • --no-poll peut être utilisé pour arrêter la commande d'interrogation de la tâche et renvoyer simplement l'ID de tâche.
    Par exemple :
    apic --mode portaladmin custom-translation:create-import --catalog prod --org ibm --server api.productionexample.com C:/users/example/desktop/custom_translation_createExport-20210217134637.tgz
  4. Vous pouvez exécuter la commande de suppression pour annuler les tâches d'importation ou d'exportation en cours ou récemment créées. Tous les artefacts créés temporairement seront supprimés du système de fichiers du portail. Aucune traduction personnalisée n'est supprimée.
    Exemple :
    apic --mode portaladmin custom-translation:delete-export --catalog catalogid/name --org orgid/name --server management_server --format json --task_id taskid
    apic --mode portaladmin custom-translation:delete-import --catalog catalogid/name --org orgid/name --server management_server --format json --task_id taskid
    • taskid est l'ID de la tâche d'importation ou d'exportation créée dans la file d'attente (obligatoire).
    • --format est le format de sortie qui peut être vu si vous exécutez la commande avec le débogage. Peut être json, yaml, go-template=..., go-template-file=.... La valeur par défaut est yaml.
    Par exemple :
    apic --mode portaladmin custom-translation:delete-import --catalog prod --org ibm --server api.productionexample.com  --task_id 4hythbptta6z9lyx