Stac Collection Config - Get

Tjänst:: Planetary Computer

API-version:: 2026-04-15

Hämta konfiguration
Hämta den fullständiga användarkonfigurationen för en viss samling

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Unik identifierare för STAC-samlingen.
endpoint	path	True	string (uri)	GeoCatalog-endpoint, t.ex. `https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com`
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	UserCollectionSettings	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

UserCollectionSettings

Begäran har slutförts.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

StacCollectionConfig_Get

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DefaultLocation	Definierar en geografisk standardplats för kartvisualisering.
LegendConfigType	Förklaringstyp som ska göras, en av: `continuous`, `classmap`, `interval` eller `none` (observera `none` att det är en strängliteral).
RenderOption	Definierar visualiseringsparametrar för återgivning av data på en karta.
RenderOptionCondition	Definierar ett villkor för att aktivera ett återgivningsalternativ.
RenderOptionLegend	Konfiguration för att generera en dataförklaring.
RenderOptionType	Anger typerna av återgivningsalternativ för kartvisualisering.
RenderOptionVectorOptions	Definierar parametrar för återgivning av vektorpaneler.
StacMosaic	Definierar en namngiven mosaik med filtreringskriterier.
StacMosaicConfiguration	Konfiguration för visualisering av datamosaik.
TileSettings	Konfiguration för visualisering av kartrutor.
UserCollectionSettings	Användarspecifika samlingsinställningar för visualisering.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

DefaultLocation

Objekt

Definierar en geografisk standardplats för kartvisualisering.

Name	Typ	Description
coordinates	number[] (float)	Standardkoordinater för mittpunkten [latitud, longitud] för kartan.
zoom	integer (int32)	Standardzoomnivå för kartan.

LegendConfigType

Uppräkning

Förklaringstyp som ska göras, en av: continuous, classmap, interval eller none (observera none att det är en strängliteral).

Värde	Description
continuous	Förklaring av kontinuerlig färgramp.
classmap	Klassificerad karta med diskreta färger för klasser.
interval	Intervallbaserad förklaring med diskreta intervall.
none	Ingen legend.

RenderOption

Objekt

Definierar visualiseringsparametrar för återgivning av data på en karta.

Name	Typ	Standardvärde	Description
conditions	RenderOptionCondition[]		En lista över egenskaps-/värdevillkor som måste finnas i den aktiva mosaik-CQL för att det här renderingsalternativet ska aktiveras
description	string		En längre beskrivning av renderingsalternativet som kan användas för att förklara dess innehåll.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Unik identifierare för återgivningsalternativet.
legend	RenderOptionLegend		Förklaringskonfiguration för det här renderingsalternativet.
minZoom	integer (int32) maximum: 24	12	Minsta zoomnivå som det här lagret ska visas på.
name	string maxLength: 40		Kort beskrivande namn för renderingsalternativet.
options	string		En URL-frågesträngskodad sträng med TiTiler-återgivningsalternativ. Gäller endast för `raster-tile` typer. Se Frågeparametrar.
type	RenderOptionType	raster-tile	Den typ av återgivning som ska användas (raster eller vektor).
vectorOptions	RenderOptionVectorOptions		Alternativ för återgivning av vektorpaneler. Gäller endast för `vt-polygon` och `vt-line` typer.

RenderOptionCondition

Objekt

Definierar ett villkor för att aktivera ett återgivningsalternativ.

Name	Typ	Description
property	string	Egenskapsnamn för att kontrollera det aktiva CQL-filtret.
value	string	Värde som egenskapen måste vara lika med.

RenderOptionLegend

Objekt

Konfiguration för att generera en dataförklaring.

Name	Typ	Description
labels	string[]	Textetiketter som ska visas i förklaringen.
scaleFactor	number (float)	En faktor för att multiplicera etiketter för intervallförklaring med. Användbart för skalade raster vars färgmappningsdefinitioner mappas till oskalade värden, vilket effektivt visar förklaringsetiketter som skalade värden.
trimEnd	integer (int32)	Antal objekt som ska trimmas från slutet av förklaringen.
trimStart	integer (int32)	Antalet objekt som ska trimmas från början av förklaringsdefinitionen. Används om det finns värden som är viktiga för återgivning (t.ex. nodata) som inte är önskvärda i förklaringen.
type	LegendConfigType	Förklaringstyp som ska göras, en av: `continuous`, `classmap`, `interval` eller `none` (observera `none` att det är en strängliteral).

RenderOptionType

Uppräkning

Anger typerna av återgivningsalternativ för kartvisualisering.

Värde	Description
raster-tile	Återgivningstyp för rasterruta.
vt-polygon	Återgivningstyp för vektorpanelpolygon.
vt-line	Återgivningstyp för vektorpanellinje.

RenderOptionVectorOptions

Objekt

Definierar parametrar för återgivning av vektorpaneler.

Name	Typ	Description
fillColor	string	Fyllningsfärg för polygonfunktioner.
filter	string[]	MapBox GL filtrera uttryck för att filtrera funktioner.
sourceLayer	string	Namnet på källskiktet i vektorpanelerna.
strokeColor	string	Linjefärg för linjefunktioner.
strokeWidth	integer (int32)	Bredden på linjelinjer i pixlar.
tilejsonKey	string	Tillgångsnyckel som innehåller TileJSON-URL:en.

StacMosaic

Objekt

Definierar en namngiven mosaik med filtreringskriterier.

Name	Typ	Description
cql	Cql[]	En lista över giltiga CQL2-JSON uttryck som används för att filtrera samlingen till moasic.
description	string	Detaljerad beskrivning av mosaiken.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Unik identifierare för mosaiken.
name	string maxLength: 30	Kort beskrivande namn för mosaiken.

StacMosaicConfiguration

Objekt

Konfiguration för visualisering av datamosaik.

Name	Typ	Description
defaultCustomQuery		En lista över CQL-JSON uttryck som ska användas som standard för den här samlingen.
defaultLocation	DefaultLocation	Standardplats för kartan när den här samlingen visas.
mosaics	StacMosaic[]	Fördefinierade datamosaiker som är tillgängliga för den här samlingen.
renderOptions	RenderOption[]	Tillgängliga renderingsalternativ för att visualisera data.

TileSettings

Objekt

Konfiguration för visualisering av kartrutor.

Name	Typ	Description
defaultLocation	DefaultLocation	Standardplats för kartan när den här samlingen visas.
maxItemsPerTile	integer (int32)	Maximalt antal objekt som ska ingå i en enda panel.
minZoom	integer (int32) maximum: 24	Den lägsta zoomnivå som kan begäras för den här samlingen. Ger en hård gräns för panelservrarna för att säkerställa att de inte får begäranden om låga zoomningsnivåer, vilket skulle göra att många filer hämtas och panelservrarna hänger sig.

UserCollectionSettings

Objekt

Användarspecifika samlingsinställningar för visualisering.

Name	Typ	Description
mosaicInfo	StacMosaicConfiguration	Inställningar för visualisering av datamosaik.
tileSettings	TileSettings	Inställningar för visualisering av kartrutor.