キー管理サービス API を使用したキーの管理

IBM Cloud®Hyper Protect Crypto Services提供するキー管理サービス API暗号化キーを保存、取得、生成します。

IBM Cloud 資格情報の取得

API で作業するには、サービス資格情報と認証資格情報を生成する必要があります。資格情報を収集するには、次のようにします。

キー管理サービス API 要求の作成

サービスに対して API 呼び出しを行う場合、Hyper Protect Crypto Services のインスタンスを最初にプロビジョンした方法に応じて、API 要求を構成します。

要求を作成するには、地域のサービス・エンドポイントと適切な認証資格情報を組み合わせます。例えば、us-south 地域のサービス・インスタンスを作成した場合は、以下のエンドポイントと API ヘッダーを使用して、サービス内の鍵を表示します。

2024年4月12日以降に特定の地域でインスタンスを作成する場合は、新しい形式の新しいAPIエンドポイントを使用する必要があります。<instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud。利用可能日は地域によって異なります。サポートされている地域、利用可能日、新しいエンドポイントURLの詳細については、以下を参照してください。新しいエンドポイント。

curl -X GET \
    https://<INSTANCE_ID>.api.us-south.hs-crypto.appdomain.cloud/api/v2/keys \
    -H 'accept: application/vnd.ibm.collection+json' \
    -H 'authorization: Bearer <access_token>' \
    -H 'bluemix-instance: <instance_ID>'

<port> を API エンドポイントのポート番号に置き換えます。あなたは <port> プロビジョニングされたサービスインスタンスダッシュボードで概要>キー管理エンドポイント URL。または、動的に APIエンドポイントURLを取得する。

Hyper Protect Crypto Services インスタンスのポート範囲は 8000- 19999 の間であることに注意してください。

返される値には、以下が含まれます。
```
{
  "instance_id": "<instance_ID>",
  "kms": {
    "public": "<instance_ID>.api.<region>.hs-crypto.appdomain.cloud",
    "private":"<instance_ID>.api.private.<region>.hs-crypto.appdomain.cloud"
  },
    "ep11": {
    "public": "<instance_ID>.ep11.<region>.hs-crypto.appdomain.cloud",
    "private":"<instance_ID>.ep11.private.<region>.hs-crypto.appdomain.cloud"
  }
}
```
キー管理サービスの場合は、kms セクションの <region> および <instance_ID> を使用します。
<access_token> と <instance_ID> を、リトリーブしたサービスと認証資格情報に置き換えます。

何か問題が起こった場合に API 要求を追跡する必要があるときは、 cURL 要求の一部として -v フラグを組み込むと、応答ヘッダーに correlation-id 値が含まれます。この値を使用して、デバッグ目的で、要求の相互関連付けおよび追跡を行うことができます。

次の作業

暗号鍵とデータの管理を開始する準備が整いました。プログラムによるキーの管理の詳細については、キー管理サービスAPIリファレンスドキュメントを確認してください。