דילוג לתוכן
אומת

רשימת פרויקטים ופריסות

כל סביבת עבודה שבבעלות החשבון, ואז כל אפליקציה שרצה בפועל, כשתי קריאות של תצוגות CouchDB.

"פרויקטים" ו"פריסות" עונים על שתי שאלות שונות. פרויקט הוא סביבת עבודה בחשבון, הדבר שרואים במחליף הפרויקטים, בין אם משהו בתוכו עלה לאוויר ובין אם לא. פריסה היא אפליקציה אחת שרצה בפועל איפשהו, is_deployment: true במסמך שלה. כשמפרטים חשבון בדרך כלל צריך את שניהם: קודם סביבות העבודה, ואז מה שרץ בכל אחת מהן.

שיטות

POST/cpi/get_account_projects
user

Get Account Projects

Returns the projects owned by the account (or all projects for superuser and support accounts) from the user_projects master view.

POST/cpi/get_account_deployments
user

Get Account Deployments

Returns the deployments associated with the account from the user_deployments master view.

הדרכה צעד אחר צעד

מפרטים את הפרויקטים של החשבון

אין שדות מלבד המפתח: שתי השיטות מפעילות את תצוגת CouchDB לפי ה-uid שהאישור שלכם כבר נפתר אליו.

curl -s https://xuda.ai/cpi/get_account_projects \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'
const res = await fetch('https://xuda.ai/cpi/get_account_projects', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY' }),
});
const { code, data } = await res.json();
if (code > 0) {
  for (const row of data.rows) console.log(row.id, row.value.app_name, row.value.app_status_code);
}
import requests

res = requests.post(
    'https://xuda.ai/cpi/get_account_projects',
    json={'api_key': 'YOUR_API_KEY'},
)
body = res.json()
if body['code'] > 0:
    for row in body['data']['rows']:
        print(row['id'], row['value']['app_name'], row['value']['app_status_code'])

2. מפרטים מה נפרס בפועל

אותו מבנה, תצוגה אחרת: user_deployments פולטת מסמך רק כש-is_deployment הוא אמת, ולכן הרשימה הזו היא תת-קבוצה של כל האפליקציות שהחשבון אי פעם יצר, אלה שיש להן כתובת גישה חיה.

curl -s https://xuda.ai/cpi/get_account_deployments \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'
const res = await fetch('https://xuda.ai/cpi/get_account_deployments', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY' }),
});
const { code, data } = await res.json();
if (code > 0) {
  for (const row of data.rows) console.log(row.id, row.value.app_hosting, row.value.app_status_code);
}
import requests

res = requests.post(
    'https://xuda.ai/cpi/get_account_deployments',
    json={'api_key': 'YOUR_API_KEY'},
)
body = res.json()
if body['code'] > 0:
    for row in body['data']['rows']:
        print(row['id'], row['value']['app_hosting'], row['value']['app_status_code'])

התשובה

שתי השיטות מעבירות תוצאת תצוגה של CouchDB ישירות, בלי עטיפה: code הוא 871 (קוד ההצלחה הקבוע ש-get_couch_view מחזיר תמיד, לא 1 הרגיל), ו-data הוא תשובת התצוגה הגולמית של nano, total_rows, offset ומערך rows של { id, key, value }. id הוא ה-_id של הפרויקט (או הפריסה), הערך שמעבירים כ-app_id לכל קריאה אחרת בפרק הזה.

json
{
  "code": 871,
  "data": {
    "total_rows": 3,
    "offset": 0,
    "rows": [
      {
        "id": "app_5d9e21",
        "key": "acc_8f2a1c",
        "value": {
          "_id": "app_5d9e21",
          "app_name": "Marketing site",
          "app_type": "master",
          "app_status_code": 3,
          "app_access_type": "private",
          "docDate": 1735689600000,
          "app_icon_prop": { "app_icon_background_color": "#4f46e5", "app_icon_size": "md" }
        }
      }
    ]
  }
}

שורות של get_account_deployments נושאות את אותם שדות ובנוסף app_hosting_server, app_datacenter_id, app_hosting ו-is_deployment: true, כי user_deployments פולטת אותם על גבי הקבוצה המשותפת. app_status_code < 4 הוא הסטטוס היחיד שהתצוגה הזו או user_projects יציגו לכם: שתי פונקציות ה-map מסננות כל דבר מ-4 ומעלה, ולכן פרויקט שנמחק פשוט מפסיק להופיע ולא מופיע עם סטטוס לבדיקה.

בשורה של סביבת עבודה יכול להופיע שם חלופי

get_account_projects מוסיפה את main_profile_name לשורת סביבת העבודה של החשבון עצמו כשלסביבת העבודה הזו יש פרופיל בעל שם, ולכן השורה שמציגים בתור הפרויקט "שלכם" יכולה להיקרא אחרת מה-app_name השמור שלה. עדיף להשתמש ב-main_profile_name כשהוא קיים.

שגיאות

שתי השיטות נכשלות רק באופן שבו כל קריאה יכולה להיכשל: api_key חסר או לא מורשה (-401, ראו שגיאות). אף אחת מהן לא מסתעפת לפי app_id או קלט אחר, כי אף אחת לא מקבלת כזה, מערך rows ריק הוא תשובה אמיתית ומוצלחת לחשבון שעדיין אין בו דבר באותה רשימה, לא שגיאה.

הבא