Siirry sisältöön
Tarkistettu

Yhdistä verkkotunnus

Osoita yksi tilin omista verkkotunnuksista tämän avaimen projektiin DNS:n kautta Sovellus-avaimella.

agent_domain_connect on projektiin rajattu kutsu: toisin kuin jokainen muu tämän osion kirjoitus, se ei ota app_id:tä. Projekti, johon se osoittaa verkkotunnuksen, on se, josta itse API-avain luotiin, joten tämä resepti tarvitsee Sovellus-avaimen (luotu projektin omalta API-välilehdeltä), ei Tili-avainta. agent_domain_list on kumppanilukeminen, tilin omat verkkotunnukset, jotta lähetät aina nimen, jonka tili oikeasti omistaa.

Metodit

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.

Tämä tarvitsee Sovellus-avaimen, ei Tili-avainta

Molemmat metodit ratkaisevat uid:n lähettämästäsi avaimesta kuten kaikkialla muuallakin, mutta agent_domain_connect ratkaisee avaimesta myös app_id:n, ja vain projektin API-välilehdeltä luodulla avaimella sellainen on. Jos kutsut sitä Tili-avaimella, se vastaa -1, 'no app is bound to this action', ennen kuin se edes katsoo verkkotunnusta. Katso Todennus kolmesta avainlaajuudesta.

Läpikäynti

Listaa tilin verkkotunnukset

Ei muita kenttiä kuin avaimesi. Jokainen rivi on yksi verkkotunnus, jonka tili rekisteröi Xudan kautta tai yhdisti delegoimalla nimipalvelimensa, riippumatta siitä, mihin projektiin (jos mihinkään) se tällä hetkellä osoittaa, ja sen oma 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. Osoita yksi tämän avaimen projektiin

domain:n on oltava yksi edellisen kutsun palauttamista nimistä. subdomain on valinnainen eikä liity sovellusavaimen oman projektin nimeen, vaan se on verkkotunnuksen etuliite ("app" osoitteelle app.example.com); jätä se pois, jos haluat osoittaa verkkotunnuksen juureen. Kun ajat tämän uudelleen eri subdomain:lla, jo liittämääsi isäntänimeä ei häiritä, vain täsmälleen kyseisen isäntänimen tietue korvataan.

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

Vastaus

agent_domain_list typistää jokaisen tallennetun verkkotunnusdokumentin neljään kenttään:

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 on registered Xudan kautta ostetulle verkkotunnukselle (Xuda on rekisteröijä ja DNS) tai connected verkkotunnukselle, joka on rekisteröity muualla ja jonka nimipalvelimet on delegoitu Xudalle (vain DNS, rekisteröinti pysyy siellä missä oli). Molemmat toimivat agent_domain_connect:lle samalla tavalla.

agent_domain_connect vastaa DNS-tietueella, jonka se oikeasti kirjoitti:

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

type riippuu siitä, minkä tyyppiseen projektiin avain on rajattu, ei mistään, mitä lähetät: VPS-projekti saa A-tietueen IP-osoitteeseensa (tai AAAA:n farm-VM:lle, jolla ei ole julkista IPv4:ää), kaikki muu saa CNAME:n projektin omaan käyttöosoitteeseen. Jokainen tietue kulkee Cloudflaren välityksellä (proxied: true), joten kävijä saa HTTPS:n reunalla kummassakin tapauksessa. ssl_mode asetetaan vain VPS-polulla, jossa Xuda myös koettelee ja asettaa vyöhykkeen alkuperä-SSL-tilan (full, strict tai flexible); CNAME-kohteelle se palaa null:na, koska Cloudflaren oma Universal SSL kattaa tämän tapauksen ilman raportoitavaa vyöhykeasetusta.

Virheet

Seuraavaksi