ルート鍵に関連付けられた保護リソースの表示

1. UI にログインします。

2. 「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。

3. IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。

4. **「KMS 鍵 (KMS keys)」ページで、「鍵」**テーブルを使用して、このサービスの鍵を参照します。

5. 特定のルート・キーの保護リソースを表示するには、アクション・アイコンをクリックしてそのキーのオプションのリストを開き、**「関連リソースの表示」**を選択してそのキーで保護されているすべてのリソースがブラウズできます。

   表 2. 関連リソースの表示の表について説明します。

   列	説明
   Resource name	鍵と関連付けられているクラウド・リソース (Cloud Object Storage バケットなど) の名前。
   Service name	リソースが存在する IBM Cloud サービス・インスタンスの名前。
   Retention policy	クラウド・リソースに保存ポリシーがあるかどうか。 値が True の場合は、クラウド・リソースの保存ポリシーが有効であるため、そのクラウド・リソースに関連付けられている鍵は削除できません。 値が False の場合、保存ポリシーは有効ではありません。

6. 各リソースの詳細を表示するには、Resource name列のキャレット (^) アイコンをクリックして、リソースの詳細を展開します。

   以下の表に、登録の詳細を示します。

   表 3. リソースに関連付けられているプロパティーが説明されています。

   フィールド	説明
   Created	リソースに鍵が最初に関連付けられた日時。
   Last updated	登録が更新された日時。
   Description	登録の説明。
   Key version ID	クラウド・リソースを保護しているルート鍵のバージョン。
   Key version date	ルート鍵のバージョンが更新された日時。
   Cloud resource name	クラウドリソース名（CRN）を含む、キーに関連付けられたクラウドリソースを表します。version 、cname 、ctype 、 等々。

検索フィールドを使用すると、リソース名またはキー バージョン ID を使用して、ルート キーに関連付けられているリソースを検索できます。

インスタンス内のリソースの表示

1. UI にログインします。

2. 「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。

3. IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。

4. **「KMS 関連リソース (KMS associated resources)」ページで、「鍵管理サービスの関連リソース (Key management service associated resources)」**テーブルを使用して、サービスに存在する登録を参照します。

   表 4。 関連リソースの表について説明します。

   列	説明
   Resource name	鍵と関連付けられているクラウド・リソース (Cloud Object Storage バケットなど) の名前。
   Key name	示されているクラウド・リソースに関連付けられているルート鍵を表す (人間が理解できる) 名前。
   Key ID	示されているクラウド・リソースに関連付けられているルート鍵を表す ID。
   Service name	リソースが存在する IBM Cloud サービス・インスタンスの名前。
   Retention policy	クラウド・リソースを消去できるかどうかを示します。 値が Enabled の場合、クラウド・リソースは消去できず、クラウド・リソースに関連付けられている鍵も削除できません。 値が Disabled の場合、クラウド・リソースは消去できます。 必要であれば、クラウド・リソースに関連付けられている鍵を削除できます。

5. Resource name列のキャレット (^) アイコンをクリックして、特定の登録の詳細リストを表示します。

   以下の表に、登録の詳細を示します。

   表 5. リソースに関連付けられているプロパティーが説明されています。

   フィールド	説明
   Created	リソースに鍵が最初に関連付けられた日時。
   Last updated	登録が更新された日時。
   Description	登録の説明。
   Key version ID	クラウド・リソースを保護しているルート鍵のバージョン。
   Key version date	ルート鍵のバージョンが更新された日時。
   Cloud resource name	クラウドリソース名（CRN）を含む、キーに関連付けられたクラウドリソースを表します。version 、cname 、ctype 、 等々。

リソースを検索できるだけでなく、リソース名、鍵 ID、保存ポリシーを条件にしてリソースを検索することもできます。 これを行うには、Filterボタンをクリックし、リストからフィルター・オプションを選択し、**「適用」**をクリックします。

API を使用して特定のルート鍵の登録をリスト表示する

以下のエンドポイントへの GET 呼び出しを行うことによって、特定のルート鍵と関連付けられている登録の詳細を取得できます。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/registrations

1. API の処理を行うために、認証資格情報を取得します。

