Preskočiť na obsah
Overené

Pripojiť doménu

Nasmerujte jednu z domén účtu na projekt tohto kľúča cez DNS pomocou kľúča s rozsahom App.

agent_domain_connect je volanie s rozsahom projektu: na rozdiel od každého iného zápisu v tejto sekcii neberie app_id. Projekt, na ktorý doménu nasmeruje, je ten, z ktorého bol vytvorený samotný API kľúč, takže tento recept potrebuje kľúč Aplikácia (vytvorený z karty API vlastného projektu), nie kľúč Account. agent_domain_list je sprievodné čítanie, vlastné domény účtu, aby ste vždy poslali názov, ktorý účet skutočne vlastní.

Methods

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.

Toto potrebuje kľúč App, nie kľúč Account

Obe metódy určia uid z kľúča, ktorý pošlete, rovnako ako všade inde, ale agent_domain_connect z neho určuje aj app_id a ten nesie iba kľúč vytvorený z karty API projektu. Ak ju zavoláte s kľúčom Account, odpovie -1, 'no app is bound to this action', ešte predtým, než sa pozrie na doménu. Tri rozsahy kľúčov nájdete v časti Authentication.

Walkthrough

List the account's domains

Žiadne polia okrem vášho kľúča. Každý riadok je jedna doména, ktorú účet zaregistroval cez Xudu alebo pripojil delegovaním svojich menných serverov, bez ohľadu na to, na ktorý projekt (ak nejaký) momentálne smeruje, a jej vlastný 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. Point one at this key's project

domain musí byť jedným z názvov, ktoré vrátilo predchádzajúce volanie. subdomain je voliteľný a nesúvisí s vlastným názvom projektu kľúča App, je to označenie na doméne ("app" pre app.example.com); ak ho vynecháte, nasmeruje sa koreň domény. Opätovné spustenie s iným subdomain neruší názov hostiteľa, ktorý ste už pripojili, nahradí sa iba záznam presne toho názvu hostiteľa.

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

The response

agent_domain_list skracuje každý uložený dokument domény na štyri polia:

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 pre doménu kúpenú cez Xudu (Xuda je registrátor aj DNS) alebo connected pre doménu registrovanú inde s menými servermi delegovanými na Xudu (iba DNS, registrácia zostáva tam, kde bola). Obe fungujú pre agent_domain_connect rovnako.

agent_domain_connect odpovie záznamom DNS, ktorý skutočne zapísal:

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í od toho, na aký druh projektu je kľúč viazaný, nie od ničoho, čo pošlete: projekt VPS dostane záznam A na svoju IP (alebo AAAA na farm VM bez verejnej IPv4), všetko ostatné dostane CNAME na vlastnú prístupovú URL projektu. Každý záznam prechádza cez proxy Cloudflare (proxied: true), takže návštevník v oboch prípadoch dostane HTTPS na okraji. ssl_mode sa nastavuje iba pri ceste VPS, kde Xuda tiež zistí a nastaví režim SSL pôvodu zóny (full, strict alebo flexible); pri cieli CNAME sa vráti null, tento prípad pokrýva vlastné Universal SSL od Cloudflare bez nastavenia zóny, ktoré by sa dalo hlásiť.

Errors

Next