API Başvurusu

Bu sayfadaki tüm API'ler POST yöntemini kullanır ve JSON istek gövdesi alır. Her istek Ortak İstek Başlıkları bölümündeki başlıkları kullanır; bunlar her API için ayrıca tekrarlanmaz. Dış yanıt yapısı Birleşik yanıt yapısı bölümünde açıklanır; her API'nin "Yanıt" bölümünde yalnızca data içindeki iş alanları listelenir.

Alan Adları

Ortak İstek Başlıkları

Her API için aşağıdaki başlık parametreleri gereklidir.

Birleşik Yanıt Yapısı

Tüm API'ler aynı dış yapıyı döndürür. Dıştaki code yalnızca API katmanının sonucunu yansıtır; iş sonucu için data.bizCode değerini okuyun.

Not: Bir çağrı yalnızca code == 0 ve data.bizCode == 0 koşulları birlikte sağlandığında başarılıdır.

Görev Oluşturma ve Yükleme Kimlik Bilgilerini Alma

Bir modelleme görevi oluşturur ve girdi verilerini yüklemek için geçici bulut depolama kimlik bilgileri verir.

Uç Nokta

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

Sınırlar

İstek Parametreleri

Yanıt

İstek Örneği

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

Yanıt Örneği

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

Görevi Başlatma

Modellemeyi manuel olarak başlatır.

Uç Nokta

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

Sınırlar

İstek Parametreleri

Yanıt

Yalnızca Birleşik Yanıt Yapısı döndürülür.

İstek Örneği

{
  "modelId": 100231987
}

Yükleme Kimlik Bilgilerini Yeniden Alma

Yükleme kesintiye uğradığında veya geçici kimlik bilgilerinin süresi dolduğunda yeni geçici yükleme kimlik bilgilerini alır.

Uç Nokta

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

Sınırlar

İstek Parametreleri

Yanıt

Görev Oluşturma ve Yükleme Kimlik Bilgilerini Alma yanıtıyla aynıdır (data.modelId ve data.params.*).

İstek Örneği

{
  "modelId": 100231987
}

Yükleme Durumunu Güncelleme

Girdi verisinin yükleme durumunu bildirir. Yükleme tamamlandıktan sonra bu API'yi çağırmanız gerekir; aksi takdirde modelleme başlamaz.

Uç Nokta

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

Sınırlar

İstek Parametreleri

Yanıt

Yalnızca Birleşik Yanıt Yapısı döndürülür.

İstek Örneği

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

Modellemeyi İptal Etme

Yalnızca modelleme aşamasındaki görevler için çağrılabilir.

• Yalnızca Modelleme durumundaki görevler iptal edilebilir. İptalden sonra görev durumu Modelleme başarısız olarak değişir.
• İptal işleminde, o ana kadar kullanılan miktar kadar kredi düşülür; dondurulmuş fazla krediler bakiyeye iade edilir.
• Krediler genellikle birkaç dakika içinde, en fazla yaklaşık 10 dakikada hesaplanır.

Uç Nokta

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

Sınırlar

İstek Parametreleri

Yanıt

Yalnızca Birleşik Yanıt Yapısı döndürülür.

İstek Örneği

{
  "modelId": 100231987
}

Sayfalanmış Görev Listesi

Modelleme görevlerini filtrelerle sayfa sayfa sorgular.

Uç Nokta

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

Sınırlar

İstek Parametreleri

Yanıt

İstek Örneği

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

Görev Ayrıntıları

Modelleme görevlerinin ayrıntılarını, modelleme süresi gibi istatistiklerle birlikte toplu olarak sorgular.

Uç Nokta

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

Sınırlar

İstek Parametreleri

Yanıt

İstek Örneği

{
  "modelIdList": [100231987, 100231988]
}

Hesap Kredileri

appId ile ilişkili hesabın kredi bakiyesini sorgular.

Uç Nokta

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

Sınırlar

İstek Parametreleri

İş parametresi yoktur. Boş bir nesne {} gönderin.

Yanıt

Yanıt Örneği

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

Not: Bu API yalnızca hesap kredi bakiyesini sorgular. Modelleme görevlerinin kredi ücretlendirme kuralları (düşüm zamanı ve ücretlendirme dayanağı) sonraki bir sürümde belirlenecek ve belgelenecektir. Mevcut sürümde modelleme API'lerine yapılan çağrılar, burada döndürülen değerlerden etkilenmez.

Modelleme Sonuçlarını İndirme

Modelleme çıktıları için geçici indirme bağlantılarını alır. İçerikleri için Modelleme çıktıları bölümüne bakın.

Uç Nokta

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

Sınırlar

İstek Parametreleri

Yanıt

İstek Örneği

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

Görevi Silme

Bir modelleme görevini ve ilişkili verilerini siler.

Uç Nokta

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

Sınırlar

İstek Parametreleri

Yanıt

Yalnızca Birleşik Yanıt Yapısı döndürülür.

İstek Örneği

{
  "modelId": 100231987
}

Not: Silme işlemi geri alınamaz; girdi verileri ve modelleme çıktıları birlikte kaldırılır. Kendi tarafınızda ikinci bir onay adımı ekleyin.