配置AppDynamics API客戶端並對其進行故障排除

簡介

本文檔介紹如何建立AppDynamics API客戶端、生成令牌以及排除故障。

必要條件

需求

思科建議您瞭解以下主題：

• 要建立API客戶端，使用者必須具有「帳戶所有者」（預設）角色或具有「管理」、「代理」、「入門嚮導」許可權的自定義角色。

採用元件

本文中的資訊係根據以下軟體和硬體版本：

• AppDynamics控制器

本文中的資訊是根據特定實驗室環境內的裝置所建立。文中使用到的所有裝置皆從已清除（預設）的組態來啟動。如果您的網路運作中，請確保您瞭解任何指令可能造成的影響。

背景資訊

本文檔介紹建立API客戶端的過程，以便使用表示狀態傳輸(REST)和應用程式設計介面(API)呼叫安全地訪問AppDynamics控制器中的資料。API客戶端使用基於開放式授權(OAuth)令牌的身份驗證。OAuth允許第三方服務在不暴露使用者憑據的情況下訪問終端使用者帳戶資訊。它充當中介，為第三方服務提供授權共用特定帳戶資訊的訪問令牌。使用者可以在設定API客戶端後生成OAuth令牌。此外，本文檔還介紹了使用API客戶端時遇到的常見問題的故障排除。

設定

建立API客戶端

1. 以帳戶所有者角色或具有管理、代理和入門嚮導許可權的角色身份登入到控制器UI。
2. 按一下User Name（右上角）> Administration。
3. 點選API Client頁籤。
4. 按一下「+ Create」。
5. 輸入Client Name和Description。
6. 按一下Generate Secret以填充Client Secret。
   
   

   附註：客戶端密碼僅生成並顯示一次。複製並安全地儲存此資訊。

7. 設定預設令牌過期。

8. 按一下+ Add in Roles部分以新增角色。 
9. 按一下右上角的Save。

檢視現有API客戶端

1. 以帳戶所有者角色或具有管理、代理和入門嚮導許可權的角色身份登入到控制器UI。
2. 按一下User Name（右上角）> Administration。
3. 按一下API Client頁籤以檢視現有的API Clients。

刪除現有API客戶端

1. 以帳戶所有者角色或具有管理、代理和入門嚮導許可權的角色身份登入到控制器UI。
2. 按一下User Name（右上角）> Administration > API Clients。
3. 查詢要刪除的特定API客戶端，然後選擇它們。
4. 按一下所選API客戶端上的刪除圖示或按一下右鍵，然後選擇刪除API客戶端以刪除現有的API客戶端。

警告：刪除API客戶端將使令牌失效。

生成訪問令牌

訪問令牌可以通過管理員UI或OAuth API生成。UI提供長時間使用的令牌，而OAuth API生成短暫且定期更新的令牌。

• 管理員UI（長時間使用的令牌）

  • 以帳戶所有者角色或具有管理、代理和入門嚮導許可權的角色身份登入到控制器UI。
  • 按一下User Name（右上角）> Administration > API Clients。
  • 選擇要為其生成訪問令牌的API客戶端，然後按一下生成臨時訪問令牌。
  • 從UI生成的訪問令牌的過期時間更長。
    
    

• OAuth API（短期令牌）

  • '您可以使用REST API生成短期訪問令牌。 
    
    

    curl -X POST -H "Content-Type: application/x-www-form-urlencoded" "https:///controller/api/oauth/access_token" -d 'grant_type=client_credentials&client_id=@&client_secret='

    
    替換：
    

    •  使用您在建立API客戶端時輸入的客戶端名稱或由管理員共用的客戶端名稱。

    • 帳戶名稱。 

    • 使用您在建立API客戶端時生成的客戶端密碼或由管理員共用的客戶端密碼。
      

      

      附註：在UI上不跟蹤按需令牌。

      響應示例：
      

      {
      "access_token": "",
      "expires_in": 300
      }​

管理訪問令牌

