開発者ポータル CLI コマンド

開発者ポータル CLI でサポートされているコマンドの要約。

認証

認証するには apic login コマンドを使用し、ローカル認証資格情報を削除するには apic logout コマンドを使用します。 詳しくは、 ポータル CLI コマンドの概要を参照してください。

注: 正常に認証されると、資格情報はプレーン・テキストでファイル [Icon indicating that this applies on Linux platforms].netrc または [Icon indicating that this applies on Windows platforms]_netrcに保管されます。 このため、資格情報に他のユーザーがアクセスできないようにファイル許可を設定する必要があります。

コマンドの要約

以下の表に、apic --mode portaladmin コマンドの要約を示します。

表 1. portaladmin コマンドの要約
コマンド 説明 サブコマンド(S)
apic api api を管理します。
  • apic api:add-attachment -API の添付ファイルを追加します
  • apic api:add-tag -API のタグを追加します。
  • apic api:get - ポータル・サービスから API を取得します。
  • apic api:get-document -指定された組織およびカタログのポータルから特定の API 文書全体を取得します。
  • apic api:list -指定された組織およびカタログの API をリストします。
  • apic api:set-icon -API のアイコンを設定します。

詳しくは、 API コマンドの使用を参照してください。

apic apic-config apic-config を管理します。
  • apic apic-config:get - サイトの構成を取得します。

詳しくは、 apic-config コマンドの使用を参照してください。

apic application application を管理します。
  • apic application:get - ポータル・サービスからアプリケーションを取得します。
  • apic application:list - ポータル・サービスのアプリケーションをリストします。

詳しくは、 アプリケーション・コマンドの使用を参照してください。

apic consumer-org apic consumer-org を管理します。
  • apic consumer-org:get - ポータル・サービスからコンシューマー組織を取得します。
  • apic consumer-org:list - ポータル・サービスのコンシューマー組織をリストします。

詳しくは、 consumer-org コマンドの使用を参照してください。

apic content content エンティティー・タイプを管理します。
  • content:create-export -サイト・コンテンツ・エンティティーを含む .tgz ファイルをエクスポートするタスクを作成します。
  • content:create-import -サイト・コンテンツのアーカイブをインポートするタスクを作成します。
  • content:delete-export -現在実行中の content:create-export タスクをキャンセルし、関連成果物を削除します。
  • content:delete-import -現在実行中の content:create-import タスクをキャンセルし、関連成果物を削除します。
  • content:get-export-status -特定のエクスポート・タスクの状況を返します。
  • content:get-export -特定のエクスポート・タスクのコンテンツを .tgz ファイルにストリーミングします。
  • content:get-import-status -特定のインポート・タスクのステータスを返します。
  • apic content:list -指定されたコンテンツ・エンティティー・タイプのサイト内のすべてのエンティティーをリストし、必要に応じてバンドルします。
  • apic content:list-type -サイトからエクスポート可能なコンテンツ・エンティティー・タイプをリストします。

詳しくは、 コンテンツ・コマンドの使用を参照してください。

apic custom-module custom modules を管理します。
  • apic custom-module:create-export - custom moduleのエクスポートを作成します。
  • apic custom-module:create-import - custom moduleのインポートを作成します。
  • apic custom-module:delete-export - custom moduleのエクスポートを削除します。
  • apic custom-module:delete-import - custom moduleのインポートを削除します。
  • apic custom-module:get-export - custom moduleのエクスポートを取得します。
  • apic custom-module:get-export-status - custom moduleのエクスポートの状況を取得します。
  • apic custom-module:get-import-status - custom moduleのインポートの状況を取得します。

詳しくは、 カスタム・モジュール・コマンドの使用を参照してください。

apic custom-theme custom themes を管理します。
  • apic custom-theme:create-export - custom themeのエクスポートを作成します。
  • apic custom-theme:create-import - custom themeのインポートを作成します。
  • apic custom-theme:delete-export - custom themeのエクスポートを削除します。
  • apic custom-theme:delete-import - custom themeのインポートを削除します。
  • apic custom-theme:get-export - custom themeのエクスポートを取得します。
  • apic custom-theme:get-export-status - custom themeのエクスポートの状況を取得します。
  • apic custom-theme:get-import-status - custom themeのインポートの状況を取得します。

詳しくは、 カスタム・テーマ・コマンドの使用を参照してください。

apic custom-translation custom translations を管理します。
  • apic custom-translation:create-export - custom translationをエクスポートするタスクを作成します。
  • apic custom-translation:create-import - custom translationをインポートするタスクを作成します。
  • apic custom-translation:delete-export -進行中または最近作成されたエクスポート・タスクをキャンセルします。
  • apic custom-translation:delete-import -進行中または最近作成されたインポート・タスクをキャンセルします。
  • apic custom-translation:get-export - custom translation のエクスポート成果物を、指定されたタスク ID にストリームします。
  • apic custom-translation:get-export-status - custom translationのエクスポートの状況を取得します。
  • apic custom-translation:get-import-status - custom translationのインポートの状況を取得します。

