Hoppa till innehållet
Verifierad

Anslut en domän

Peka en av kontots egna domäner mot den här nyckelns projekt via DNS, med en nyckel för App.

agent_domain_connect är ett anrop som gäller ett projekt: till skillnad från alla andra skrivningar i det här avsnittet tar det inget app_id. Projektet som en domän pekas mot är det som själva API-nyckeln skapades från, så det här receptet behöver en App-nyckel (skapad från ett projekts egen API-flik), inte en kontonyckel. agent_domain_list är den medföljande läsningen, kontots egna domäner, så att du alltid skickar ett namn som kontot faktiskt äger.

Metoder

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.

Det här kräver en App-nyckel, inte en kontonyckel

Båda metoderna läser ut uid från nyckeln du skickar, som överallt annars, men agent_domain_connect läser också ut app_id från den, och bara en nyckel som skapats från ett projekts API-flik har ett. Anropa den med en kontonyckel så svarar den -1, 'no app is bound to this action', innan den alls tittar på domänen. Se Autentisering för de tre nyckelomfången.

Genomgång

Lista kontots domäner

Inga fält utöver din nyckel. Varje rad är en domän som kontot har registrerat via Xuda eller anslutit genom att delegera sina namnservrar, vilket projekt (om något) den för tillfället pekar mot, och dess egen 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. Peka en mot den här nyckelns projekt

domain måste vara ett av de namn som föregående anrop returnerade. subdomain är valfritt och orelaterat till appnyckelns eget projektnamn, det är en etikett på domänen ("app" för app.example.com); utelämna det för att peka domänens rotnivå i stället. Om du kör om det här med en annan subdomain rubbas inte ett värdnamn som du redan kopplat, bara just det värdnamnets post ersätts.

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

Svaret

agent_domain_list kortar ner varje sparat domändokument till fyra fält:

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 är registered för en domän som köpts via Xuda (Xuda är registrar och DNS) eller connected för en som registrerats på annat håll med sina namnservrar delegerade till Xuda (endast DNS, registreringen stannar där den var). Båda fungerar på samma sätt för agent_domain_connect.

agent_domain_connect svarar med den DNS-post som faktiskt skrevs:

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

type beror på vilken sorts projekt nyckeln gäller, inte på något du skickar: ett VPS-projekt får en A-post till sin IP (eller AAAA på en farm-VM utan publik IPv4), allt annat får en CNAME till projektets egen åtkomst-URL. Varje post går via Cloudflare-proxy (proxied: true), så besökaren får HTTPS vid kanten oavsett. ssl_mode sätts bara på VPS-vägen, där Xuda också provar och sätter zonens SSL-läge mot origin (full, strict eller flexible); det kommer tillbaka som null för ett CNAME-mål, där Cloudflares egen Universal SSL täcker fallet utan någon zoninställning att rapportera.

Fel

Nästa