Stac Collection Config - Get

Dienst:: Planetary Computer

API-Version:: 2025-04-30-preview

Konfiguration abrufen
Abrufen der vollständigen Benutzerkonfiguration für eine bestimmte Sammlung

GET https:///stac/collections/{collectionId}/configurations?api-version=2025-04-30-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
collectionId	path	True	string maxLength: 500 pattern: .*	Eindeutige Kennung für die STAC-Sammlung.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	UserCollectionSettings	Die Anforderung ist erfolgreich.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

UserCollectionSettings

Die Anforderung ist erfolgreich.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://geocatalog.spatio.azure.com/.default

Beispiele

StacCollectionConfig_Get

Beispielanforderung

HTTP

GET https:///stac/collections/naip-atl/configurations?api-version=2025-04-30-preview

Beispiel für eine Antwort

Statuscode:: 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
  }
}

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors
DefaultLocation	Definiert eine geographische Standardposition für die Kartenvisualisierung.
LegendConfigType	Legendentyp, der erstellt werden soll: `continuous`, `classmap`oder `intervalnone` (Hinweis, `none` es handelt sich um ein Zeichenfolgenliteral).
RenderOption	Definiert Visualisierungsparameter für das Rendern von Daten auf einer Karte.
RenderOptionCondition	Definiert eine Bedingung für die Aktivierung einer Renderoption.
RenderOptionLegend	Konfiguration für die Generierung einer Datenlegende.
RenderOptionType	Gibt die Typen von Renderoptionen für die Kartenvisualisierung an.
RenderOptionVectorOptions	Definiert Parameter für das Rendern von Vektorkacheln.
StacMosaic	Definiert ein benanntes Mosaik mit Filterkriterien.
StacMosaicConfiguration	Konfiguration für die Visualisierung von Datenmosaik.
TileSettings	Konfiguration für die Visualisierung von Kartenkacheln.
UserCollectionSettings	Benutzerspezifische Sammlungseinstellungen für die Visualisierung.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine normal lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

DefaultLocation

Objekt

Definiert eine geographische Standardposition für die Kartenvisualisierung.

Name	Typ	Beschreibung
coordinates	number[] (float)	Standardmäßige Mittelkoordinaten [Breitengrad, Längengrad] für die Karte.
zoom	integer (int32)	Standardmäßiger Zoomfaktor für die Karte.

LegendConfigType

Enumeration

Legendentyp, der erstellt werden soll: continuous, classmapoder intervalnone (Hinweis, none es handelt sich um ein Zeichenfolgenliteral).

Wert	Beschreibung
continuous	Legende für den fortlaufenden Farbverlauf.
classmap	Klassifizierte Karte mit diskreten Farben für Klassen.
interval	Intervallbasierte Legende mit diskreten Bereichen.
none	Keine Legende.

RenderOption

Objekt

Definiert Visualisierungsparameter für das Rendern von Daten auf einer Karte.

Name	Typ	Standardwert	Beschreibung
conditions	RenderOptionCondition[]		Eine Liste der Eigenschafts-/Wertbedingungen, die sich in der aktiven Mosaik-CQL befinden müssen, damit diese Renderoption aktiviert werden kann
description	string		Eine längere Beschreibung der Render-Option, die zur Erläuterung des Inhalts verwendet werden kann.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Eindeutiger Bezeichner für die render-Option.
legend	RenderOptionLegend		Legendenkonfiguration für diese Renderoption.
minZoom	integer (int32) maximum: 24	12	Minimaler Zoomfaktor, bei dem dieser Layer angezeigt werden soll.
name	string maxLength: 40		Kurzer beschreibender Name für die Render-Option.
options	string		Eine URL-Abfragezeichenfolge, die mit TiTiler-Renderingoptionen codiert ist. Nur gültig für `raster-tile` Typen. Siehe Abfrageparameter.
type	RenderOptionType	raster-tile	Der Typ des anzuwendenden Renderings (Raster oder Vektor).
vectorOptions	RenderOptionVectorOptions		Optionen zum Rendern von Vektorkacheln. Gültig nur für `vt-polygon` und-Typen `vt-line` .

RenderOptionCondition

Objekt

Definiert eine Bedingung für die Aktivierung einer Renderoption.

Name	Typ	Beschreibung
property	string	Name der Eigenschaft, die im aktiven CQL-Filter eingecheckt werden soll.
value	string	Wert, dem die Eigenschaft entsprechen muss.

RenderOptionLegend

Objekt

Konfiguration für die Generierung einer Datenlegende.

