IBM Cloud Docs
IBM Cloud Hyper Protect DBaaS CLI プラグイン

IBM Cloud Hyper Protect DBaaS CLI プラグイン

Hyper Protect DBaaS が非推奨になりました。 2023 年 4 月 15 日以降、新規インスタンスを作成できなくなり、無料インスタンスへのアクセス権限が削除されます。 既存の有料インスタンスは、2023 年 11 月 30 日までサポートされます。 既存のインスタンスは 2024 年 3 月 1 日に削除されます。

この CLI バージョン 2.0 では、他の CLI プラグインとの調整のために、入力パラメーター --output json が JSON 出力を返す必要があります。 これにより、自動化の実行が中断される可能性があります。 バージョン 1.x ( 非推奨) をまだ使用している場合は、コマンドでこのオプションを省略してください。 バージョン 2.0 のもう 1 つの変更点は、コマンド名に -list および -show が含まれなくなったことです (例えば、ibmcloud dbaas cluster-showibmcloud dbaas cluster になりました)。 古いコマンド名は推奨されませんが、引き続き機能します。

IBM Cloud® Hyper Protect DBaaS CLI プラグインを使用して、クラスター、データベース、ユーザー、およびノードに関する情報の取得、ログ・ファイルのリスト表示とダウンロード、リソースのスケーリング、構成の更新、データベースのバックアップとリストア、およびタスクの状況の確認を行います。

前提条件

  1. IBM Cloud CLI をインストールします。IBM Cloud CLI をインストールするには、Java SDK 1.7.0 が必要です。 IBM Cloud CLI を使用してコマンドを実行するための接頭部は、ibmcloud です。 ibmcloud CLI およびプラグインの更新が使用可能になると、端末に通知が表示されます。 使用可能なすべてのコマンドおよびフラグを使用できるように、CLI を最新の状態に保つようにしてください。

  2. IBM Cloud Hyper Protect DBaaS CLI プラグインをインストールします。 詳しくは、Hyper Protect DBaaS for MongoDB CLI プラグインのインストールまたは Hyper Protect DBaaS for PostgreSQL CLI プラグインのインストールを参照してください。 ご使用の Hyper Protect DBaaS の現行バージョンを表示する場合 CLI プラグイン、 ibmcloud plugin show dbaasを実行します。

CLI プラグイン使用方法コマンド

ibmcloud dbaas help

このコマンドは DBaaS コマンドのリストを表示します。

ibmcloud help dbaas

返されるリストでは、一部のコマンドについては、2 つのコマンド名 (例えば、cluster, cluster-showdatabases, databases-list) が表示されます。 -show および -list が指定されているコマンド名は古いコマンド名です。これらは非推奨ですが、引き続き機能します。 以下のセクションで説明するように、-list および -show を指定せずに新しいコマンドを使用することをお勧めします。

クラスター・コマンド

ibmcloud dbaas cluster

このコマンドは、各ノードに関する情報を含む、データベース・クラスターに関する詳細情報を表示します。

ibmcloud dbaas cluster RESOURCE_NAME [--output json]

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。 リソース名を確認するには、IBM Cloud コマンドの ibmcloud resource service-instances を使用します。
--output
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

ibmcloud dbaas resource-scale

このコマンドは、クラスター・リソース (ディスク、RAM、または vCPU) をスケーリングします。 有効な値の範囲については、値の表 (MongoDB でも PostgreSQL でも同じ) を参照してください。

ibmcloud dbaas resource-scale RESOURCE_NAME [--cpu|-c NUM_CPU] [--memory|-m MEM_GIB] [--storage|-s STORAGE_GIB] [--force] [--output json]

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--cpu value
専用 CPU コアの総数。
--memory value
GiB 単位のメモリー割り振りの合計。 例えば、--memory 4 です。
--storage value
GiB 単位のストレージ割り振りの合計。 例えば、--storage 10 です。
--force
y/N の確認なしで強制的にスケーリングします。
--output
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

データベース・コマンド

ibmcloud dbaas databases

このコマンドは、クラスター上のすべてのデータベースのリストを表示します。

ibmcloud dbaas databases RESOURCE_NAME [--output json]

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--output
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

