Hopp til innholdet
Bekreftet

Koble til et domene

Pek et av kontoens egne domener mot prosjektet til denne nøkkelen over DNS, med en nøkkel på App-nivå.

agent_domain_connect er et kall på prosjektnivå: i motsetning til alle andre skrivinger i denne delen tar det ikke noe app_id. Prosjektet det peker et domene mot er det API-nøkkelen selv ble opprettet fra, så denne oppskriften trenger en App-nøkkel (opprettet fra et prosjekts egen API-fane), ikke en kontonøkkel. agent_domain_list er den tilhørende lesingen, kontoens egne domener, slik at du alltid sender et navn kontoen faktisk eier.

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.

Dette krever en App-nøkkel, ikke en kontonøkkel

Begge metodene henter uid fra nøkkelen du sender, som overalt ellers, men agent_domain_connect henter også app_id fra den, og bare en nøkkel opprettet fra et prosjekts API-fane har en. Kaller du den med en kontonøkkel, svarer den -1, 'no app is bound to this action', før den i det hele tatt ser på domenet. Se Autentisering for de tre nøkkelomfangene.

Gjennomgang

List kontoens domener

Ingen felt utover nøkkelen din. Hver rad er ett domene kontoen registrerte gjennom Xuda eller koblet til ved å delegere navneserverne, uansett hvilket prosjekt (om noe) det peker mot nå, og dets 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. Pek ett mot prosjektet til denne nøkkelen

domain må være ett av navnene det forrige kallet returnerte. subdomain er valgfritt og urelatert til navnet på appnøkkelens eget prosjekt, det er en etikett på domenet ("app" for app.example.com). Utelat det for å peke domenets rot i stedet. Å kjøre dette på nytt med et annet subdomain forstyrrer ikke et vertsnavn du allerede har koblet til, bare akkurat det vertsnavnets post byttes ut.

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 kutter hvert lagrede domenedokument ned til fire felt:

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 er registered for et domene kjøpt gjennom Xuda (Xuda er registraren og DNS-en) eller connected for et som er registrert andre steder med navneserverne delegert til Xuda (kun DNS, registreringen blir der den var). Begge fungerer likt for agent_domain_connect.

agent_domain_connect svarer med DNS-posten den faktisk skrev:

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

type avhenger av hva slags prosjekt nøkkelen gjelder for, ikke av noe du sender: et VPS-prosjekt får en A-post til IP-adressen sin (eller AAAA på en farm-VM uten offentlig IPv4), alt annet får en CNAME til prosjektets egen tilgangs-URL. Hver post går via Cloudflare-proxy (proxied: true), så den besøkende får HTTPS ved kanten uansett. ssl_mode settes bare på VPS-banen, der Xuda også undersøker og setter sonens SSL-modus mot opphavsserveren (full, strict eller flexible). Den kommer tilbake som null for et CNAME-mål, Cloudflares egen Universal SSL dekker det tilfellet uten en soneinnstilling å rapportere.

Feil

Neste