تكوين عميل AppDynamics API واستكشاف أخطائه وإصلاحها

المقدمة

يوضح هذا المستند كيفية إنشاء عميل AppDynamics API وإنشاء العلامات المميزة واستكشاف المشاكل وإصلاحها.

المتطلبات الأساسية

المتطلبات

توصي Cisco بأن تكون لديك معرفة بالمواضيع التالية:

• لإنشاء عميل واجهة برمجة تطبيقات، يجب أن يكون لدى المستخدم دور مالك الحساب (الافتراضي) أو دور مخصص مع الإدارة والوكلاء وأذن معالج بدء التشغيل.

المكونات المستخدمة

تستند المعلومات الواردة في هذا المستند إلى إصدارات البرامج والمكونات المادية التالية:

• وحدة التحكم في AppDynamics

تم إنشاء المعلومات الواردة في هذا المستند من الأجهزة الموجودة في بيئة معملية خاصة. بدأت جميع الأجهزة المُستخدمة في هذا المستند بتكوين ممسوح (افتراضي). إذا كانت شبكتك قيد التشغيل، فتأكد من فهمك للتأثير المحتمل لأي أمر.

معلومات أساسية

يصف هذا المستند عملية إنشاء عملاء واجهة برمجة التطبيقات (API) للوصول بأمان إلى البيانات من وحدة التحكم في AppDynamics باستخدام إستدعاءات نقل الحالة التمثيلية (REST) وواجهة برمجة التطبيقات (API). يستخدم عملاء واجهة برمجة التطبيقات المصادقة المفتوحة (OAuth) المستندة إلى الرمز المميز. يسمح OAuth لخدمات الطرف الثالث بالوصول إلى معلومات حساب المستخدم النهائي دون الكشف عن مسوغات المستخدم. وهو يعمل كوسيط، حيث يوفر للجهة الخارجية خدمة مزودة برمز مميز للوصول يسمح بمشاركة معلومات محددة عن الحساب. يمكن للمستخدمين إنشاء رمز OAuth المميز بعد إعداد عميل API. وبالإضافة إلى ذلك، يغطي هذا المستند أستكشاف المشكلات الشائعة التي تتم مصادفتها أثناء إستخدام عملاء واجهة برمجة التطبيقات (API) وإصلاحها.

التكوين

إنشاء عميل واجهة برمجة تطبيقات

1. قم بتسجيل الدخول إلى واجهة مستخدم وحدة التحكم كدور مالك حساب أو دور مع Administration، Agents، Get Start Wizard Permission.
2. انقر على اسم المستخدم (أعلى اليمين) >إدارة.
3. انقر فوق علامة التبويب عميل واجهة برمجة التطبيقات.
4. انقر فوق + إنشاء.
5. أدخل اسم العميل والوصف.
6. انقر فوق إنشاء سر لملء سر العميل.
   
   

   ملاحظة: يتم إنشاء سر العميل وعرضه مرة واحدة فقط. انسخ هذه المعلومات وتخزينها بأمان.

7. تعيين انتهاء صلاحية الرمز المميز الافتراضي.

8. انقر فوق + إضافة في قسم الأدوار لإضافة الدور. 
9. انقر فوق حفظ" في أعلى اليمين.

عرض عميل واجهة برمجة التطبيقات (API) الموجود

1. قم بتسجيل الدخول إلى واجهة مستخدم وحدة التحكم كدور مالك حساب أو دور مع Administration، Agents، Get Start Wizard Permission.
2. انقر على اسم المستخدم (الزاوية العليا اليمنى) >إدارة.
3. انقر فوق علامة التبويب عميل واجهة برمجة التطبيقات لعرض عملاء واجهة برمجة التطبيقات (API) الموجودين.

حذف عميل واجهة برمجة التطبيقات الموجود