詳しくは、 カスタム変換コマンドの使用を参照してください。

apic drupal-config drupal-config を管理します。
  • apic drupal-config:delete - Drupal 構成オブジェクトまたは特定の構成キーを削除します。
  • apic drupal-config:get - Drupal 構成オブジェクトのすべてのキー値、または特定の構成キー値を取得します。
  • apic drupal-config:list - Drupal 構成名を接頭部でリストするか、すべてをリストします。
  • apic drupal-config:set -新しい Drupal 構成キーと値を設定するか、既存の構成キーと値を更新します。

詳しくは、 drupal-config コマンドの使用を参照してください。

apic drupal-state drupal-state のキーと値を管理します。
  • apic drupal-state:delete -特定の Drupal 状態キーおよび値を削除します。
  • apic drupal-state:get -特定の Drupal 状態キー値を取得します。
  • apic drupal-state:set -新しい Drupal 状態キーと値を設定するか、既存の状態キー値を更新します。

詳しくは、 drupal-state コマンドの使用を参照してください。

apic entity entity を管理します。
  • apic entity:count - サイトのエンティティーのカウント。

詳しくは、 エンティティー・コマンドの使用を参照してください。

apic export-entity コンテンツ・エンティティーのエクスポートを管理します。
  • export-entity:create -新規エクスポート・エンティティーを作成します。これは、エクスポートするエンティティー・コンテンツのコンテナーです。
  • export-entity:add-content -既存のエクスポート・エンティティーにコンテンツを追加します。
  • export-entity:get -特定のエクスポート・エンティティーの内容のリストを返します。
  • export-entity:remove-content -特定のエクスポート・エンティティーから特定のコンテンツを削除します。
  • export-entity:delete -特定のエクスポート・エンティティーを削除します。
  • export-entity:launch -特定のエクスポート・エンティティーに含まれるすべてのエンティティーの .tgz ファイルを作成する、エクスポート・エンティティー・ポーリング・タスクを起動します。 --no-poll オプションを指定して実行できます。この場合、タスクは .tgz ファイルを返しませんが、単にタスク ID を返します。
  • export-entity:get-launch-export -特定の完了した export-entity:launch タスクの内容を .tgz ファイルにストリームします。
  • export-entity:delete-launch-export -現在実行中の export-entity:launch タスクをキャンセルし、関連する成果物をすべて削除します。
  • export-entity:get-launch-export-status -特定の export-entity:launch タスクの状況を返します。
  • export-entity:list -特定の 開発者ポータル内のすべてのエクスポート・エンティティーのリストを返します。 各エクスポート・エンティティーには、 export-entity:launch が実行された場合にエクスポートされるすべてのエンティティー・コンテンツの定義済みリストが含まれています。

詳しくは、 エクスポート・エンティティー・コマンドの使用を参照してください。

apic forums forums を管理します。
  • apic forums:disable -指定されたサイトのフォーラム・モジュールを無効にします。
  • apic forums:enable -指定されたサイトのフォーラム・モジュールを有効にします。

詳しくは、 フォーラム・コマンドの使用を参照してください。

apic maintenance maintenance 操作を管理します。
  • apic maintenance:disable - maintenance 操作を無効にします。
  • apic maintenance:enable - maintenance 操作を有効にします。
  • apic maintenance:rebuild_node_access - maintenance 操作のノード・アクセス・テーブルを再作成します。
  • apic maintenance:search_api_index_rebuild - maintenance 操作の検索 API 索引を再作成して再索引付けします。
  • apic maintenance:search_api_index_status - maintenance 操作の検索 API 索引状況を出力します。
  • apic maintenance:status - maintenance 操作の現行モードを取得します。

詳しくは、 保守コマンドの使用を参照してください。

apic memcache memcache 操作を管理します。
  • apic memcache:disable -デフォルトのキャッシュ・ストア操作を無効にします。 これにより、データベースをキャッシュとして使用するように Drupal が設定されます。
  • apic memcache:enable -デフォルトのキャッシュ・ストア操作を有効にします。 これにより、RAM をキャッシュとして使用するように Drupal が設定されます。
  • apic memcache:get - memcache enabled 操作の状況を取得します。

詳しくは、 memcache コマンドの使用を参照してください。

apic modules modules を管理します。
  • apic modules:delete - modulesを削除します。
  • apic modules:disable - modulesを無効にします。
  • apic modules:enable - modulesを有効にします。
  • apic modules:list - modulesのリストを取得します。

詳しくは、 モジュール・コマンドの使用を参照してください。

apic product product を管理します。
  • apic product:add-attachment -指定された製品の添付ファイルを追加します。
  • apic product:add-tag -指定された製品のタグを追加します。
  • apic product:get - ポータル・サービスから製品を取得します。
  • apic product:get-document -指定された組織およびカタログのポータルから特定の製品文書全体を取得します。
  • apic product:list - ポータル・サービスの製品をリストします。
  • apic product:set-icon -指定された商品のアイコン・イメージを設定します。

