Dokumentacja API

Wszystkie API na tej stronie używają metody POST z treścią żądania w formacie JSON. Każde żądanie używa nagłówków z sekcji Wspólne nagłówki żądania, które nie są powtarzane przy poszczególnych API. Zewnętrzna struktura odpowiedzi jest opisana w sekcji Ujednolicona struktura odpowiedzi; sekcja „Odpowiedź” każdego API wymienia tylko pola biznesowe wewnątrz data.

Domeny

Wspólne nagłówki żądania

Każde API wymaga poniższych parametrów nagłówka.

Ujednolicona struktura odpowiedzi

Wszystkie API zwracają tę samą strukturę zewnętrzną. Zewnętrzne pole code odzwierciedla tylko wynik warstwy API; wynik biznesowy odczytuj z data.bizCode.

Uwaga: Wywołanie zakończyło się sukcesem tylko wtedy, gdy jednocześnie code == 0 i data.bizCode == 0.

Utworzenie zadania i pobranie poświadczeń przesyłania

Tworzy zadanie modelowania i wydaje tymczasowe poświadczenia magazynu w chmurze do przesłania danych wejściowych.

Punkt końcowy

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

Limity

Parametry żądania

Odpowiedź

Przykład żądania

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"]
}

Przykład odpowiedzi

{
  "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"
    }
  }
}

Uruchomienie zadania

Ręcznie rozpoczyna modelowanie.

Punkt końcowy

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

Limity

Parametry żądania

Odpowiedź

Zwraca tylko strukturę opisaną w sekcji Ujednolicona struktura odpowiedzi.

Przykład żądania

{
  "modelId": 100231987
}

Ponowne pobranie poświadczeń przesyłania

Uzyskuje nowe tymczasowe poświadczenia przesyłania, gdy przesyłanie zostało przerwane lub tymczasowe poświadczenia wygasły.

Punkt końcowy

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

Limity

Parametry żądania

Odpowiedź

Taka sama jak odpowiedź API Utworzenie zadania i pobranie poświadczeń przesyłania (data.modelId i data.params.*).

Przykład żądania

{
  "modelId": 100231987
}

Aktualizacja statusu przesyłania

Zgłasza status przesyłania danych wejściowych. To API trzeba wywołać po zakończeniu przesyłania; w przeciwnym razie modelowanie się nie rozpocznie.

Punkt końcowy

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

Limity

Parametry żądania

Odpowiedź

Zwraca tylko strukturę opisaną w sekcji Ujednolicona struktura odpowiedzi.

Przykład żądania

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

Anulowanie modelowania

Można wywołać tylko dla zadań, które są w trakcie modelowania.

• Anulować można tylko zadania o statusie Modelowanie. Po anulowaniu status zadania zmienia się na Modelowanie nieudane.
• Anulowanie powoduje pobranie punktów za już wykorzystane zasoby; nadwyżka zamrożonych punktów wraca na saldo.
• Rozliczenie punktów następuje zwykle w ciągu kilku minut, maksymalnie po około 10 minutach.

Punkt końcowy

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

Limity

Parametry żądania

Odpowiedź

Zwraca tylko strukturę opisaną w sekcji Ujednolicona struktura odpowiedzi.

Przykład żądania

{
  "modelId": 100231987
}

Lista zadań ze stronicowaniem

Wyszukuje zadania modelowania strona po stronie z użyciem filtrów.

Punkt końcowy

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

Limity

Parametry żądania

Odpowiedź

Przykład żądania

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

Szczegóły zadań

Zbiorczo wyszukuje szczegóły zadań modelowania, w tym statystyki takie jak czas trwania modelowania.

Punkt końcowy

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

Limity

Parametry żądania

Odpowiedź

Przykład żądania

{
  "modelIdList": [100231987, 100231988]
}

Punkty konta

Sprawdza saldo punktów konta powiązanego z appId.

Punkt końcowy

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

Limity

Parametry żądania

Brak parametrów biznesowych. Przekaż pusty obiekt {}.

Odpowiedź

Przykład odpowiedzi

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

Uwaga: To API służy wyłącznie do sprawdzania salda punktów konta. Zasady rozliczania punktów za zadania modelowania (moment pobrania i podstawa naliczania) zostaną określone i opisane w jednej z kolejnych wersji. W obecnej wersji wartości zwracane przez to API nie wpływają na wywołania API modelowania.

Pobieranie wyników modelowania

Uzyskuje tymczasowe linki do pobrania wyników modelowania. Ich zawartość opisano w sekcji Wyniki modelowania.

Punkt końcowy

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

Limity

Parametry żądania

Odpowiedź

Przykład żądania

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

Usunięcie zadania

Usuwa zadanie modelowania i powiązane z nim dane.

Punkt końcowy

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

Limity

Parametry żądania

Odpowiedź

Zwraca tylko strukturę opisaną w sekcji Ujednolicona struktura odpowiedzi.

Przykład żądania

{
  "modelId": 100231987
}

Uwaga: Usunięcia nie można cofnąć; dane wejściowe i wyniki modelowania są usuwane razem. Dodaj po swojej stronie dodatkowe potwierdzenie.