2. 以下の cURL コマンドを実行して、ルート鍵と関連付けられている登録を表示します。

   curl -X GET \
   https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/registrations \
   -H 'authorization: Bearer <IAM_token>' \
   -H 'bluemix-instance: <instance_ID>'
   

   次の表に従って、例の要求内の変数を置き換えてください。

   表 7。 ルートキーに関連付けられているすべての登録をリストするために必要な変数について説明します。

   変数	説明
   region	必須。 地域の略語、例：us-south または eu-de、あなたの地理的エリアを表しますHyper Protect Crypto Servicesインスタンスが存在します。 詳細については、リージョナル・サービス・エンドポイントを参照してください。
   port	必須。 API エンドポイントのポート番号。
   IAM_token	必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。 詳細については、アクセス・トークンのリトリーブを参照してください。
   instance_ID	必須。 Hyper Protect Crypto Services サービス・インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。

   GET api/v2/keys/<key_ID>/registrations 要求が成功すると、指定されたキー ID にマップされた登録のコレクションが返されます。

   {
     "metadata": {
         "collectionType": "application/vnd.ibm.kms.registration+json",
         "collectionTotal": 2
     },
     "resources": [
       {
         "keyId": "string",
         "resourceCrn": "crn:v1:bluemix:public:cloud-object-storage:global:a/<account-id>:<service-instance>:bucket:<bucket-name>",
         "createdBy": "string",
         "creationDate": "2010-01-12T05:23:19+0000",
         "updatedBy": "string",
         "lastUpdated": "2010-01-12T05:23:19+0000",
         "description": "string",
         "preventKeyDeletion": true,
         "keyVersion": {
             "id": "string",
             "creationDate": "2010-01-12T05:23:19+0000"
         }
       },
       {
         "keyId": "string",
         "resourceCrn": "crn:v1:bluemix:public:cloud-object-storage:global:a/<account-id>:<service-instance>:bucket:<other-bucket-name>",
         "createdBy": "string",
         "creationDate": "2010-01-12T05:23:19+0000",
         "updatedBy": "string",
         "lastUpdated": "2010-01-12T05:23:19+0000",
         "description": "string",
         "preventKeyDeletion": true,
         "keyVersion": {
             "id": "string",
             "creationDate": "2010-01-12T05:23:19+0000"
         }
       }
     ]
   }
   

   resourceCrn 値は、keyId によって暗号化されたクラウド・リソースの固有 ID を表します。 登録に関連付けられているメタデータ (作成日など) も応答本文に入れて返されます。

   デフォルトでは、GET api/v2/keys/registrations は最初の 200 個の登録を返しますが、照会時に limit パラメーターを使用してこの制限を調整できます。

API を使用してルート鍵の登録をリスト表示する

以下のエンドポイントへの GET 呼び出しを行うことによって、任意のクラウド・リソースと関連付けられた登録のリストを取得することもできます。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/registrations?urlEncodedResourceCRNQuery=<url_encoded_CRN_query>

1. API の処理を行うために、認証資格情報を取得します。

2. 以下の cURL コマンドを実行して、指定する CRN 照会に一致する登録を表示します。

   curl -X GET \
   https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/registrations?urlEncodedResourceCRNQuery=<url_encoded_CRN_query> \
   -H 'authorization: Bearer <IAM_token>' \
   -H 'bluemix-instance: <instance_ID>'
   

   次の表に従って、例の要求内の変数を置き換えてください。

   表 8。 CRN 照会によって登録をリストするために必要な変数について説明します。

   変数	説明
   region	必須。 地域の略語、例：us-south または eu-de、あなたの地理的エリアを表しますHyper Protect Crypto Servicesインスタンスが存在します。 詳細については、リージョナル・サービス・エンドポイントを参照してください。
   port	必須。 API エンドポイントのポート番号。
   url_encoded_CRN_query	指定されたリソースに関連付けられたフィルター クラウド リソース名(CRN) URLエンコードされたワイルドカード文字（* ）。パラメータにはすべての CRN セグメントが含まれている必要があり、URL エンコードされている必要があります。 例については、CRN 照会例を参照してください。
   IAM_token	必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。 詳細については、アクセス・トークンのリトリーブを参照してください。
   instance_ID	必須。 Hyper Protect Crypto Services サービス・インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。