データベース構成コマンド ( PostgreSQLの場合)

ibmcloud dbaas configuration

このコマンドはデータベース構成の詳細を表示します。

ibmcloud dbaas configuration RESOURCE_NAME [--output json]

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--output
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

ibmcloud dbaas configuration-update

このコマンドは JSON ファイルまたは JSON ストリングから変更を送信して、データベース構成を更新します。

ibmcloud dbaas configuration-update RESOURCE_NAME [@JSON_FILE | JSON_STRING] [-f | --force] [--output json]

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。

構成パラメーターはすべて整数です。 JSON ファイルまたはストリングで単位を指定しないでください。

@JSON_FILE
データベース構成を含む JSON ファイル。 以下に例を示します。
ibmcloud dbaas configuration-update MyDBaaSIns03 @./conf.json

JSON ファイルの内容:

{
    "configuration":{
        "max_locks_per_transaction":150,
        "deadlock_timeout":1500,
        "shared_buffers":256,
        "max_connections":115
        
    }
}

設定のうち 1 つのみ更新しようとしている場合は、ファイル内で更新対象の 1 つの設定だけ指定できます。 以下に例を示します。

{
    "configuration":{
        "max_locks_per_transaction":150
    }
}
JSON_STRING
JSON ファイルに送信するパラメーターの変更内容。 例えば、'{"configuration":{"max_locks_per_transaction":150}}' (Windows の場合は、"{\"configuration\": {\"max_locks_per_transaction\": 150}}" を使用) のようになります。 ibmcloud dbaas configuration コマンドを使用して、構成可能パラメーターのリストを取得できます。
-f, --force
確認のプロンプトを出さずに構成の更新を強制します。
--output
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

データベース・ユーザー・コマンド

ibmcloud dbaas users

このコマンドはすべてのデータベース・ユーザーのリストを表示します。

ibmcloud dbaas users RESOURCE_NAME [--output json]

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--output
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

ibmcloud dbaas user

このコマンドはデータベース・ユーザーの詳細を表示します。

ibmcloud dbaas user RESOURCE_NAME AUTHDB_USER_NAME [--output json]

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
AUTHDB_USER_NAME
詳細を取得する対象ユーザーのユーザー名。 ibmcloud dbaas users コマンドを使用して、クラスターのユーザーのリストを取得できます。
--output
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

ログ・コマンド

ibmcloud dbaas log-get

このコマンドは、ノードからログ・ファイルをダウンロードします。

ibmcloud dbaas log-get RESOURCE_NAME NODE_ID FILE_NAME

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
NODE_ID
ノードの ID。
FILE_NAME
ダウンロードするログ・ファイルの名前。 ibmcloud dbaas logs コマンドを使用して、ノード上の既存のログ・ファイルのリストを取得できます。

ibmcloud dbaas logs

このコマンドはノード上のすべてのログ・ファイルのリストを表示します。 リストされたファイル名を ibmcloud dbaas log-get コマンドへの入力として使用できます。

ibmcloud dbaas logs RESOURCE_NAME NODE_ID [--output json]

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
NODE_ID
ノードの ID。
--output
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

タスク・コマンド

ibmcloud dbaas tasks

このコマンドは、クラスター上で実行中である、または最近実行されたすべてのタスクをリストします。

ibmcloud dbaas tasks RESOURCE_NAME [--output json]

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--output
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

ibmcloud dbaas task

このコマンドはタスクの詳細を表示します。

ibmcloud dbaas task RESOURCE_NAME TASK_ID [--output json]

コマンド・オプション

RESOURCE_NAME
DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
TASK_ID
タスクの ID。
--output
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

バックアップとリストアのコマンド

ibmcloud dbaas help backupを使用して、バックアップ・コマンドとリストア・コマンドのリストを表示します。backupは、すべてのバックアップ・コマンドとリストア・コマンドを含むサブ名前空間です。

ibmcloud dbaas backup enable

このコマンドは、データベース・クラスターのバックアップを有効にします。

