Stac Collection Config - Get

Layanan:: Planetary Computer

Versi API:: 2026-04-15

Dapatkan Konfigurasi
Dapatkan konfigurasi pengguna lengkap untuk koleksi tertentu

GET {endpoint}/stac/collections/{collectionId}/configurations?api-version=2026-04-15

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
collectionId	path	True	string maxLength: 500 pattern: .*	Pengidentifikasi unik untuk koleksi STAC.
endpoint	path	True	string (uri)	Titik akhir GeoCatalog, misalnya `https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com`
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	UserCollectionSettings	Permintaan telah berhasil.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

UserCollectionSettings

Permintaan telah berhasil.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Respons kesalahan tak terduga.

Header

x-ms-error-code: string

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://geocatalog.spatio.azure.com/.default

Contoh

StacCollectionConfig_Get

Permintaan sampel

HTTP

GET {endpoint}/stac/collections/naip-atl/configurations?api-version=2026-04-15

Respon sampel

Kode status:: 200

{
  "tileSettings": {
    "minZoom": 6,
    "maxItemsPerTile": 35,
    "defaultLocation": null
  },
  "mosaicInfo": {
    "mosaics": [
      {
        "id": "default",
        "name": "Default",
        "description": "",
        "cql": []
      },
      {
        "id": "mos1",
        "name": "Most recent available",
        "description": "Most recent available imagery in this collection",
        "cql": []
      },
      {
        "id": "test-mosaic-1",
        "name": "Test Most recent available",
        "description": "Most recent available imagery in this collection - updated",
        "cql": []
      }
    ],
    "renderOptions": [
      {
        "id": "natural-color",
        "name": "Natural color",
        "description": "RGB from visual assets",
        "type": "raster-tile",
        "options": "assets=image&asset_bidx=image|1,2,3",
        "vectorOptions": null,
        "minZoom": 6,
        "legend": null,
        "conditions": null
      },
      {
        "id": "test-natural-color",
        "name": "Test Natural color updated",
        "description": "RGB from visual assets - updated",
        "type": "raster-tile",
        "options": "assets=image&asset_bidx=image|1,2,3",
        "vectorOptions": null,
        "minZoom": 6,
        "legend": null,
        "conditions": null
      }
    ],
    "defaultLocation": null,
    "defaultCustomQuery": null
  }
}

Definisi

Nama	Deskripsi
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai Azure pedoman REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DefaultLocation	Menentukan lokasi geografis default untuk visualisasi peta.
LegendConfigType	Jenis legenda yang akan dibuat, salah satunya: `continuous`, `classmap`, atau `intervalnone` (catatan, `none` adalah literal string).
RenderOption	Menentukan parameter visualisasi untuk merender data pada peta.
RenderOptionCondition	Menentukan kondisi untuk mengaktifkan opsi render.
RenderOptionLegend	Konfigurasi untuk menghasilkan legenda data.
RenderOptionType	Menentukan jenis opsi render untuk visualisasi peta.
RenderOptionVectorOptions	Menentukan parameter untuk rendering petak peta vektor.
StacMosaic	Menentukan mosaik bernama dengan kriteria pemfilteran.
StacMosaicConfiguration	Konfigurasi untuk visualisasi mosaik data.
TileSettings	Konfigurasi untuk visualisasi petak peta.
UserCollectionSettings	Pengaturan koleksi khusus pengguna untuk visualisasi.

Azure.Core.Foundations.Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Objek

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai Azure pedoman REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

DefaultLocation

Objek

Menentukan lokasi geografis default untuk visualisasi peta.

Nama	Jenis	Deskripsi
coordinates	number[] (float)	Koordinat pusat default [lintang, bujur] untuk peta.
zoom	integer (int32)	Tingkat zoom default untuk peta.

LegendConfigType

Enumerasi

Jenis legenda yang akan dibuat, salah satunya: continuous, classmap, atau intervalnone (catatan, none adalah literal string).

Nilai	Deskripsi
continuous	Legenda ramp warna terus menerus.
classmap	Peta rahasia dengan warna diskrit untuk kelas.
interval	Legenda berbasis interval dengan rentang diskrit.
none	Tidak ada legenda.

RenderOption

Objek

Menentukan parameter visualisasi untuk merender data pada peta.

Nama	Jenis	Nilai default	Deskripsi
conditions	RenderOptionCondition[]		Daftar kondisi properti/nilai yang harus ada di CQL mosaik aktif agar opsi render ini diaktifkan
description	string		Deskripsi yang lebih panjang tentang opsi render yang dapat digunakan untuk menjelaskan kontennya.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Pengidentifikasi unik untuk opsi render.
legend	RenderOptionLegend		Konfigurasi legenda untuk opsi render ini.
minZoom	integer (int32) maximum: 24	12	Tingkat zoom minimum untuk menampilkan layer ini.
name	string maxLength: 40		Nama deskriptif pendek untuk opsi render.
options	string		String yang dikodekan string kueri URL dari opsi rendering TiTiTiler. Hanya berlaku untuk `raster-tile` jenis. Lihat Parameter Kueri.
type	RenderOptionType	raster-tile	Jenis rendering yang akan diterapkan (raster atau vektor).
vectorOptions	RenderOptionVectorOptions		Opsi untuk merender ubin vektor. Hanya berlaku untuk `vt-polygon` dan `vt-line` jenis.