1. قم بتسجيل الدخول إلى واجهة مستخدم وحدة التحكم كدور مالك حساب أو دور مع Administration، Agents، Get Start Wizard Permission.
2. انقر فوق اسم المستخدم الخاص بك (أعلى الركن الأيمن) >الإدارة > عملاء واجهة برمجة التطبيقات (API).
3. ابحث عن عملاء واجهة برمجة التطبيقات (API) المحددين الذين تريد حذفهم وتحديدهم.
4. انقر فوق أيقونة حذف أو انقر بزر الماوس الأيمن على عميل (عملاء) واجهة برمجة التطبيقات (API) المحدد وحدد حذف عميل (عملاء) واجهة برمجة التطبيقات (API) لحذف عميل (عملاء) واجهة برمجة التطبيقات الموجودة.

تحذير: يؤدي حذف عميل واجهة برمجة التطبيقات إلى إبطال الرمز المميز.

إنشاء رمز مميز للوصول

يمكن إنشاء الرمز المميز للوصول من خلال واجهة مستخدم المسؤول أو واجهة برمجة تطبيقات OAuth. توفر واجهة المستخدم رموز مميزة طويلة العمر، بينما تنتج واجهة برمجة تطبيقات OAuth رموز مميزة قصيرة العمر ومنشطة بشكل منتظم.

• واجهة مستخدم المسؤول (العلامات المميزة طويلة العمر)

  • قم بتسجيل الدخول إلى واجهة مستخدم وحدة التحكم كدور مالك حساب أو دور مع Administration، Agents، Get Start Wizard Permission.
  • انقر فوق اسم المستخدم الخاص بك (أعلى الركن الأيمن) >الإدارة > عملاء واجهة برمجة التطبيقات (API).
  • حدد عميل واجهة برمجة التطبيقات (API) الذي تريد إنشاء الرمز المميز للوصول الخاص به وانقر فوق إنشاء رمز مميز للوصول المؤقت.
  • تحتوي رموز الوصول المميزة التي تم إنشاؤها من واجهة المستخدم على وقت انتهاء صلاحية أطول.
    
    

• OAuth API (رموز مميزة قصيرة العمر)

  • 'يمكنك إستخدام واجهات برمجة تطبيقات REST لإنشاء رمز مميز للوصول قصير العمر. 
    
    

    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) أو كما تمت مشاركته بواسطة المسؤول.
      

      

      ملاحظة: لم يتم تعقب الرمز المميز حسب الطلب على واجهة المستخدم.

      مثال على الاستجابة:
      

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

برنامج Manange Access Token

• يمكن إبطال رموز الوصول المميزة التي تم إنشاؤها من واجهة برمجة تطبيقات REST فقط من خلال حذف عميل واجهة برمجة التطبيقات (API) المقترن.
• يمكن إبطال رموز الوصول المميزة التي تم إنشاؤها من خلال واجهة مستخدم وحدة التحكم أو إعادة إنشاؤها.
• لا تؤدي إعادة إنشاء رمز مميز للوصول إلى إبطال الرموز المميزة السابقة. تبقى العلامات المميزة الأقدم نشطة حتى انتهاء صلاحيتها.
• لا توجد طريقة لاسترداد الرموز المميزة السابقة أو الصالحة حاليا. لذلك، يمكن إبطال الرمز المميز الحالي فقط.
  
  

  • إعادة إنشاء رمز الوصول المميز

    • قم بتسجيل الدخول إلى واجهة مستخدم وحدة التحكم كدور مالك حساب أو دور مع Administration، Agents، Get Start Wizard Permission.
    • انقر فوق اسم المستخدم الخاص بك (أعلى الركن الأيمن) >الإدارة > عملاء واجهة برمجة التطبيقات (API).
    • حدد عميل واجهة برمجة التطبيقات (API) الذي تريد إعادة إنشاء الرمز المميز للوصول الخاص به، انقر فوق إعادة إنشاء > حفظ (الزاوية العليا اليمنى).

  • إبطال الرمز المميز للوصول

    • قم بتسجيل الدخول إلى واجهة مستخدم وحدة التحكم كدور مالك حساب أو دور مع Administration، Agents، Get Start Wizard Permission.
    • انقر فوق اسم المستخدم الخاص بك (أعلى الركن الأيمن) > الإدارة > عملاء واجهة برمجة التطبيقات (API).
    • حدد عميل واجهة برمجة التطبيقات (API) الذي تريد إبطال الرمز المميز للوصول إليه، انقر فوق إبطال > حفظ (الزاوية العليا اليمنى).

