API-Referenz

Alle APIs auf dieser Seite verwenden POST mit einem JSON-Anfragekörper. Jede Anfrage verwendet die Allgemeinen Anfrage-Header, die nicht bei jeder API wiederholt werden. Die äußere Antwortstruktur ist unter Einheitliche Antwortstruktur beschrieben; der Abschnitt „Antwort“ jeder API listet nur die Geschäftsfelder innerhalb von data auf.

Domains

Allgemeine Anfrage-Header

Jede API erfordert die folgenden Header-Parameter.

Einheitliche Antwortstruktur

Alle APIs geben dieselbe äußere Struktur zurück. Der äußere code gibt nur das Ergebnis auf API-Ebene wieder; das Geschäftsergebnis lesen Sie aus data.bizCode.

Hinweis: Ein Aufruf ist nur dann erfolgreich, wenn sowohl code == 0 als auch data.bizCode == 0 gilt.

Aufgabe erstellen und Upload-Zugangsdaten abrufen

Erstellt eine Modellierungsaufgabe und stellt temporäre Cloud-Speicher-Zugangsdaten für den Upload der Eingabedaten aus.

Endpunkt

POST /open-apis/spatial-model/v1/model/create

Grenzen

Anfrageparameter

Antwort

Anfragebeispiel

POST /open-apis/spatial-model/v1/model/create HTTP/1.1
Host: open-api-gw.xgrids.com
APP-ID: your_app_id
X-Timestamp: 1791763200
X-Nonce: a3f91c2d8e7b4a6590fd12cb77ae40d1
X-Sign: 9mQk7xL2vTbR4pNw8sYcA1dHfZ3eJgU6oIyK0rVnBsM=
Content-Type: application/json

{
  "modelName": "Design Commune C Facade",
  "modelDes": "Nanshan, Shenzhen, LCC2 scene package",
  "quality": "2",
  "autoRebuild": 1,
  "tags": ["facade", "nanshan"]
}

Antwortbeispiel

{
  "code": 0,
  "msg": "success",
  "data": {
    "bizCode": 0,
    "bizMsg": "",
    "modelId": 100231987,
    "params": {
      "cloudService": "AWS",
      "endpoint": "s3.ap-southeast-1.amazonaws.com",
      "region": "ap-southeast-1",
      "bucket": "your-bucket-name",
      "savePath": "prd/spatial-model/{accountId}/{taskCode}/input/",
      "accessKeyId": "ASIA****************",
      "accessKeySecret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCY****",
      "securityToken": "IQoJb3JpZ2luX2VjE****",
      "requestId": "b7f1e2a9-5c43-4d8e-9a10-6f2c3b84d517"
    }
  }
}

Aufgabe starten

Startet die Modellierung manuell.

Endpunkt

POST /open-apis/spatial-model/v1/model/start

Grenzen

Anfrageparameter

Antwort

Gibt nur die Einheitliche Antwortstruktur zurück.

Anfragebeispiel

{
  "modelId": 100231987
}

Upload-Zugangsdaten erneut abrufen

Ruft neue temporäre Upload-Zugangsdaten ab, wenn ein Upload unterbrochen wurde oder die temporären Zugangsdaten abgelaufen sind.

Endpunkt

POST /open-apis/spatial-model/v1/model/sts

Grenzen

Anfrageparameter

Antwort

Identisch mit der Antwort von Aufgabe erstellen und Upload-Zugangsdaten abrufen (data.modelId und data.params.*).

Anfragebeispiel

{
  "modelId": 100231987
}

Upload-Status aktualisieren

Meldet den Upload-Status der Eingabedaten. Sie müssen diese API nach Abschluss des Uploads aufrufen; andernfalls startet die Modellierung nicht.

Endpunkt

POST /open-apis/spatial-model/v1/model/upload_status/update

Grenzen

Anfrageparameter

Antwort

Gibt nur die Einheitliche Antwortstruktur zurück.

Anfragebeispiel

{
  "modelId": 100231987,
  "status": 3,
  "uploadTime": 184620
}

Modellierung abbrechen

Kann nur für Aufgaben aufgerufen werden, die gerade modelliert werden.

• Nur Aufgaben im Status „Modellierung läuft“ können abgebrochen werden. Nach dem Abbruch wechselt der Aufgabenstatus zu „Modellierung fehlgeschlagen“.
• Beim Abbruch werden Credits für die bereits verbrauchte Nutzung abgebucht; darüber hinaus eingefrorene Credits werden dem Guthaben wieder gutgeschrieben.
• Credits werden in der Regel innerhalb weniger Minuten abgerechnet, spätestens nach etwa 10 Minuten.

Endpunkt

POST /open-apis/spatial-model/v1/model/cancel

Grenzen

Anfrageparameter

Antwort

Gibt nur die Einheitliche Antwortstruktur zurück.

Anfragebeispiel

{
  "modelId": 100231987
}

Paginierte Aufgabenliste

Fragt Modellierungsaufgaben seitenweise mit Filtern ab.

Endpunkt

POST /open-apis/spatial-model/v1/model/list

Grenzen

Anfrageparameter

Antwort

Anfragebeispiel

{
  "modelName": "Design Commune",
  "statusList": [7, 8],
  "startTime": 1790899200000,
  "endTime": 1791763200000,
  "page": {
    "page": 1,
    "limit": 20,
    "order": "DESC"
  }
}

Aufgabendetails

Fragt Details von Modellierungsaufgaben stapelweise ab, einschließlich Statistiken wie der Modellierungsdauer.

Endpunkt

POST /open-apis/spatial-model/v1/model/detail

Grenzen

Anfrageparameter

Antwort

Anfragebeispiel

{
  "modelIdList": [100231987, 100231988]
}

Konto-Credits

Fragt das Credit-Guthaben des mit der appId verknüpften Kontos ab.

Endpunkt

POST /open-apis/spatial-model/v1/credit/info

Grenzen

Anfrageparameter

Keine Geschäftsparameter. Übergeben Sie ein leeres Objekt {}.

Antwort

Antwortbeispiel

{
  "code": 0,
  "msg": "success",
  "data": {
    "bizCode": 0,
    "bizMsg": "",
    "availableCredit": 8500,
    "frozenCredit": 1500,
    "totalCredit": 10000
  }
}

Hinweis: Diese API fragt nur das Credit-Guthaben des Kontos ab. Die Credit-Abrechnungsregeln für Modellierungsaufgaben (Zeitpunkt der Abbuchung und Abrechnungsgrundlage) werden in einer späteren Version festgelegt und dokumentiert. In der aktuellen Version werden Aufrufe der Modellierungs-APIs nicht von den hier zurückgegebenen Werten beeinflusst.

Modellierungsergebnisse herunterladen

Ruft temporäre Download-Links für die Modellierungsergebnisse ab. Was sie enthalten, lesen Sie unter Modellierungsergebnisse.

Endpunkt

POST /open-apis/spatial-model/v1/model/data/download

Grenzen

Anfrageparameter

Antwort

Anfragebeispiel

{
  "modelId": 100231987,
  "type": "GLB"
}

Aufgabe löschen

Löscht eine Modellierungsaufgabe und die zugehörigen Daten.

Endpunkt

POST /open-apis/spatial-model/v1/model/del

Grenzen

Anfrageparameter

Antwort

Gibt nur die Einheitliche Antwortstruktur zurück.

Anfragebeispiel

{
  "modelId": 100231987
}

Hinweis: Das Löschen kann nicht rückgängig gemacht werden; Eingabedaten und Modellierungsergebnisse werden zusammen entfernt. Bauen Sie auf Ihrer Seite eine zweite Bestätigung ein.