RenderOptionCondition

Objek

Menentukan kondisi untuk mengaktifkan opsi render.

Nama	Jenis	Deskripsi
property	string	Nama properti untuk memeriksa filter CQL aktif.
value	string	Nilai yang harus sama dengan properti.

RenderOptionLegend

Objek

Konfigurasi untuk menghasilkan legenda data.

Nama	Jenis	Deskripsi
labels	string[]	Label teks untuk ditampilkan pada legenda.
scaleFactor	number (float)	Faktor untuk mengalikan label legenda interval dengan. Berguna untuk raster berskala yang definisi peta warnanya dipetakan ke nilai yang tidak diskalakan, secara efektif menampilkan label legenda sebagai nilai yang diskalakan.
trimEnd	integer (int32)	Jumlah item yang akan dipangkas dari akhir legenda.
trimStart	integer (int32)	Jumlah item yang akan dipangkas dari awal definisi legenda. Digunakan jika ada nilai penting untuk rendering (misalnya nodata) yang tidak diinginkan dalam legenda.
type	LegendConfigType	Jenis legenda yang akan dibuat, salah satunya: `continuous`, `classmap`, atau `intervalnone` (catatan, `none` adalah literal string).

RenderOptionType

Enumerasi

Menentukan jenis opsi render untuk visualisasi peta.

Nilai	Deskripsi
raster-tile	Jenis rendering ubin raster.
vt-polygon	Jenis rendering poligon ubin vektor.
vt-line	Jenis rendering garis ubin vektor.

RenderOptionVectorOptions

Objek

Menentukan parameter untuk rendering petak peta vektor.

Nama	Jenis	Deskripsi
fillColor	string	Isi warna untuk fitur poligon.
filter	string[]	Ekspresi filter MapBox GL untuk memfilter fitur.
sourceLayer	string	Nama layer sumber dalam ubin vektor.
strokeColor	string	Warna goresan untuk fitur garis.
strokeWidth	integer (int32)	Lebar goresan garis dalam piksel.
tilejsonKey	string	Kunci aset yang berisi URL TileJSON.

StacMosaic

Objek

Menentukan mosaik bernama dengan kriteria pemfilteran.

Nama	Jenis	Deskripsi
cql	Cql[]	Daftar ekspresi CQL2-JSON valid yang digunakan untuk memfilter koleksi ke moasic.
description	string	Deskripsi terperinci tentang mosaik.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Pengidentifikasi unik untuk mosaik.
name	string maxLength: 30	Nama deskriptif singkat untuk mosaik.

StacMosaicConfiguration

Objek

Konfigurasi untuk visualisasi mosaik data.

Nama	Jenis	Deskripsi
defaultCustomQuery		Daftar ekspresi CQL-JSON untuk digunakan sebagai default untuk koleksi ini.
defaultLocation	DefaultLocation	Lokasi peta default saat menampilkan koleksi ini.
mosaics	StacMosaic[]	Mosaik data yang telah ditentukan sebelumnya tersedia untuk koleksi ini.
renderOptions	RenderOption[]	Opsi render yang tersedia untuk memvisualisasikan data.

TileSettings

Objek

Konfigurasi untuk visualisasi petak peta.

Nama	Jenis	Deskripsi
defaultLocation	DefaultLocation	Lokasi peta default saat menampilkan koleksi ini.
maxItemsPerTile	integer (int32)	Jumlah maksimum item yang akan disertakan dalam satu petak peta.
minZoom	integer (int32) maximum: 24	Tingkat zoom minimum yang dapat diminta untuk koleksi ini. Memberikan batas keras bagi server ubin untuk memastikan mereka tidak mendapatkan permintaan untuk tingkat zoom rendah, yang akan menyebabkan banyak file diambil dan server ubin hang.

UserCollectionSettings

Objek

Pengaturan koleksi khusus pengguna untuk visualisasi.

Nama	Jenis	Deskripsi
mosaicInfo	StacMosaicConfiguration	Pengaturan untuk visualisasi mosaik data.
tileSettings	TileSettings	Pengaturan untuk visualisasi petak peta.

Bagikan melalui

Stac Collection Config - Get

Parameter URI

Respons

Keamanan

OAuth2Auth

Cakupan

Contoh

StacCollectionConfig_Get

Permintaan sampel

Respon sampel

Definisi

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

DefaultLocation

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions

StacMosaic

StacMosaicConfiguration

TileSettings

UserCollectionSettings