API 製品の管理

ライフサイクル全体での products コマンドと apis コマンドの使用例

この例では、実行時に新しいバージョンの製品や API で元のバージョンを置き換えるような複雑なライフサイクルを示しています。

デフォルトのカタログを設定し、 mgmnthost.comAPI Connect クラウドにログインします

apic config:set catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
apic login --username some-user --password some-password --server platform-api.myserver.com --realm my-identity-provider

CLI から管理サーバーにログインする方法について詳しくは、 管理サーバーへのログインを参照してください。

初期バージョンを作成および公開する

apic create:api --title Routes --version 1.0.0 --filename routes100.yaml
apic create:product --title "Climb On" --version 1.0.0 --apis routes100.yaml --filename climbon100.yaml
apic products:publish climbon100.yaml

API のバグを修正するための新規バージョンを作成し、カタログにステージングする

apic create:api --title Routes --version 1.0.1 --filename routes101.yaml
apic create:product --title "Climb On" --version 1.0.1 --apis routes101.yaml --filename climbon101.yaml
apic products:publish --stage climbon101.yaml

カタログを検査する

apic products:list-all --scope catalog

このコマンドは、カタログ内のすべての製品を表示します。 climbon:1.0.1 製品の ID をコピーします。 ID は次の例のようになります。

https:/server/api/catalogs/3eca6046-3c27-4ad/ab8772bf-0f65-45/products/8f854623-bda1-4f9

マッピング・ファイルを作成する

たとえば、ある製品を置き換える場合、マッピングファイルでは置き換える対象の製品を指定し、元の製品のプランを置き換え先の製品にマッピングします。 例えば、climbon:1.0.0 を climbon:1.0.1 に置き換える場合、product_url プロパティーは climbon:1.0.0 の URL を指定します。

このファイルの形式は以下のとおりです。

product_url: https:/server/api/catalogs/{id}/products/{id}
plans:
- source: {source_plan_name_1}
  target: {target_plan_name_1}
- source: {source_plan_name_2}
  target: {target_plan_name_2}
            .
            .
            .

注:

• ソースとターゲットのプラン名は、同じ名前にすることも異なる名前にすることもできます。
• 置き換える製品内のすべてのプランが、新しく置き換わる製品内のプランにマップされている必要があります。

バージョン 1.0.0 を 1.0.1 に「ホット・リプレース」する

apic products:replace climbon:1.0.1 PRODUCT_PLAN_MAPPING_FILE

このように交換された後、指定された製品は廃止されます。 アクティブではなくなります。

注:

コマンドで指定された製品が、交換対象の製品となります。 たとえば、をに climbon:1.0.0 置き換える場合、コマンドで指定される climbon:1.0.1 Productはになります climbon:1.0.1。

バージョン 1.0.0 を 1.0.1 に取り替える

既存の製品を新しい製品 (通常、更新されたバージョン) にホット・リプレースするのではなく、既存の製品を新しい製品に取り替えることができます。 製品を置き換えた場合、その製品に対するすべての外部アプリケーション・サブスクリプションが、新しい製品に自動的に移動します。 製品を取り替えた場合、サブスクリプションは新しい製品に自動的に移動しないため、外部アプリケーションを取り替え先の製品にサブスクライブするには、アクションを実行する必要があります。

製品を取り替えるコマンドでは、製品を置き換えるコマンドと同じマッピング・ファイルを使用します。 コマンドには、置き換えられる製品の名前が指定されています。

apic products:supersede climbon:1.0.1 PRODUCT_PLAN_MAPPING_FILE

製品が後継製品に切り替わった後、その製品は「非推奨」とマークされます。これは、その製品への新規サブスクリプションは受け付けられなくなることを意味しますが、製品自体は引き続き利用可能であり、既存のサブスクリプションも引き続き機能します。

注： コマンドで指定されている製品は、旧製品に代わる新製品です。 たとえば、をに climbon:1.0.0 置き換える場合、コマンドで climbon:1.0.1 指定されるProductはになります climbon:1.0.1。 マッピングファイルには、置き換える製品の URL が指定されています。

マイグレーション・ターゲットの設定

既存の製品のマイグレーション・ターゲットを設定することができます。 これは、マイグレーションに役立ちます。

以下のようなコマンドを使用して、マイグレーション・ターゲットを設定します。

apic products:set-migration-target climbon:1.0.0 PRODUCT_PLAN_MAPPING_FILE

注： コマンドで指定された製品は、サブスクリプションを移行元の製品です。 マッピング・ファイルでは、サブスクリプションのターゲット製品を指定します。

移行先が設定されると、外部アプリケーション開発者は、Consumer Catalog を通じてアプリケーションのサブスクリプションを簡単に移行できるようになります。 また、次のコマンドを使用して、サブスクリプションの移行を実行することも可能です。

apic products:execute-migration-target climbon:1.0.0

製品の削除

置き換えられた製品または取り替えられた製品は、不要になった場合、削除できます。

apic products:delete climbon:1.0.0