Μετάβαση στο περιεχόμενο
Επαληθεύτηκε

Λίστα έργων και αναπτύξεων

Κάθε workspace που κατέχει ένας λογαριασμός, και μετά κάθε εφαρμογή που εκτελείται πραγματικά, ως δύο αναγνώσεις προβολής CouchDB.

Τα «έργα» και οι «αναπτύξεις» απαντούν σε δύο διαφορετικά ερωτήματα. Ένα έργο είναι ένα workspace του λογαριασμού, αυτό που θα βλέπατε στον εναλλάκτη έργων, ανεξάρτητα από το αν κάτι μέσα του έχει βγει ποτέ ζωντανό. Μια ανάπτυξη είναι μία εφαρμογή που εκτελείται πραγματικά κάπου, με is_deployment: true στο δικό της έγγραφο. Η καταγραφή ενός λογαριασμού συνήθως σημαίνει και τα δύο: πρώτα τα workspaces, και μετά ό,τι εκτελεί το καθένα.

Μέθοδοι

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 είναι true, άρα αυτή η λίστα είναι υποσύνολο όλων των εφαρμογών που έχει δημιουργήσει ποτέ ο λογαριασμός, αυτών με ζωντανό URL πρόσβασης.

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 ή πάνω, άρα ένα διαγραμμένο έργο απλώς παύει να εμφανίζεται αντί να εμφανίζεται με μια κατάσταση προς έλεγχο.

Η γραμμή ενός workspace μπορεί να φέρει παράκαμψη ονόματος

Το get_account_projects σφραγίζει το main_profile_name στη γραμμή του workspace του ίδιου του λογαριασμού όταν το workspace έχει προφίλ με όνομα, οπότε η γραμμή που εμφανίζετε ως «δικό σας» έργο μπορεί να διαβάζεται διαφορετικά από το αποθηκευμένο app_name. Προτιμήστε το main_profile_name όταν υπάρχει.

Σφάλματα

Και οι δύο μέθοδοι αποτυγχάνουν μόνο με τον τρόπο που μπορεί να αποτύχει κάθε κλήση: ένα api_key που λείπει ή δεν είναι εξουσιοδοτημένο (-401, δείτε τα Σφάλματα). Καμία δεν διακλαδίζεται με βάση το app_id ή άλλη είσοδο, αφού καμία δεν παίρνει: ένας κενός πίνακας rows είναι πραγματική, επιτυχής απάντηση για έναν λογαριασμό που δεν έχει ακόμη τίποτα σε εκείνη τη λίστα, όχι σφάλμα.

Επόμενο