メインコンテンツへスキップ

ログイン認証情報を保存する

信頼できるPython環境（個人用ノートパソコンやワークステーションなど）で作業している場合は、save_account() メソッドを使用して認証情報をローカルに保存し、それを使用してサービスを初期化することができます。

注意事項
  • 公共のコンピューターやその他の信頼できない環境を使用している場合は、代わりに信頼できない環境でのサービスの初期化の手順に従ってください。
  • QiskitではなくREST APIを使用して接続する場合は、こちらの手順に従ってください。
  • 必要に応じて、この情報を参照してファイアウォールを設定し、IBM Quantum APIエンドポイントへのアクセスを有効にしてください。

始める前に​

  1. IBM Cloudアカウントをお持ちであることを確認してください。
  2. Qiskit SDKとQiskit RuntimeがインストールされたアクティブなPython環境で作業していることを確認してください。
  3. Python仮想環境をアクティブにして、仮想環境内でPythonを実行してください。
  4. IBMidまたはGoogleアカウントでIBM Quantum Platformにログインしてください。

アクセス認証情報を確認する​

  1. ヘッダーのアカウント切り替えで、正しいアカウントとリージョンが選択されていることを確認してください。
  2. APIキーを確認してください。ダッシュボードでAPIキーを作成し、認証に使用できるよう安全な場所にコピーしてください。なお、同じAPIキーを使用してどのリージョンにも接続できます。
  3. 任意：使用するインスタンスをインスタンスページから確認してください。そのCRNにカーソルを合わせ、コピーアイコンをクリックして、インスタンスを識別するために使用できるよう安全な場所に保存してください。

アクセス認証情報を保存する​

保存したいアカウントごとに1回、適切なコードを実行して認証情報を保存してください。認証情報を保存した後は、Qiskit Runtimeサービスの初期化の手順に従って認証情報を読み込んでください。

特定のインスタンスにアクセスする認証情報を保存する:​

複数のインスタンスがあり、Qiskit Runtimeに使用するインスタンスを簡単に指定したい場合は、インスタンスCRNを含む認証情報を保存してください。

from qiskit_ibm_runtime import QiskitRuntimeService

QiskitRuntimeService.save_account(
  token="<your-api-key>", # Use the 44-character API_KEY you created and saved from the IBM Quantum Platform Home dashboard
  name="<account-name>", # Optional
  instance="<IBM Cloud CRN or instance name>", # Optional
  set_as_default=True, # Optional
  overwrite=True, # Optional
)

自動インスタンス選択のための認証情報を保存する:​

インスタンスCRNを指定せずにこれらの認証情報をQiskit Runtimeに渡すと、指定されたオプションに基づいて適切なインスタンスが自動的に選択されます。

from qiskit_ibm_runtime import QiskitRuntimeService

QiskitRuntimeService.save_account(
  token="<your=api-key>", # Use the 44-character API_KEY you created and saved from the IBM Quantum Platform Home dashboard
  name="<account-name>", # Optional
  instance="<instance-to-use>", # Optional
  plans_preference="<plan_types>", # Optional
  region="<region>", # Optional
  tags="<instance-tags>", # Optional
  set_as_default=True, # Optional
  overwrite=True, # Optional
)

利用可能なオプション​

  • token: IBM Cloud APIキー。トークンは機密情報です。パブリックなコードでトークンを共有しないでください。
  • instance: IBM Cloud CRNまたはインスタンス名を使用して、使用するインスタンスをオプションで指定します。
  • plans_preference: 優先するプランの種類をオプションで設定します。インスタンスが指定されている場合は無視されます。使用可能なオプションは open、pay-as-you-go、flex、premium、on-prem です。プラン名が指定されていない場合、そのプランタイプのインスタンスは除外されます。例えば、[open] を渡すと、Open Planのインスタンスのみが利用可能になります。instance が指定されている場合は無視されます。
  • region: 使用するリージョンをオプションで設定します。使用可能な値は us-east および eu-de です。instance が指定されている場合は無視されます。
  • tags: インスタンスのタグをオプションで指定します。タグ名の文字列のリストを受け付けます。instance が指定されている場合は無視されます。
  • name: このアカウント認証情報のセットにオプションで名前を付けます。
  • set_as_default: この認証情報をデフォルトとして保存するには、値を True に設定してください。アカウントを1つだけ保存した場合は、自動的にデフォルトとして設定されます。
  • overwrite: デフォルトの認証情報を更新するには、この値を True に設定してください。

例​

例1​

この例では、オープンアクセスとプレミアムアクセスを許可する特定のインスタンスの認証情報を保存します。オープンの認証情報がデフォルトとして設定されます。

from qiskit_ibm_runtime import QiskitRuntimeService

QiskitRuntimeService.save_account(token="<API_TOKEN>", instance="<CRN_for_premium_instance>",
                                  name="premium")
QiskitRuntimeService.save_account(token="<API_TOKEN>", instance="<CRN_for_open_instance>",
                                  name="open", set_as_default=True)

例2​

この例では、自動インスタンス選択のための認証情報を保存します。Qiskit Runtimeは、アカウントで利用可能なEUリージョンのプレミアムインスタンスのみを検索します。この認証情報が新しいデフォルトになります。

QiskitRuntimeService.save_account(
    token="your-api-key",
    set_as_default=True,
    overwrite = True,

    # Set instance "filters" instead of specifying the instance:
    region="eu-de",
    plans_preference=["premium"]
  )

保存された認証情報を確認する​

保存したすべての認証情報を表示するには、service.saved_accounts() を実行してください。デフォルトの認証情報を保存して名前を付けなかった場合は、default-ibm-quantum-platform という名前が付きます。デフォルトの認証情報に名前を付けた場合は、出力に "is_default_account": true が表示されます。

注意事項​

  • 複数のアカウントを保存する場合は、name パラメーターを使用して区別してください。
  • 認証情報は $HOME/.qiskit/qiskit-ibm.json に保存されます。このファイルを手動で編集しないでください。
  • 認証情報を保存しない場合は、新しいセッションを開始するたびに（Qiskit Runtimeサービスをインスタンス化するたびに）認証情報を指定する必要があります。
  • 認証情報を手動で指定した場合、保存されたアカウントは使用されません。

次のステップ

推奨事項