Stac Collection Config - Get

Usługa:: Planetary Computer

Wersja interfejsu API:: 2026-04-15

Pobieranie konfiguracji
Pobierz pełną konfigurację użytkownika dla danej kolekcji

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
collectionId	path	True	string maxLength: 500 pattern: .*	Niepowtarzalny identyfikator kolekcji STAC.
endpoint	path	True	string (uri)	Endpoint GeoCatalog, np. `https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com`
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	UserCollectionSettings	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

UserCollectionSettings

Żądanie zakończyło się pomyślnie.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://geocatalog.spatio.azure.com/.default

Przykłady

StacCollectionConfig_Get

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DefaultLocation	Definiuje domyślną lokalizację geograficzną dla wizualizacji mapy.
LegendConfigType	Typ legendy do wykonania: `continuous`, `classmap`, lub `intervalnone` (uwaga, `none` to dosłowny ciąg znaków).
RenderOption	Definiuje parametry wizualizacji do renderowania danych na mapie.
RenderOptionCondition	Definiuje warunek umożliwiający włączenie opcji renderowania.
RenderOptionLegend	Konfiguracja generowania legendy danych.
RenderOptionType	Określa typy opcji renderowania dla wizualizacji map.
RenderOptionVectorOptions	Definiuje parametry renderowania kafelków wektorowych.
StacMosaic	Definiuje nazwaną mozaikę z kryteriami filtrowania.
StacMosaicConfiguration	Konfiguracja do wizualizacji mozaiki danych.
TileSettings	Konfiguracja wizualizacji kafelków mapy.
UserCollectionSettings	Ustawienia kolekcji specyficzne dla użytkownika dla wizualizacji.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

DefaultLocation

Objekt

Definiuje domyślną lokalizację geograficzną dla wizualizacji mapy.

Nazwa	Typ	Opis
coordinates	number[] (float)	Domyślne współrzędne środka [szerokość, długość geograficzna] mapy.
zoom	integer (int32)	Domyślny poziom powiększenia mapy.

LegendConfigType

Wyliczenie

Typ legendy do wykonania: continuous, classmap, lub intervalnone (uwaga, none to dosłowny ciąg znaków).

Wartość	Opis
continuous	Legenda ciągłej kolorowej rampy.
classmap	Mapa klas z dyskretnymi kolorami.
interval	Legenda oparta na interwałach z dyskretnymi zakresami.
none	Nie ma legendy.

RenderOption

Objekt

Definiuje parametry wizualizacji do renderowania danych na mapie.

Nazwa	Typ	Domyślna wartość	Opis
conditions	RenderOptionCondition[]		Lista warunków właściwości/wartości, które muszą znaleźć się w aktywnym mozaikowym CQL, aby ta opcja renderowania została włączona
description	string		Dłuższy opis opcji renderowania, który może wyjaśnić jej zawartość.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Unikalny identyfikator opcji renderowania.
legend	RenderOptionLegend		Konfiguracja legendy dla tej opcji renderowania.
minZoom	integer (int32) maximum: 24	12	Minimalny poziom powiększenia, na którym można wyświetlić tę warstwę.
name	string maxLength: 40		Krótka opisowa nazwa opcji renderowania.
options	string		Łańcuch zakodowany przez zapytanie łańcucha URL z opcjami renderowania TiTiler. Dotyczy tylko `raster-tile` typów. Zobacz Parametry zapytania.
type	RenderOptionType	raster-tile	Rodzaj renderowania, który należy zastosować (rastr lub wektor).
vectorOptions	RenderOptionVectorOptions		Opcje renderowania kafelków wektorowych. Dotyczy tylko `vt-polygon` typów i `vt-line` typów.

RenderOptionCondition

Objekt

Definiuje warunek umożliwiający włączenie opcji renderowania.

Nazwa	Typ	Opis
property	string	Nazwa właściwości, aby sprawdzić w aktywnym filtrze CQL.
value	string	Wartości, której nieruchomość musi być równa.

