Przejdź do treści
Zweryfikowano

Połącz domenę

Skieruj jedną z własnych domen konta na projekt tego klucza przez DNS, kluczem o zakresie App.

agent_domain_connect to wywołanie o zakresie projektu: w przeciwieństwie do każdego innego zapisu w tej sekcji nie przyjmuje app_id. Projekt, na który kieruje domenę, to ten, z którego powstał sam klucz API, więc ten przepis potrzebuje klucza App (utworzonego na własnej karcie API projektu), a nie klucza Account. agent_domain_list to towarzyszący odczyt, własne domeny konta, dzięki czemu zawsze wysyłasz nazwę, którą konto faktycznie posiada.

Metody

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.

To wymaga klucza App, a nie klucza Account

Obie metody ustalają uid z wysłanego klucza, tak jak wszędzie, ale agent_domain_connect ustala z niego też app_id, a niesie go tylko klucz utworzony z karty API projektu. Wywołaj ją kluczem Account, a odpowie -1, 'no app is bound to this action', zanim w ogóle spojrzy na domenę. Zobacz Uwierzytelnianie, żeby poznać trzy zakresy kluczy.

Krok po kroku

Wylistuj domeny konta

Żadnych pól poza Twoim kluczem. Każdy wiersz to jedna domena, którą konto zarejestrowało przez Xuda albo połączyło, delegując jej serwery nazw, na jakikolwiek projekt (jeśli w ogóle) obecnie wskazuje, oraz jej własny 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. Skieruj jedną na projekt tego klucza

domain musi być jedną z nazw, które zwróciło poprzednie wywołanie. subdomain jest opcjonalna i niezwiązana z nazwą projektu klucza App, to etykieta na domenie ("app" dla app.example.com); pomiń ją, żeby skierować zamiast tego główną domenę (apex). Ponowne uruchomienie z inną subdomain nie narusza nazwy hosta, którą już podłączyłeś, zastępowany jest tylko rekord dokładnie tej nazwy hosta.

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

Odpowiedź

agent_domain_list przycina każdy zapisany dokument domeny do czterech pól:

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 to registered dla domeny kupionej przez Xuda (Xuda jest rejestratorem i DNS-em) albo connected dla domeny zarejestrowanej gdzie indziej, z serwerami nazw delegowanymi do Xuda (tylko DNS, rejestracja zostaje tam, gdzie była). Obie działają tak samo dla agent_domain_connect.

agent_domain_connect odpowiada rekordem DNS, który faktycznie zapisał:

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

type zależy od tego, jakiego rodzaju projektem jest klucz, a nie od niczego, co wysyłasz: projekt VPS dostaje rekord A do swojego IP (albo AAAA na maszynie farmy bez publicznego IPv4), cała reszta dostaje CNAME do własnego adresu dostępu projektu. Każdy rekord jest przepuszczany przez proxy Cloudflare (proxied: true), więc odwiedzający w obu przypadkach dostaje HTTPS na brzegu. ssl_mode jest ustawiany tylko na ścieżce VPS, gdzie Xuda także sprawdza i ustawia tryb SSL pochodzenia strefy (full, strict lub flexible); dla celu CNAME wraca jako null, to przypadek pokryty przez własne Universal SSL Cloudflare, bez ustawienia strefy do zgłoszenia.

Błędy

Dalej