Ugrás a tartalomhoz
Ellenőrizve

Domain csatlakoztatása

Irányítsa a fiók egyik saját domainjét a kulcs projektjére DNS-en keresztül, Alkalmazás hatókörű kulccsal.

Az agent_domain_connect projekthez kötött hívás: a szakasz minden más írásával ellentétben nem vesz át app_id értéket. A projekt, amelyre a domaint irányítja, az, amelyből maga az API-kulcs készült, ezért ehhez a recepthez Alkalmazás kulcs kell (a projekt saját API lapján létrehozva), nem Fiók kulcs. Az agent_domain_list a társ-olvasás, a fiók saját domainjei, így mindig olyan nevet küld, amelyet a fiók ténylegesen birtokol.

Metódusok

POST/cpi/agent_domain_list
user

Domains: list

List the account's registered domains (name, status, which app each is attached to). Use this BEFORE asking the user to type a domain: if they say 'connect one of my domains', call this and present the options.

POST/cpi/agent_domain_connect
user

Domains: connect to this VPS

Point one of the account's own domains (from agent_domain_list) at THIS project's VPS via DNS. Optional subdomain (e.g. 'app' -> app.example.com); omit to use the apex. Prefer a subdomain unless the user explicitly wants the apex. Attaching replaces any existing record on that exact hostname.

Ehhez Alkalmazás kulcs kell, nem Fiók kulcs

Mindkét metódus a küldött kulcsból oldja fel a uid értéket, mint mindenhol máshol, de az agent_domain_connect az app_id értéket is abból oldja fel, és azt csak a projekt API lapján létrehozott kulcs hordozza. Fiók kulccsal hívva -1 választ ad, 'no app is bound to this action', mielőtt a domaint egyáltalán megnézné. A három kulcshatókört lásd az Authentication oldalon.

Végigvezető

A fiók domainjeinek listázása

A kulcson kívül nincs más mező. Minden sor egy domain, amelyet a fiók a Xudán keresztül regisztrált, vagy a névszerverek delegálásával csatlakoztatott, függetlenül attól, hogy melyik projektre mutat éppen (ha egyre egyáltalán), és megvan a saját status értéke.

curl -s https://xuda.ai/cpi/agent_domain_list \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'
const res = await fetch('https://xuda.ai/cpi/agent_domain_list', {
  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 d of data.domains) console.log(d.domain, d.status, d.attached_app_id);
import requests

res = requests.post(
    'https://xuda.ai/cpi/agent_domain_list',
    json={'api_key': 'YOUR_API_KEY'},
)
body = res.json()
if body['code'] > 0:
    for d in body['data']['domains']:
        print(d['domain'], d['status'], d['attached_app_id'])

2. Irányítsa az egyiket a kulcs projektjére

A domain az előző hívás által visszaadott nevek egyike kell legyen. A subdomain nem kötelező, és nem függ az alkalmazáskulcs saját projektnevétől, ez a domain egy címkéje ("app" az app.example.com esetén); hagyja ki, ha inkább a domain gyökerére irányít. Ha ezt más subdomain értékkel futtatja újra, az nem zavarja a már csatlakoztatott gazdanevet, csak pontosan annak a gazdanévnek a rekordja cserélődik.

curl -s https://xuda.ai/cpi/agent_domain_connect \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_APP_API_KEY","domain":"example.com","subdomain":"app"}'
const res = await fetch('https://xuda.ai/cpi/agent_domain_connect', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_APP_API_KEY',
    domain: 'example.com',
    subdomain: 'app',
  }),
});
const { code, data } = await res.json();
if (code > 0) console.log(data.record.type, data.record.name, data.record.target);
import requests

res = requests.post(
    'https://xuda.ai/cpi/agent_domain_connect',
    json={'api_key': 'YOUR_APP_API_KEY', 'domain': 'example.com', 'subdomain': 'app'},
)
body = res.json()
if body['code'] > 0:
    print(body['data']['record']['type'], body['data']['record']['name'], body['data']['record']['target'])

A válasz

Az agent_domain_list minden tárolt domaindokumentumot négy mezőre vág:

json
{
  "code": 1,
  "data": {
    "count": 2,
    "domains": [
      {
        "domain": "example.com",
        "status": "active",
        "connection_type": "registered",
        "attached_app_id": null
      },
      {
        "domain": "example.org",
        "status": "active",
        "connection_type": "connected",
        "attached_app_id": "app_5d9e21"
      }
    ]
  }
}

A connection_type értéke registered a Xudán keresztül vásárolt domainnél (a Xuda a regisztrátor és a DNS), vagy connected a máshol regisztrált, de a névszervereit a Xudára delegáló domainnél (csak DNS, a regisztráció ott marad, ahol volt). Az agent_domain_connect számára mindkettő ugyanúgy működik.

Az agent_domain_connect a ténylegesen megírt DNS-rekorddal válaszol:

json
{
  "code": 1,
  "data": {
    "ok": true,
    "record": {
      "type": "A",
      "name": "app.example.com",
      "target": "203.0.113.42",
      "proxied": true,
      "ssl_mode": "full"
    }
  }
}

A type attól függ, milyen projekthez van kötve a kulcs, nem attól, amit küld: a VPS-projekt A rekordot kap az IP-címére (vagy AAAA rekordot egy farm virtuális gépen, amelynek nincs nyilvános IPv4-e), minden más CNAME rekordot kap a projekt saját hozzáférési URL-jére. Minden rekord Cloudflare-proxizott (proxied: true), így a látogató mindkét esetben HTTPS-t kap az élen. Az ssl_mode csak a VPS-úton van beállítva, ahol a Xuda a zóna eredeti SSL-módját is felméri és beállítja (full, strict vagy flexible); CNAME célnál null jön vissza, ezt az esetet a Cloudflare saját Universal SSL szolgáltatása fedi le, zónabeállítás nélkül, amelyet jelenteni kellene.

Hibák

Következő