RenderOptionLegend

Objekt

Konfiguracja generowania legendy danych.

Nazwa	Typ	Opis
labels	string[]	Etykiety tekstowe do wyświetlenia na legendzie.
scaleFactor	number (float)	Czynnik do mnożenia etykiet legend przez. Przydatne dla skalowanych rastrów, których definicje mapy kolorów odwzorowują się na wartości nieskalowane, skutecznie pokazując etykiety legend jako wartości skalowane.
trimEnd	integer (int32)	Liczba przedmiotów do usunięcia z końca legendy.
trimStart	integer (int32)	Liczba elementów do przycięcia od początku definicji legendy. Używa się, jeśli w legendzie są wartości ważne dla renderowania (np. nodata), które nie są pożądane.
type	LegendConfigType	Typ legendy do wykonania: `continuous`, `classmap`, lub `intervalnone` (uwaga, `none` to dosłowny ciąg znaków).

RenderOptionType

Wyliczenie

Określa typy opcji renderowania dla wizualizacji map.

Wartość	Opis
raster-tile	Typ renderowania kafelków rastrowych.
vt-polygon	Typ renderowania wielokątów z kafelkami wektorowymi.
vt-line	Typ renderowania linii wektorowych kafelków.

RenderOptionVectorOptions

Objekt

Definiuje parametry renderowania kafelków wektorowych.

Nazwa	Typ	Opis
fillColor	string	Kolor wypełniający dla cech wielokątnych.
filter	string[]	MapBox GL wyrażenie filtrów do cech filtracyjnych.
sourceLayer	string	Nazwa warstwy źródłowej w kafelkach wektorowych.
strokeColor	string	Kolor kresek dla cech linii.
strokeWidth	integer (int32)	Szerokość kresek linii w pikselach.
tilejsonKey	string	Klucz asset zawierający adres URL TileJSON.

StacMosaic

Objekt

Definiuje nazwaną mozaikę z kryteriami filtrowania.

Nazwa	Typ	Opis
cql	Cql[]	Lista prawidłowych wyrażeń CQL2-JSON używanych do filtrowania kolekcji do moasic.
description	string	Szczegółowy opis mozaiki.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Niepowtarzalny identyfikator mozaiki.
name	string maxLength: 30	Krótka opisowa nazwa mozaiki.

StacMosaicConfiguration

Objekt

Konfiguracja do wizualizacji mozaiki danych.

Nazwa	Typ	Opis
defaultCustomQuery		Lista wyrażeń CQL-JSON, które mają być używane jako domyślne dla tej kolekcji.
defaultLocation	DefaultLocation	Domyślna lokalizacja na mapie podczas wyświetlania tej kolekcji.
mosaics	StacMosaic[]	Predefiniowane mozaiki danych dostępne dla tej kolekcji.
renderOptions	RenderOption[]	Dostępne opcje renderowania do wizualizacji danych.

TileSettings

Objekt

Konfiguracja wizualizacji kafelków mapy.

Nazwa	Typ	Opis
defaultLocation	DefaultLocation	Domyślna lokalizacja na mapie podczas wyświetlania tej kolekcji.
maxItemsPerTile	integer (int32)	Maksymalna liczba elementów, które mogą znaleźć się na jednym kafelku.
minZoom	integer (int32) maximum: 24	Minimalny poziom powiększenia, o który można wnioskować dla tej kolekcji. Zapewnia sztywny limit dla serwerów kafelków, aby zapewnić, że nie będą otrzymywać żądań o niskich poziomach powiększenia, co spowodowałoby pobranie wielu plików i zawieszenie serwerów kafelków.

UserCollectionSettings

Objekt

Ustawienia kolekcji specyficzne dla użytkownika dla wizualizacji.

Nazwa	Typ	Opis
mosaicInfo	StacMosaicConfiguration	Ustawienia wizualizacji mozaiki danych.
tileSettings	TileSettings	Ustawienia wizualizacji kafelków mapy.