• 從REST API生成的訪問令牌只能通過刪除關聯的API客戶端來失效。
• 通過控制器UI生成的訪問令牌可以撤消或重新生成。
• 重新生成訪問令牌不會使以前的令牌失效。較舊的令牌在過期之前一直保持活動狀態。
• 無法檢索以前或當前有效的令牌。因此，只能撤消當前令牌。
  
  

  • 重新生成訪問令牌

    • 以帳戶所有者角色或具有管理、代理和入門嚮導許可權的角色身份登入到控制器UI。
    • 按一下User Name（右上角）> Administration > API Clients。
    • 選擇要為其重新生成訪問令牌的API客戶端，按一下Regenerate > Save（右上角）。

  • 吊銷訪問令牌

    • 以帳戶所有者角色或具有管理、代理和入門嚮導許可權的角色身份登入到控制器UI。
    • 按一下User Name（右上角）> Administration > API Clients。
    • 選擇要撤消其訪問令牌的API客戶端，按一下Revoke > Save（右上角）。

使用訪問令牌生成Rest API

• 從Splunk AppDynamics APIs d確定需要與之互動的特定端點。 
  
• 構建請求：
  • 方法：根據要執行的操作選擇HTTP方法(GET、POST、PUT、DELETE)。
  • 標頭：在授權標頭中新增訪問權杖。
  • 本文（如有）：以JavaScript對象表示法(JSON)格式新增請求正文。 
    
    
• 請求範例
  

  curl --location --request GET 'https:///controller/' --header 'Authorization: Bearer '

  
  替換：
  
  •   控制器URL。
  •   您需要與剩餘終端互動。
  •   使用客戶端名稱和客戶端金鑰生成的訪問令牌。

常見問題和解決方案

• 401 未授權
  

  • 問題：使用者在嘗試生成訪問令牌時遇到401 Unauthorized錯誤。
  • 響應示例： 
    

    
    
    
    HTTP Error 401 Unauthorized
    
    This request requires HTTP authentication
    

  • 根本原因：通常由於與客戶端名稱關聯的客戶端密碼無效而出現問題。當生成但不儲存客戶端金鑰時，通常會發生這種情況
  • 解決方案： 
    • 以帳戶所有者角色或具有管理、代理和入門嚮導許可權的角色身份登入到控制器UI。
    • 按一下User Name（右上角）> Administration。
    • 按一下API Client頁籤以檢視現有的API Clients。
    • 選擇要獲取錯誤的API客戶端。
    • 按一下Generate Secret以生成新的客戶端金鑰，然後按一下Save（右上角） 
      
      
      

• 空響應。

  • 問題：使用者查詢REST終結點時會遇到空響應，即使在成功生成訪問令牌後也是如此。
  • 響應示例：
    

  • 根本原因：該問題通常是由於分配給API客戶端的角色或許可權不足所致。如果沒有必要的角色，API客戶端無法從端點檢索預期資料。
  • 解決方案： 
    • 以帳戶所有者角色或具有管理、代理和入門嚮導許可權的角色身份登入到控制器UI。
    • 按一下User Name（右上角）> Administration。
    • 按一下API Client頁籤以檢視現有的Api Clients。
    • 選擇要為其分配角色的API客戶端
    • 按一下+ Add in Roles部分以新增角色。 
    • 按一下右上角的Save。
      
      
      

      附註：確保API客戶端已分配適當的角色。角色必須與REST終端的資料存取要求一致。

• 無效的內容型別

  • 問題：使用者在嘗試生成訪問令牌時遇到500內部伺服器錯誤。
  • 示例錯誤： 
    

    HTTP ERROR 500 javax.servlet.ServletException: java.lang.IllegalStateException: The @FormParam is utilized when the content type of the request entity is not application/x-www-form-urlencoded
    ​

  • 根本原因：由於內容型別標頭導致問題。在控制器版本24.10中，內容型別已從application/vnd.appd.cntrl+json;v=1更改為application/x-www-form-urlencoded
  • 解決方案： 
    • 修改請求並將內容型別標頭設定為application/x-www-form-urlencoded
      範例：
      

      curl -X POST -H "Content-Type: application/x-www-form-urlencoded" "https:///controller/api/oauth/access_token" -d 'grant_type=client_credentials&client_id=@&client_secret='​

相關資訊

AppDynamics文檔

Splunk AppDynamics API

API使用者端

管理存取權杖

需要進一步協助？

如果您遇到問題或遇到問題，請建立包含以下詳細信息的支援票證：

• 錯誤詳細資訊或螢幕截圖：提供特定錯誤消息或問題的螢幕截圖。
• 使用的命令：指定發生問題時正在運行的確切命令。
• Controller Server.log（僅限內部部署）：如果適用，請從<controller-install-dir>/logs/server.log*提供控制器伺服器日誌