Sari la conținut
Verificat

Conectează un domeniu

Îndreaptă unul dintre domeniile proprii ale contului spre proiectul acestei chei prin DNS, cu o cheie de tip Aplicație.

agent_domain_connect este un apel limitat la un proiect: spre deosebire de orice altă scriere din această secțiune, nu primește app_id. Proiectul spre care îndreaptă un domeniu este cel din care a fost creată cheia API însăși, așa că această rețetă are nevoie de o cheie Aplicație (creată din fila API a unui proiect), nu de o cheie de cont. agent_domain_list este citirea însoțitoare, domeniile proprii ale contului, ca să trimiți mereu un nume pe care contul îl deține cu adevărat.

Metode

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.

Aici este nevoie de o cheie Aplicație, nu de o cheie de cont

Ambele metode rezolvă uid din cheia pe care o trimiți, ca peste tot, dar agent_domain_connect rezolvă din ea și app_id, iar doar o cheie creată din fila API a unui proiect îl poartă. Dacă o apelezi cu o cheie de cont, răspunde -1, 'no app is bound to this action', înainte să se uite măcar la domeniu. Vezi Autentificare pentru cele trei domenii ale cheilor.

Parcurgere

Listează domeniile contului

Niciun câmp în afară de cheia ta. Fiecare rând este un domeniu pe care contul l-a înregistrat prin Xuda sau l-a conectat delegând serverele de nume, indiferent de proiectul spre care (dacă există) îndreaptă acum, plus propriul 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. Îndreaptă unul spre proiectul acestei chei

domain trebuie să fie unul dintre numele returnate de apelul anterior. subdomain este opțional și nu are legătură cu numele proiectului cheii de aplicație, este o etichetă pe domeniu ("app" pentru app.example.com); omite-l ca să îndrepți în schimb apexul domeniului. Dacă rulezi din nou cu un alt subdomain, nu deranjezi un hostname atașat deja, doar înregistrarea acelui hostname exact este înlocuită.

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

Răspunsul

agent_domain_list reduce fiecare document de domeniu stocat la patru câmpuri:

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 este registered pentru un domeniu cumpărat prin Xuda (Xuda este registrarul și DNS-ul) sau connected pentru unul înregistrat în altă parte, cu serverele de nume delegate către Xuda (doar DNS, înregistrarea rămâne unde era). Ambele funcționează la fel pentru agent_domain_connect.

agent_domain_connect răspunde cu înregistrarea DNS pe care a scris-o de fapt:

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

type depinde de tipul de proiect la care este limitată cheia, nu de ceva ce trimiți tu: un proiect VPS primește o înregistrare A către IP-ul lui (sau AAAA pe un VM Farm fără IPv4 public), orice altceva primește un CNAME către URL-ul de acces al proiectului. Fiecare înregistrare trece prin proxy Cloudflare (proxied: true), așa că vizitatorul primește HTTPS la margine în ambele cazuri. ssl_mode este setat doar pe calea VPS, unde Xuda sondează și setează și modul SSL de origine al zonei (full, strict sau flexible); revine null pentru o țintă CNAME, deoarece Universal SSL al Cloudflare acoperă acel caz fără o setare de zonă de raportat.

Erori

Urmează