إستخدام رمز الوصول المميز لإنشاء REST API

• من Splunk AppDynamics APIsdحدد نقطة النهاية المحددة التي تحتاج إلى التفاعل معها. 
  
• بناء الطلب:
  • الطريقة: حدد أسلوب HTTP (GET، POST، PUT، DELETE) استنادا إلى الإجراء الذي تريد تنفيذه.
  • الرؤوس: إضافة رمز الوصول المميز في رأس التخويل.
  • النص الأساسي (إن وجد): إضافة نص الطلب بتنسيق JavaScript Object Notation (JSON). 
    
    
• مثال الطلب
  

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

  
  إستبدال:
  
  •   باستخدام URL لوحدة التحكم.
  •   باستخدام "نقطة نهاية الراحة" التي تحتاج إلى التفاعل معها.
  •   باستخدام الرمز المميز للوصول الذي تم إنشاؤه باستخدام اسم العميل وسر العميل.

المشاكل المشتركة والحل

• 401 غير مصرح به
  

  • المشكلة: يواجه المستخدمون خطأ 401 غير مصرح به عند محاولة إنشاء رمز مميز للوصول.
  • نموذج الاستجابة: 
    

    
    
    
    HTTP Error 401 Unauthorized
    
    This request requires HTTP authentication
    

  • السبب الجذري: تنشأ المشكلة عادة بسبب سر العميل المقترن باسم العميل غير صالح. يحدث هذا غالبا عندما يتم إنشاء سر العميل ولكن لا يتم حفظه
  • الحل: 
    • قم بتسجيل الدخول إلى واجهة مستخدم وحدة التحكم كدور مالك حساب أو دور مع Administration، Agents، Get Start Wizard Permission.
    • انقر على اسم المستخدم (الزاوية العليا اليمنى) >إدارة.
    • انقر فوق علامة التبويب عميل واجهة برمجة التطبيقات لعرض عملاء واجهة برمجة التطبيقات (API) الموجودين.
    • حدد عميل واجهة برمجة التطبيقات (API) الذي تحصل على الخطأ الخاص به.
    • انقر فوق إنشاء سر لإنشاء سر عميل جديد وانقر فوق حفظ (الزاوية العليا اليمنى) 
      
      
      

• إستجابة فارغة.

  • المشكلة: يواجه المستخدمون إستجابة فارغة عند الاستعلام عن نقطة نهاية REST، حتى بعد إنشاء رمز مميز للوصول بنجاح.
  • نموذج الاستجابة:
    

  • السبب الجذري: عادة ما تنشأ المشكلة بسبب الأدوار أو الأذونات غير الكافية التي تم تعيينها لعميل واجهة برمجة التطبيقات (API). بدون الأدوار الضرورية، يتعذر على عميل API إسترداد البيانات المتوقعة من نقطة النهاية.
  • الحل: 
    • قم بتسجيل الدخول إلى واجهة مستخدم وحدة التحكم كدور مالك حساب أو دور مع Administration، Agents، Get Start Wizard Permission.
    • انقر على اسم المستخدم (الزاوية العليا اليمنى) >إدارة.
    • انقر فوق علامة التبويب عميل واجهة برمجة التطبيقات لعرض عملاء واجهة برمجة التطبيقات (API) الموجودين.
    • حدد عميل واجهة برمجة التطبيقات (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
  • الحل: 
    • تعديل الطلب وتعيين رأس نوع المحتوى على التطبيق/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

عملاء واجهة برمجة التطبيقات

إدارة رموز الوصول المميزة

هل تحتاج إلى مزيد من المساعدة؟

إذا كان لديك سؤال أو لديك مشكلات، فيرجى إنشاء تذكرة دعم مع هذه التفاصيل:

• تفاصيل الخطأ أو لقطة الشاشة: قم بتوفير رسالة خطأ محددة أو لقطة شاشة للمشكلة.
• الأمر المستخدم: حدد الأمر المحدد الذي كنت تقوم بتشغيله عند حدوث المشكلة.
• وحدة التحكم server.log (على-prem فقط): إن أمكن، قم بتوفير سجلات خادم وحدة التحكم من <controller-install-dir>/logs/server.log*