アクセス・キーの管理

アクセス・キー は、IBM Cloud Monitoring で IBM Cloud インスタンスにデータが正常に転送されるようにモニタリング・エージェントを構成するために使用する必要があるトークンです。

IBM Cloud UI を使用したアクセス・キーの取得

IBM Cloud Monitoring UI を使用して IBM Cloud インスタンス用のアクセス・キーを取得するには、以下のステップを実行します。

IBM Cloud コンソールにログインします。
「メニュー」アイコン > 可観測性に移動します。
**「モニタリング」**を選択します。 IBM Cloud Monitoring ダッシュボードが開きます。 IBM Cloud で使用可能なモニタリング・インスタンスのリストが表示されます。
アクセス・キーを取得するインスタンスを特定します。インスタンスの横にある 「アクション」 アイコンをクリックし、 「鍵の管理」 をクリックします。
ウィンドウが開き、そこで**「鍵の表示 (Show key)」**をクリックするとアクセス・キーが表示されます。

CLI を使用したアクセス・キーの取得

コマンド・ラインを使用してモニタリング・インスタンス用のアクセス・キーを取得するには、以下のステップを実行します。

[前提条件] IBM Cloud CLI のインストール。
モニタリング・インスタンスが実行されている IBM Cloud のリージョンにログインします。次のコマンドを実行します。 ibmcloud login
モニタリング・インスタンスが実行されているリソース・グループを設定します。次のコマンドを実行します。 ibmcloud target

デフォルトでは、default リソース・グループが設定されています。
インスタンス名を取得します。次のコマンドを実行します。ibmcloud resource service-instances
```
ibmcloud resource service-instances
```
モニタリング・インスタンスに関連付けられている API キーの名前を取得します。 ibmcloud resource service-keys コマンドを実行します。
```
ibmcloud resource service-keys --instance-name INSTANCE_NAME
```
ここで、INSTANCE_NAME は前のステップで取得したインスタンスの名前です。
アクセス・キーを取得します。次の ibmcloud resource service-key コマンドを実行します。
```
ibmcloud resource service-key APIKEY_NAME
```
ここで、APIKEY_NAME は、API キーの名前です。

このコマンドの出力には、インスタンスのアクセス・キーを含む Access Key フィールドが表示されます。

追加のアクセス・キーの作成

アクセス・キーが漏えいした場合や数日後にアクセス・キーを更新するポリシーがある場合は、新しいアクセス・キーを生成して古いキーを無効にすることができます。

IBM Cloud Monitoring インスタンスの新しいアクセス・キーを作成するには、以下のステップを実行します。

IBM Cloud Monitoring UI から API トークンを取得します。詳細はこちらをご覧ください。
モニタリング・エンドポイントに対して curl POST 要求を発行して、新しいアクセス・キーを生成します。
```
curl -X POST -H 'Authorization: Bearer API_TOKEN' https:ENDPOINT/api/customer/accessKeys
```
説明
- ENDPOINT は、モニタリング・インスタンスが使用可能なリージョンの URL です。詳しくは、モニタリング・エンドポイントを参照してください。
- API_TOKEN は、ステップ 1 で取得した API トークンです。
応答として新しく生成されたアクセス・キーが出力されます。
```
{
    "customerAccessKey": {
        "enabled": true,
        "accessKey": "12345678-1234-1234-1234-123456789012",
        "dateCreated": 1573852152224,
        "dateDisabled": null
    }
}
```
これで、このアクセス・キーを、モニタリング・エージェントの構成ファイルで使用することができるようになります。

アクセス・キーの無効化

IBM Cloud Monitoring インスタンスの既存のアクセス・キーを無効にするには、以下のステップを実行します。