詳しくは、 製品コマンドの使用を参照してください。

apic queue ポータル queueでタスクを表示します。
  • apic queue:get -特定の 開発者ポータル ・サイトの、キューに入れられてロックされているプラットフォーム関連のタスクを表示します。

詳しくは、 キュー・コマンドの使用を参照してください。

apic role role 操作を管理します。
  • apic role:create -新しい Drupal ユーザー役割を作成します。
  • apic role:delete -不要な Drupal ユーザー役割を削除します。
  • apic role:add-permission - Drupal ユーザー役割に特定の権限を追加します。
  • apic role:remove-permission - Drupal ユーザー役割から不要な権限を削除します。
  • apic role:get - Drupal ユーザー役割の詳細と、特定の役割に付与されているすべての権限を取得します。
  • apic role:list -すべての役割をリストします。 role:list コマンドとともに対応するフラグを使用して、ユーザー役割および許可に基づいてリストをフィルターに掛けることができます。 指定された権限を持つ役割のリストを取得するには、 --filter_by_permission フラグを使用します。 指定された役割に付与されている許可のリストを取得するには、 --role フラグを使用します。

詳しくは、 役割コマンドの使用を参照してください。

apic security security を管理します。
  • apic security:clear-bans -ポータル・サイトで禁止されているすべてのユーザー /IP アドレスをクリアします。

詳しくは、 セキュリティー・コマンドの使用を参照してください。

apic site site を管理します。
  • site:cache-rebuild -ポータル・サイトのキャッシュを再作成します。
  • apic site:check -ポータル・サイトに対してプラットフォーム・チェックを実行します。
  • apic site:state -ポータル・サイトの現在の状態を取得します。
  • apic site:login-link -特定のポータル・サイトの管理者ログイン・リンクを取得します。
  • site:create-export -サイト構成全体の .tgz アーカイブ・ファイルをエクスポートするタスクを作成します。
  • site:create-import -サイト構成全体のアーカイブをインポートするタスクを作成します。
  • site:delete-export -現在実行中の site:create-export タスクをキャンセルし、関連成果物を削除します。
  • site:delete-import -現在実行中の site:create-import タスクをキャンセルし、関連成果物を削除します。
  • site:get-export-status -特定のエクスポート・タスクの状況を返します。
  • site:get-export -特定の完了したエクスポート・タスクのコンテンツを .tgz ファイルにストリーミングします。
  • site:get-import-status -特定のインポート・タスクのステータスを返します。
重要: サイト・エクスポート構成ファイルをインポートする場合は、インポート先のバージョンと同じバージョンの API Connect でエクスポート・ファイルが作成されている必要があります。

詳しくは、「 サイト・コマンドの使用」を参照してください。

apic site-config site-config を管理します。
  • apic site-config:create-export - site configのエクスポートを作成します。
  • apic site-config:create-import - site configのインポートを作成します。
  • apic site-config:delete-export - site configのエクスポートを削除します。
  • apic site-config:delete-import - site configのインポートを削除します。
  • apic site-config:get-export - site configのエクスポートを取得します。
  • apic site-config:get-export-status - site configのエクスポートの状況を取得します。
  • apic site-config:get-import-status - site configのインポートの状況を取得します。

詳しくは、 site-config コマンドの使用を参照してください。

apic themes themes を管理します。
  • apic themes:delete - themesを削除します。
  • apic themes:disable - themesを無効にします。
  • apic themes:enable - themesを有効にします。
  • apic themes:list - themesのリストを取得します。
  • apic themes:set-default - ポータルのデフォルト・テーマを設定します。

詳しくは、「 テーマ・コマンドの使用」を参照してください。

apic twig 特定のポータル・サイトでの twig デバッグ操作を管理します。
  • apic twig:debug-enable -ポータル・サイトの twig デバッグを有効にします。
  • apic twig:debug-disable -ポータル・サイトの twig デバッグを無効にします。
  • apic twig:debug-status -特定のサイトの twig デバッグの現在の状態を取得します。

詳しくは、 twig コマンドの使用を参照してください。

apic user 一部の 開発者ポータル user ・タスクを管理します。
  • apic user:add-role -1 つ以上の指定されたユーザー・アカウントに 1 つ以上の役割を追加します。
  • apic user:block -1 人以上のユーザーをブロックします。
  • apic user:information -ユーザーに関する情報を取得します。
  • apic user:remove-role -1 つ以上の指定されたユーザー・アカウントから 1 つ以上の役割を削除します。
  • apic user:unblock -1 人以上のユーザーのブロックを解除します。

詳しくは、 ユーザー・コマンドの使用を参照してください。

apic version API Connect ツールキットのバージョンを取得します。
  • apic version --mode portaladmin -ツールキットのバージョンを取得します。