ibmcloud dbaas backup enable RESOURCE_NAME --cos-hmac-credentials-path CREDENTIALS_PATH --cos-endpoint COS_ENDPOINT --cos-bucket-crn BUCKET_CRN [--cos-frequency FREQUENCY] [--output json]

コマンド・オプション

RESOURCE_NAME
ソース DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--cos-hmac-credentials-path value
JSON 形式の HMAC 資格情報 (access_key_idおよびsecret_access_key) を含むファイルへのパス。 サービス資格情報の作成時に、 「HMAC 資格情報を含める」「オン」 を設定したことを確認します。 資格情報を見つけるには、 IBM Cloud Object Storage Web UI で 「サービス資格情報」 を選択します。 そこからコピーされた完全な JSON を含むファイルを作成するか、少なくとも以下の例の内容を含むファイルを作成します。 また、 HMAC 資格情報を環境変数として設定し 、このコマンド・オプションを省略することもできます。

HMAC 資格情報の例:

{
    "cos_hmac_keys": {
      "access_key_id": "abc",
      "secret_access_key": "xyz"
    }
}
--cos-endpoint value
IBM Cloud Object Storage のエンドポイント (必須)。 IBM Cloud Object Storage Web UI でバケットを選択すると、構成タブにエンドポイントが表示されます。 現時点では、パブリック・エンドポイントのみがサポートされています。 プライベート・エンドポイントのサポートはまもなく提供されます。
--cos-bucket-crn value
IBM Cloud Object Storage バケット CRN (必須)。 IBM Cloud Object Storage Web UI でバケットを選択すると、構成タブにバケット・インスタンス CRN が表示されます。
--cos-frequency value
IBM Cloud Object Storageへのバックアップの頻度。 デフォルト値は 8 時間です。 このオプションは、 ** PostgreSQLでのみ使用できます**。 有効な値は、 1h2h4h8h1d2d、および 1wです。
--output value
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

ibmcloud dbaas backup disable

このコマンドは、データベース・クラスターのバックアップを無効にします。

ibmcloud dbaas backup disable RESOURCE_NAME [--output json]

コマンド・オプション

RESOURCE_NAME
ソース DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--output value
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

ibmcloud dbaas backup list

このコマンドは、データベース・クラスターの ローカル ( IBM Cloud Object Storageではない) バックアップをリストします。

ibmcloud dbaas backup list RESOURCE_NAME [--output json]

コマンド・オプション

RESOURCE_NAME
ソース DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--output value
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

ibmcloud dbaas backup restore

このコマンドは、データベース・クラスターのローカル・ストレージまたは IBM Cloud Object Storage からバックアップをリストアします。 バックアップを新しいサービス・インスタンスにリストアするには、最初に新しいサービス・インスタンスを作成します。

ローカル・ストレージからのリストア:

ローカル・バックアップは、現在のサービス・インスタンスにのみリストアできます。

ibmcloud dbaas backup restore RESOURCE_NAME --local-backup-id LOCAL_BACKUP_ID [--output json]

IBM Cloud Object Storageからリストアします。

バックアップを新しいサービス・インスタンスにリストアするには、最初に新しいサービス・インスタンスを作成します。

ibmcloud dbaas backup restore RESOURCE_NAME --cos-hmac-credentials-path CREDENTIALS_PATH --cos-endpoint COS_ENDPOINT --cos-bucket-crn BUCKET_CRN --cos-backup-file FILE_NAME [--output json]

コマンド・オプション

RESOURCE_NAME
ターゲット DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--output value
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

ローカル・ストレージからのリストア:

--local-backup-id value
リストアされるローカル・バックアップの ID (必須)。 ibmcloud dbaas backup list コマンドを使用して、ローカル・バックアップのリストを取得できます。

IBM Cloud Object Storageからリストアします。

--cos-hmac-credentials-path value
JSON 形式の HMAC 資格情報 (access_key_idおよびsecret_access_key) を含むファイルへのパス。 資格情報を見つけるには、IBM Cloud Object Storage Web UI でサービス資格情報を選択します。 そこからコピーされた完全な JSON を含むファイルを作成するか、少なくとも以下の例の内容を含むファイルを作成します。 また、 HMAC 資格情報を環境変数として設定このコマンド・オプションを省略することもできます。

