管理存取金鑰

存取金鑰 是一個記號,您必須用來配置監視代理程式,才能順利將資料轉遞至 IBM Cloud中的 IBM Cloud Monitoring 實例。

透過 IBM Cloud 使用者介面取得存取金鑰

若要透過 IBM Cloud Monitoring 使用者介面取得 IBM Cloud 實例的存取金鑰,請完成下列步驟:

  1. 登入 IBM Cloud 主控台

  2. 移至「功能表」圖示 「功能表」圖示 > 觀察

  3. 選取監視。 即會開啟 IBM Cloud Monitoring 儀表板。 您可以看到清單,列出 IBM Cloud 上可用的監視實例。

  4. 識別您要取得其存取金鑰的實例。 按一下實例旁邊的 動作 圖示 「動作」圖示,然後按一下 管理金鑰

  5. 即會開啟一個視窗,您可以在其中按一下 顯示索引鍵 來檢視存取索引鍵。

透過 CLI 取得存取金鑰

若要透過指令行取得監視實例的存取金鑰,請完成下列步驟:

  1. [必要條件]安裝 IBM Cloud CLI

  2. 登入監視實例執行所在 IBM Cloud 中的地區。 執行下列指令: ibmcloud login

  3. 設定監視實例執行所在的資源群組。 執行下列指令: ibmcloud target

    依預設,會設定 default 資源群組。

  4. 取得實例名稱。 執行下列指令: ibmcloud resource service-instances

    ibmcloud resource service-instances
    
  5. 取得與監視實例相關聯的 API 金鑰名稱。 執行 ibmcloud resource service-keys 指令:

    ibmcloud resource service-keys --instance-name INSTANCE_NAME
    

    其中 INSTANCE_NAME 是您在前一個步驟中取得的實例名稱。

  6. 取得存取金鑰。 執行 ibmcloud resource service-key 指令:

    ibmcloud resource service-key APIKEY_NAME
    

    其中 APIKEY_NAME 是 API 金鑰的名稱。

    此指令的輸出包括 存取金鑰 欄位,其中包含實例的存取金鑰。

建立其他存取金鑰

如果存取金鑰已受損或您有原則在幾天之後更新它,您可以產生新的存取金鑰並停用舊的存取金鑰。

若要為 IBM Cloud Monitoring 實例建立新的存取金鑰,請完成下列步驟:

  1. 從 IBM Cloud Monitoring 使用者介面取得 API 記號。 進一步瞭解

  2. 針對監視端點發出 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
        }
    }
    
  3. 現在可以在監視代理程式配置檔中使用存取金鑰。

停用存取金鑰

若要停用 IBM Cloud Monitoring 實例的現有存取金鑰,請完成下列步驟:

  1. 從 IBM Cloud Monitoring 使用者介面取得 API 記號 ( 請參閱指示 )。

  2. 針對監視端點發出 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 實例的現有存取金鑰,請完成下列步驟:

  1. 從 IBM Cloud Monitoring 使用者介面取得 API 記號。 進一步瞭解

  2. 針對監視端點發出 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 實例的所有存取金鑰,請完成下列步驟:

  1. 從 IBM Cloud Monitoring 使用者介面取得 API 記號。 進一步瞭解

  2. 針對地區監視端點發出 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 實例的存取金鑰,請完成下列步驟:

  1. 從 IBM Cloud Monitoring 使用者介面取得 API 記號。 進一步瞭解

  2. 對地區監視端點發出 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 是要刪除的存取金鑰。 您可以 檢視所有存取金鑰的清單,以取得存取金鑰值。