IBM Cloud Monitoring UI から API トークンを取得します ( 手順を参照)。
モニタリング・エンドポイントに対して curl POST 要求を発行して、指定されたアクセス・キーを無効にします。
```
curl -X POST -H 'Authorization: Bearer API_TOKEN' https:ENDPOINT/api/customer/accessKeys/ACCESS_KEY/disable
```
説明
- ENDPOINT は、モニタリング・インスタンスが使用可能なリージョンの URL です。詳しくは、モニタリング・エンドポイントを参照してください。
- API_TOKEN は、ステップ 1 で取得した API トークンです。
- ACCESS_KEY は、無効にするアクセス・キーです。

アクセス・キーを無効にするとすぐに、このアクセス・キーで接続しているエージェントはこの IBM Cloud Monitoring インスタンスにメトリックを送信できなくなります。

現時点でアクセス・キーを削除するオプションはありません。

アクセス・キーの有効化

IBM Cloud Monitoring インスタンスの既存のアクセス・キーを有効にするには、以下のステップを実行します。

IBM Cloud Monitoring UI から API トークンを取得します。詳細はこちらをご覧ください。
モニタリング・エンドポイントに対して curl POST 要求を発行して、指定されたアクセス・キーを有効にします。
```
curl -X POST -H 'Authorization: Bearer API_TOKEN' https://ENDPOINT/api/customer/accessKeys/ACCESS_KEY/enable
```
説明
- ENDPOINT は、モニタリング・インスタンスが使用可能なリージョンの URL です。詳しくは、モニタリング・エンドポイントを参照してください。
- API_TOKEN は、ステップ 1 で取得した API トークンです。
- ACCESS_KEY は、有効にするアクセス・キーです。

アクセス・キーを有効にしたら、エージェントを手動で再始動する必要があります。無効化されたアクセス・キーで接続しているエージェントは終了されるからです。

使用可能なアクセス・キーの表示

IBM Cloud Monitoring インスタンスのすべてのアクセス・キーを表示するには、以下のステップを実行します。

IBM Cloud Monitoring UI から API トークンを取得します。詳細はこちらをご覧ください。

リージョンのモニタリング・エンドポイントに対して curl GET 要求を発行して、指定されたアクセス・キーを有効にします。

curl -X GET -H 'Authorization: Bearer API_TOKEN' https://ENDPOINT/api/customer/accessKeys

説明

ENDPOINT は、モニタリング・インスタンスが使用可能なリージョンの URL です。詳しくは、モニタリング・エンドポイントを参照してください。
API_TOKEN は、ステップ 1 で取得した API トークンです。

応答としてアクセス・キーのリストと、それらが有効かどうかが出力されます。

{
    "customerAccessKeys": [
        {
            "enabled": true,
            "accessKey": "12345678-1234-1234-1234-123456789012",
            "dateCreated": 1541096409000,
            "dateDisabled": null
        },
        {
            "enabled": false,
            "accessKey": "87654321-1234-1234-1234-123456789012",
            "dateCreated": 1573849361000,
            "dateDisabled": 1573849367000
        }
    ]
}

アクセス・キーの削除

IBM Cloud Monitoring インスタンスのアクセス・キーを削除するには、以下の手順を実行します。

IBM Cloud Monitoring UI から API トークンを取得します。詳細はこちらをご覧ください。
アクセス・キーを削除するには、地域のモニター・エンドポイントに対して curl DELETE 要求を発行します。
```
curl -X DELETE -H 'Authorization: Bearer API_TOKEN' -H "IBMInstanceID: GUID" https://ENDPOINT/api/customer/accessKeys/ACCESS_KEY
```
説明
- ENDPOINT は、モニタリング・インスタンスが使用可能なリージョンの URL です。詳しくは、モニタリング・エンドポイントを参照してください。
- API_TOKEN は、ステップ 1 で取得した API トークンです。
- GUIDは、アクセス・キーに関連付けられたモニター・インスタンスの GUID です。 IAM トークンのヘッダーを参照してください。
- ACCESS_KEYは、削除するアクセス・キーです。すべてのアクセス・キーのリストの表示を使用して、アクセス・キー値を取得できます。