Gå til indhold
Bekræftet

Tilslut et domæne

Peg et af kontoens egne domæner på denne nøgles projekt over DNS, med en App-afgrænset nøgle.

agent_domain_connect er et projektafgrænset kald: i modsætning til alle andre skrivninger i dette afsnit tager det ingen app_id. Projektet, det peger et domæne på, er det, API-nøglen selv blev oprettet fra, så denne opskrift kræver en App-nøgle (oprettet fra et projekts egen API-fane), ikke en Account-nøgle. agent_domain_list er den tilhørende læsning, kontoens egne domæner, så du altid sender et navn, kontoen faktisk ejer.

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 kræver en App-nøgle, ikke en Account-nøgle

Begge metoder finder uid ud fra den nøgle, du sender, ligesom alle andre steder, men agent_domain_connect finder også app_id ud fra den, og kun en nøgle oprettet fra et projekts API-fane har en. Kald den med en Account-nøgle, og den svarer -1, 'no app is bound to this action', før den overhovedet ser på domænet. Se Godkendelse for de tre nøgleomfang.

Gennemgang

List kontoens domæner

Ingen felter ud over din nøgle. Hver række er ét domæne, kontoen har registreret gennem Xuda eller tilsluttet ved at delegere dets nameservere, uanset hvilket projekt (hvis nogen) det peger på lige nu, 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. Peg et af dem på denne nøgles projekt

domain skal være et af de navne, det forrige kald returnerede. subdomain er valgfrit og uden forbindelse til app-nøglens eget projektnavn, det er en etiket på domænet ("app" for app.example.com); udelad det for at pege domænets apex i stedet. Hvis du kører dette igen med et andet subdomain, forstyrrer det ikke et hostnavn, du allerede har tilsluttet, kun det præcise hostnavns post erstattes.

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 beskærer hvert gemte domænedokument til fire felter:

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 domæne købt gennem Xuda (Xuda er registrator og DNS) eller connected for et, der er registreret et andet sted, med nameservere delegeret til Xuda (Kun DNS, registreringen bliver, hvor den var). Begge virker på samme måde for agent_domain_connect.

agent_domain_connect svarer med den DNS-post, 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 afhænger af, hvilken slags projekt nøglen er afgrænset til, ikke af noget, du sender: et VPS- projekt får en A-post til sin IP (eller AAAA på en farm-VM uden offentlig IPv4), alt andet får en CNAME til projektets egen adgangs-URL. Hver post er Cloudflare-proxied (proxied: true), så den besøgende får HTTPS ved kanten i begge tilfælde. ssl_mode sættes kun på VPS-stien, hvor Xuda også undersøger og sætter zonens SSL-tilstand mod oprindelsen (full, strict eller flexible); den kommer tilbage som null for et CNAME-mål, hvor Cloudflares egen Universal SSL dækker det uden en zoneindstilling, der kan rapporteres.

Fejl

Næste