Přeskočit na obsah
Ověřeno

Připojit doménu

Namiřte jednu z vlastních domén účtu na projekt tohoto klíče přes DNS, pomocí klíče s rozsahem Aplikace.

agent_domain_connect je volání s rozsahem projektu: na rozdíl od každého jiného zápisu v této sekci nebere app_id. Projekt, na který doménu směruje, je ten, ze kterého byl vytvořen samotný klíč API, takže tento recept potřebuje klíč Aplikace (vytvořený na kartě API vlastního projektu), ne klíč Účtu. agent_domain_list je doprovodné čtení, vlastní domény účtu, takže vždy pošlete jméno, které účet skutečně vlastní.

Metody

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.

Potřebujete klíč Aplikace, ne klíč Účtu

Obě metody určují uid z klíče, který pošlete, stejně jako všude jinde, ale agent_domain_connect z něj určuje i app_id a ten nese jen klíč vytvořený na kartě API projektu. Zavoláte-li ji s klíčem Účtu, odpoví -1, 'no app is bound to this action', ještě než se na doménu vůbec podívá. Tři rozsahy klíčů najdete v části Ověřování.

Postup

Vypsat domény účtu

Žádná pole kromě klíče. Každý řádek je jedna doména, kterou účet zaregistroval přes Xudu nebo připojil delegováním jmenných serverů, s projektem (pokud nějaký), na který aktuálně míří, a vlastním status.

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. Namířit jednu na projekt tohoto klíče

domain musí být jedno z jmen, která vrátilo předchozí volání. subdomain je volitelná a nesouvisí s názvem projektu klíče aplikace, je to štítek na doméně ("app" pro app.example.com); vynechte ji, chcete-li namířit kořen domény. Opětovné spuštění s jinou subdomain nenaruší hostitelské jméno, které jste už připojili, nahradí se jen záznam přesně tohoto hostitelského jména.

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'])

Odpověď

agent_domain_list zkracuje každý uložený dokument domény na čtyři pole:

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"
      }
    ]
  }
}

connection_type je registered pro doménu koupenou přes Xudu (Xuda je registrátor i DNS) nebo connected pro doménu registrovanou jinde s jmennými servery delegovanými na Xudu (jen DNS, registrace zůstává tam, kde byla). Obě fungují s agent_domain_connect stejně.

agent_domain_connect odpoví DNS záznamem, který skutečně zapsala:

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

type závisí na tom, jaký druh projektu klíč zastupuje, ne na ničem, co pošlete: projekt VPS dostane záznam A na svou IP (nebo AAAA u farmového VM bez veřejné IPv4), všechno ostatní dostane CNAME na vlastní přístupovou URL projektu. Každý záznam je proxovaný přes Cloudflare (proxied: true), takže návštěvník má HTTPS na okraji v obou případech. ssl_mode se nastavuje jen u cesty VPS, kde Xuda také zjistí a nastaví režim SSL původu zóny (full, strict nebo flexible); u cíle CNAME se vrací null, protože tento případ pokrývá Universal SSL Cloudflare bez nastavení zóny, které by se hlásilo.

Chyby

Dále