Name	Typ	Beschreibung
labels	string[]	Textbeschriftungen, die in der Legende angezeigt werden sollen.
scaleFactor	number (float)	Ein Faktor, mit dem Legendenbeschriftungen des Intervalls multipliziert werden sollen. Nützlich für skalierte Raster, deren Colormap-Definitionen nicht skalierten Werten zugeordnet sind, sodass Legendenbeschriftungen effektiv als skalierte Werte angezeigt werden.
trimEnd	integer (int32)	Anzahl der Elemente, die ab dem Ende der Legende gekürzt werden sollen.
trimStart	integer (int32)	Die Anzahl der Elemente, die ab dem Anfang der Legendendefinition gekürzt werden sollen. Wird verwendet, wenn es Werte gibt, die für das Rendern wichtig sind (z. B. nodata), die in der Legende nicht erwünscht sind.
type	LegendConfigType	Legendentyp, der erstellt werden soll: `continuous`, `classmap`oder `intervalnone` (Hinweis, `none` es handelt sich um ein Zeichenfolgenliteral).

RenderOptionType

Enumeration

Gibt die Typen von Renderoptionen für die Kartenvisualisierung an.

Wert	Beschreibung
raster-tile	Rendering-Typ für Raster-Kacheln.
vt-polygon	Rendering-Typ für Vektorkachel-Polygone.
vt-line	Rendering-Typ für Vektorkachellinien.

RenderOptionVectorOptions

Objekt

Definiert Parameter für das Rendern von Vektorkacheln.

Name	Typ	Beschreibung
fillColor	string	Füllfarbe für Polygon-Features.
filter	string[]	MapBox GL-Filterausdruck zum Filtern von Features.
sourceLayer	string	Name der Quellebene in den Vektorkacheln.
strokeColor	string	Strichfarbe für Linien-Features.
strokeWidth	integer (int32)	Breite der Linienstriche in Pixeln.
tilejsonKey	string	Asset-Schlüssel, der die TileJSON-URL enthält.

StacMosaic

Objekt

Definiert ein benanntes Mosaik mit Filterkriterien.

Name	Typ	Beschreibung
cql	Cql[]	Eine Liste gültiger CQL2-JSON Ausdrücke, die zum Filtern der Auflistung nach moasic verwendet werden.
description	string	Detaillierte Beschreibung des Mosaiks.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Eindeutige Kennung für das Mosaik.
name	string maxLength: 30	Kurzer beschreibender Name für das Mosaik.

StacMosaicConfiguration

Objekt

Konfiguration für die Visualisierung von Datenmosaik.

Name	Typ	Beschreibung
defaultCustomQuery		Eine Liste der CQL-JSON Ausdrücke, die als Standard für diese Auflistung verwendet werden sollen.
defaultLocation	DefaultLocation	Standardposition der Karte bei der Anzeige dieser Sammlung.
mosaics	StacMosaic[]	Vordefinierte Datenmosaike, die für diese Sammlung verfügbar sind.
renderOptions	RenderOption[]	Verfügbare Renderoptionen zum Visualisieren der Daten.

TileSettings

Objekt

Konfiguration für die Visualisierung von Kartenkacheln.

Name	Typ	Beschreibung
defaultLocation	DefaultLocation	Standardposition der Karte bei der Anzeige dieser Sammlung.
maxItemsPerTile	integer (int32)	Maximale Anzahl von Elementen, die in einer einzelnen Kachel enthalten sein sollen.
minZoom	integer (int32) maximum: 24	Die minimale Zoomstufe, die für diese Sammlung angefordert werden kann. Stellt einen festen Grenzwert für die Kachelserver bereit, um sicherzustellen, dass sie keine Anforderungen für niedrige Zoomstufen erhalten, die dazu führen würden, dass viele Dateien abgerufen werden und die Kachelserver nicht mehr funktionieren.

UserCollectionSettings

Objekt

Benutzerspezifische Sammlungseinstellungen für die Visualisierung.

Name	Typ	Beschreibung
mosaicInfo	StacMosaicConfiguration	Einstellungen für die Visualisierung von Datenmosaik.
tileSettings	TileSettings	Einstellungen für die Visualisierung von Kartenkacheln.

Freigeben über

Stac Collection Config - Get

URI-Parameter

Antworten

Sicherheit

OAuth2Auth

Bereiche

Beispiele

StacCollectionConfig_Get

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

DefaultLocation

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions

StacMosaic

StacMosaicConfiguration

TileSettings

UserCollectionSettings