HMAC 資格情報の例:

{
    "cos_hmac_keys": {
      "access_key_id": "abc",
      "secret_access_key": "xyz"
    }
}
--cos-endpoint value
IBM Cloud Object Storage のエンドポイント (必須)。 IBM Cloud Object Storage Web UI でバケットを選択すると、構成タブにエンドポイントが表示されます。 現時点では、パブリック・エンドポイントのみがサポートされています。 プライベート・エンドポイントのサポートはまもなく提供されます。
--cos-bucket-crn value
IBM Cloud Object Storage バケット CRN (必須)。 IBM Cloud Object Storage Web UI でバケットを選択すると、構成タブにバケット・インスタンス CRN が表示されます。
--cos-backup-file value
リストアされるバックアップ・ファイルの名前 (必須)。 バックアップ・ファイル名は、バックアップが生成された日時 yyyy-mm-dd-hhmmssZ (UTC) を識別します。 以下のいずれかの方法で、COS バックアップ・ファイルのリストを取得できます。
  1. UI を使用する。 IBM Cloud Object Storage Web UI でバケットを選択すると、オブジェクト・タブのオブジェクト名列に使用可能なファイル名が表示されます。
  2. IBM Cloud Object Storage CLI プラグインを使用します。
  3. IBM Cloud Object Storage プラグインをインストールして構成します
  4. ibmcloud cos objects --bucket BUCKET コマンドを使用して、バックアップ・ファイルをリストします。

ibmcloud dbaas backup configuration

このコマンドは、データベース・クラスターのバックアップ構成を表示します。

ibmcloud dbaas backup configuration RESOURCE_NAME [--output json]

コマンド・オプション

RESOURCE_NAME
ソース DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--output value
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。

ibmcloud dbaas backup configure

このコマンドは、データベース・クラスターのバックアップの構成を IBM Cloud Object Storage に変更します。

ibmcloud dbaas backup configure RESOURCE_NAME [--cos-hmac-credentials-path CREDENTIALS_PATH --cos-endpoint COS_ENDPOINT --cos-bucket-crn BUCKET_CRN] [--cos-frequency FREQUENCY] [--output json]

コマンド・オプション

RESOURCE_NAME
ソース DBaaS サービス・インスタンスの名前または CRN。 リソース名または CRN を見つけるには、IBM Cloud コマンドibmcloud resource service-instances --longを使用します。
--cos-hmac-credentials-path value
JSON 形式の HMAC 資格情報 (access_key_idおよびsecret_access_key) を含むファイルへのパス。 資格情報を見つけるには、IBM Cloud Object Storage Web UI でサービス資格情報を選択します。 そこからコピーされた完全な JSON を含むファイルを作成するか、少なくとも以下の例の内容を含むファイルを作成します。 また、 HMAC 資格情報を環境変数として設定このコマンド・オプションを省略することもできます。

HMAC 資格情報の例:

{
    "cos_hmac_keys": {
      "access_key_id": "abc",
      "secret_access_key": "xyz"
    }
}
--cos-endpoint value
IBM Cloud Object Storageのエンドポイント。 --cos-bucket-crn が設定されている場合、このパラメーターは必須です。 IBM Cloud Object Storage Web UI で、バケットを選択します。 「構成」 タブに 「エンドポイント」 が表示されます。 現時点では、パブリック・エンドポイントのみがサポートされています。 プライベート・エンドポイントのサポートはまもなく提供されます。
--cos-bucket-crn value
IBM Cloud Object Storage バケット CRN。 --cos-endpoint が設定されている場合、このパラメーターは必須です。 IBM Cloud Object Storage Web UI でバケットを選択すると、 「構成」 タブに バケット・インスタンス CRN が表示されます。
--cos-frequency value
IBM Cloud Object Storageへのバックアップの頻度。 このオプションは、 ** PostgreSQLでのみ使用できます**。 ibmcloud dbaas backup configuration コマンドを使用して、現行値を取得できます。 有効な値は、 1h2h4h8h1d2d、および 1wです。
--output value
JSON で出力をフォーマットするには、値 json を指定して --output オプションを使用します。