Riferimento API

Tutte le API di questa pagina usano POST con un corpo della richiesta JSON. Ogni richiesta usa le Intestazioni di richiesta comuni, che non vengono ripetute per ciascuna API. La struttura esterna della risposta è descritta in Struttura di risposta unificata; la sezione "Risposta" di ogni API elenca solo i campi di business all'interno di data.

Domini

Intestazioni di richiesta comuni

Ogni API richiede i seguenti parametri di intestazione.

Struttura di risposta unificata

Tutte le API restituiscono la stessa struttura esterna. Il code esterno riflette solo l'esito a livello di API; per l'esito di business leggi data.bizCode.

Nota: una chiamata ha esito positivo solo quando code == 0 e data.bizCode == 0.

Crea attività e ottieni credenziali di caricamento

Crea un'attività di modellazione e rilascia credenziali temporanee di cloud storage per caricare i dati di input.

Endpoint

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

Limiti

Parametri della richiesta

Risposta

Esempio di richiesta

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

Esempio di risposta

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

Avvia attività

Avvia manualmente la modellazione.

Endpoint

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

Limiti

Parametri della richiesta

Risposta

Restituisce solo la Struttura di risposta unificata.

Esempio di richiesta

{
  "modelId": 100231987
}

Ottieni di nuovo le credenziali di caricamento

Ottiene nuove credenziali temporanee di caricamento quando un caricamento si interrompe o le credenziali temporanee sono scadute.

Endpoint

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

Limiti

Parametri della richiesta

Risposta

Uguale alla risposta di Crea attività e ottieni credenziali di caricamento (data.modelId e data.params.*).

Esempio di richiesta

{
  "modelId": 100231987
}

Aggiorna stato di caricamento

Segnala lo stato di caricamento dei dati di input. Devi chiamare questa API al termine del caricamento; altrimenti la modellazione non si avvia.

Endpoint

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

Limiti

Parametri della richiesta

Risposta

Restituisce solo la Struttura di risposta unificata.

Esempio di richiesta

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

Annulla modellazione

Può essere chiamata solo per le attività in fase di modellazione.

• Si possono annullare solo le attività nello stato Modellazione in corso. Dopo l'annullamento, lo stato dell'attività diventa Modellazione non riuscita.
• L'annullamento detrae i crediti per l'utilizzo già consumato; gli eventuali crediti congelati in eccesso tornano nel saldo.
• I crediti vengono di solito regolati entro pochi minuti, al massimo circa 10 minuti.

Endpoint

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

Limiti

Parametri della richiesta

Risposta

Restituisce solo la Struttura di risposta unificata.

Esempio di richiesta

{
  "modelId": 100231987
}

Elenco attività paginato

Interroga le attività di modellazione pagina per pagina, con filtri.

Endpoint

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

Limiti

Parametri della richiesta

Risposta

Esempio di richiesta

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

Dettagli attività

Interroga in batch i dettagli delle attività di modellazione, incluse statistiche come la durata della modellazione.

Endpoint

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

Limiti

Parametri della richiesta

Risposta

Esempio di richiesta

{
  "modelIdList": [100231987, 100231988]
}

Crediti dell'account

Interroga il saldo dei crediti dell'account associato all'appId.

Endpoint

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

Limiti

Parametri della richiesta

Nessun parametro di business. Passa un oggetto vuoto {}.

Risposta

Esempio di risposta

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

Nota: questa API interroga solo il saldo dei crediti dell'account. Le regole di addebito dei crediti per le attività di modellazione (momento della detrazione e base di calcolo) saranno definite e documentate in una versione successiva. Nella versione attuale, le chiamate alle API di modellazione non dipendono dai valori restituiti qui.

Scarica risultati della modellazione

Ottiene i link di download temporanei degli output della modellazione. Per il loro contenuto vedi Output della modellazione.

Endpoint

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

Limiti

Parametri della richiesta

Risposta

Esempio di richiesta

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

Elimina attività

Elimina un'attività di modellazione e i dati associati.

Endpoint

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

Limiti

Parametri della richiesta

Risposta

Restituisce solo la Struttura di risposta unificata.

Esempio di richiesta

{
  "modelId": 100231987
}

Nota: l'eliminazione non è reversibile; i dati di input e gli output della modellazione vengono rimossi insieme. Aggiungi una seconda conferma nel tuo sistema.