export-entity コマンドの使用

apic login --server management_server --realm provider/identity_provider --username provider_username --password provider_password

次のコマンドを入力して、使用可能なすべての ID プロバイダーのリストを表示することで、--realm パラメーターで使用する ID プロバイダーを判別できます (このコマンドを使用するためにログインする必要はありません)。

apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm

例:

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

title 値により、使用する ID プロバイダーを判別できます。その後に、表示された realm 値から対応する --realm パラメーターを直接コピーできます。 API Connect のインストール後に管理者によって作成された ID プロバイダーの場合、名前は作成時に決定されます。 プロバイダー組織のメンバーとしてログインするためのデフォルトの API Manager ローカル・ユーザー・レジストリーは default-idp-2 です。

apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name export-entity:create --export_entity_name "export_entity_name"

各項目の意味は次のとおりです。

• management_server は管理サーバーのエンドポイント URL です（必須）。
• orgid/name は、カタログが属しているプロバイダー組織の ID または名前です (必須)。
• catalogid/name は、サイトが属しているカタログの ID または名前です (必須)。
• export_entity_name は、作成したいエクスポート・エンティティーの名前です。 この名前は固有 ID ではないことに注意してください。

このコマンドは、新しく作成されたエクスポート・エンティティーの ID を返します。 例：

apic --mode portaladmin --server my_management_server --org my_org --catalog my_catalog export-entity:create --export_entity_name "Main Content"
[notice] Created new export entity Main Content, id 5

返された ID 番号を個別にメモします。この ID は今後のコマンドで必要になります。

apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name export-entity:list

このコマンドは、使用可能なエクスポート・エンティティーのリスト (ID、およびそれらが作成された日時を含む) を返します。 例：

apic --mode portaladmin --server my_management_server --org my_org --catalog my_catalog export-entity:list
-
  id: '5'
  name: 'Main Content'
  created_time: '2023-09-12 15:05:04'

apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name export-entity:add-content --export_entity_id export_entity_id --entity_type entity_type_name --entity_ids entity_ids

各項目の意味は次のとおりです。

• export_entity_id は、エクスポート・エンティティーの ID です (必須)。
• entity_type_name は、エクスポート・エンティティーに追加するコンテンツ・エンティティーのタイプです (必須)。 content:list-types コマンドを使用して、サイトからエクスポート可能なコンテンツ・エンティティーのタイプを見つけることができます。 コンテンツ・コマンドの使用を参照してください。
• entity_ids は、エクスポート・エンティティーに追加するエンティティー ID をコンマで区切ったリストです (オプション)。 特定のエンティティー・タイプのすべてのコンテンツ・エンティティーを追加する場合は、エンティティー ID を設定する必要はありません。

以下の例は、エクスポート・エンティティー 5に追加される 3 つの異なるタイプのエンティティー・コンテンツを示しています。

apic --mode portaladmin --server my_management_server --org my_org --catalog my_catalog export-entity:add-content --export_entity_id 5 --entity_type node --entity_ids 1,2
[notice] Successfully added entity type node - "1, 2" to export entity 5

apic --mode portaladmin --server my_management_server --org my_org --catalog my_catalog export-entity:add-content --export_entity_id 5 --entity_type block_content --entity_ids 1,2
[notice] Successfully added entity type block_content - "1, 2" to export entity 5

apic --mode portaladmin --server my_management_server --org my_org --catalog my_catalog export-entity:add-content --export_entity_id 5 --entity_type shortcut --entity_ids 1
[notice] Successfully added entity type shortcut - "1" to export entity 5

apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name export-entity:remove-content --export_entity_id export_entity_id --entity_type entity_type_name --entity_ids entity_ids

各項目の意味は次のとおりです。

• export_entity_id は、エクスポート・エンティティーの ID です (必須)。
• entity_type_name は、削除するコンテンツ・エンティティーのタイプです (必須)。
• entity_ids は、削除するエンティティー ID をコンマで区切ったリストです (オプション)。 特定のエンティティー・タイプのすべてのコンテンツ・エンティティーを削除する場合は、エンティティー ID を設定する必要はありません。

例えば、コンテンツ・エンティティー・タイプ shortcut のエンティティー ID 1 をエクスポート・エンティティー 5から削除するには、次のコマンドを実行します。

apic --mode portaladmin --server my_management_server --org my_org --catalog my_catalog export-entity:remove-content --export_entity_id 5 --entity_type shortcut --entity_ids 1
[notice] Successfully removed entity type shortcut - "1" from export entity 5

apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name export-entity:get --export_entity_id export_entity_id

次の例では、エクスポート・エンティティー 5 に 4 つの異なるコンテンツ・エンティティーが含まれています。

apic --mode portaladmin --server my_management_server --org my_org --catalog my_catalog export-entity:get --export_entity_id 5
- bundle: basic
  id: "1"
  title: No Apps Found [en]
  type: block_content
- bundle: page
  id: "1"
  title: Terms of use
  type: node
- bundle: basic
  id: "2"
  title: No Apis Found [en]
  type: block_content
- bundle: page
  id: "2"
  title: Privacy Policy
  type: node
  

apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name export-entity:launch --export_entity_id export_entity_id

各項目の意味は次のとおりです。

• --no-poll はオプションのフラグで、コマンドがタスクの状況をポーリングせず、単にタスク ID を返すことを意味します。 その後、このタスク ID を export-entity:get-export コマンドで使用して、エクスポート・ファイルを返すことができます。

以下の例では、エクスポート・エンティティー 5の内容をエクスポートします。

apic --mode portaladmin --server my_management_server --org my_org --catalog my_catalog export-entity:launch --export_entity_id 5
201 CREATED - TASK ID: saleo5261k5a2y

Response Code - 202:

Message(s) -
The status of this task is: QUEUED

Response Code - 200:

Message(s) -
The status of this task is: FINISHED and the artifact can now be streamed

Saving File (Large files may take a while)...
Incoming project saved to export_entity_launchExport-20230912165
  

このコマンドは、実行中のディレクトリーにエクスポートを保存します。 エクスポート .tgz ファイルには、 .tgz ファイルに含まれているすべてのエンティティーの索引と、エクスポートされた各コンテンツ・エンティティー・タイプの content_entity_type.json ファイルを含む root.json ファイルが含まれています。 content_entity_type.json ファイルには、これらのエンティティーを別の 開発者ポータル ・サイトにインポートするために必要なすべての情報が含まれています。