Stac Collection Config - Get

Servizio:: Planetary Computer

Versione API:: 2025-04-30-preview

Ottenere la configurazione
Ottenere la configurazione utente completa per una determinata raccolta

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
collectionId	path	True	string maxLength: 500 pattern: .*	Identificatore univoco per la collezione STAC.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	UserCollectionSettings	La richiesta ha avuto esito positivo.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

UserCollectionSettings

La richiesta ha avuto esito positivo.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://geocatalog.spatio.azure.com/.default

Esempio

StacCollectionConfig_Get

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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
  }
}

Definizioni

Nome	Descrizione
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DefaultLocation	Definisce una posizione geografica predefinita per la visualizzazione della mappa.
LegendConfigType	Tipo di legenda da creare, uno tra: `continuous`, `classmap`, `interval` o `none` (nota, `none` è un letterale stringa).
RenderOption	Definisce i parametri di visualizzazione per il rendering dei dati su una mappa.
RenderOptionCondition	Definisce una condizione per l'abilitazione di un'opzione di rendering.
RenderOptionLegend	Configurazione per la generazione di una legenda dei dati.
RenderOptionType	Specifica i tipi di opzioni di rendering per la visualizzazione della mappa.
RenderOptionVectorOptions	Definisce i parametri per il rendering delle tessere vettoriali.
StacMosaic	Definisce un mosaico con nome con criteri di filtraggio.
StacMosaicConfiguration	Configurazione per la visualizzazione del mosaico di dati.
TileSettings	Configurazione per la visualizzazione delle tessere della mappa.
UserCollectionSettings	Impostazioni di raccolta specifiche dell'utente per la visualizzazione.

Azure.Core.Foundations.Error

Oggetto

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Oggetto

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

DefaultLocation

Oggetto

Definisce una posizione geografica predefinita per la visualizzazione della mappa.

Nome	Tipo	Descrizione
coordinates	number[] (float)	Coordinate centrali predefinite [latitudine, longitudine] per la mappa.
zoom	integer (int32)	Livello di zoom predefinito per la mappa.

LegendConfigType

Enumerazione

Tipo di legenda da creare, uno tra: continuous, classmap, interval o none (nota, none è un letterale stringa).

Valore	Descrizione
continuous	Legenda della scala cromatica continua.
classmap	Mappa classificata con colori discreti per le classi.
interval	Legenda basata su intervalli con intervalli discreti.
none	Nessuna leggenda.

RenderOption

Oggetto

Definisce i parametri di visualizzazione per il rendering dei dati su una mappa.

Nome	Tipo	Valore predefinito	Descrizione
conditions	RenderOptionCondition[]		Un elenco di condizioni di proprietà/valore che devono essere presenti nel CQL del mosaico attivo affinché questa opzione di rendering sia abilitata
description	string		Una descrizione più lunga dell'opzione di rendering che può essere utilizzata per spiegarne il contenuto.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Identificatore univoco per l'opzione di rendering.
legend	RenderOptionLegend		Configurazione della legenda per questa opzione di rendering.
minZoom	integer (int32) maximum: 24	12	Livello di zoom minimo al quale visualizzare questo livello.
name	string maxLength: 40		Nome descrittivo breve per l'opzione di rendering.
options	string		Una stringa codificata nella stringa di query URL delle opzioni di rendering di TiTiler. Valido solo per `raster-tile` i tipi. Vedi Parametri di Interrogazione.
type	RenderOptionType	raster-tile	Il tipo di rendering da applicare (raster o vettoriale).
vectorOptions	RenderOptionVectorOptions		Opzioni per il rendering di tessere vettoriali. Valido solo per `vt-polygon` i tipi and `vt-line` .

RenderOptionCondition

Oggetto

Definisce una condizione per l'abilitazione di un'opzione di rendering.

Nome	Tipo	Descrizione
property	string	Nome della proprietà per archiviare il filtro CQL attivo.
value	string	Valore che la proprietà deve essere uguale.

RenderOptionLegend

Oggetto

Configurazione per la generazione di una legenda dei dati.

Nome	Tipo	Descrizione
labels	string[]	Etichette di testo da visualizzare nella legenda.
scaleFactor	number (float)	Fattore per cui moltiplicare le etichette della legenda degli intervalli. Utile per raster in scala le cui definizioni della mappa dei colori vengono mappate su valori non in scala, mostrando in modo efficace le etichette della legenda come valori in scala.
trimEnd	integer (int32)	Numero di elementi da tagliare dalla fine della legenda.
trimStart	integer (int32)	Il numero di elementi da tagliare dall'inizio della definizione della legenda. Utilizzato se sono presenti valori importanti per il rendering (ad esempio nodata) che non sono desiderabili nella legenda.
type	LegendConfigType	Tipo di legenda da creare, uno tra: `continuous`, `classmap`, `interval` o `none` (nota, `none` è un letterale stringa).

RenderOptionType

Enumerazione

Specifica i tipi di opzioni di rendering per la visualizzazione della mappa.

Valore	Descrizione
raster-tile	Tipo di rendering delle tessere raster.
vt-polygon	Tipo di rendering del poligono della piastrella vettoriale.
vt-line	Tipo di rendering della linea di tessere vettoriali.

RenderOptionVectorOptions

Oggetto

Definisce i parametri per il rendering delle tessere vettoriali.

Nome	Tipo	Descrizione
fillColor	string	Colore di riempimento per le feature poligonali.
filter	string[]	Espressione di filtro MapBox GL per filtrare le funzionalità.
sourceLayer	string	Nome del layer di origine nelle tessere vettoriali.
strokeColor	string	Colore del tratto per le entità geografiche lineari.
strokeWidth	integer (int32)	Larghezza dei tratti di linea in pixel.
tilejsonKey	string	Chiave dell'asset contenente l'URL TileJSON.

StacMosaic

Oggetto

Definisce un mosaico con nome con criteri di filtraggio.

Nome	Tipo	Descrizione
cql	Cql[]	Elenco di espressioni CQL2-JSON valide utilizzate per filtrare la raccolta in moasic.
description	string	Descrizione dettagliata del mosaico.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Identificatore univoco per il mosaico.
name	string maxLength: 30	Breve nome descrittivo del mosaico.

StacMosaicConfiguration

Oggetto

Configurazione per la visualizzazione del mosaico di dati.

Nome	Tipo	Descrizione
defaultCustomQuery		Elenco di espressioni CQL-JSON da utilizzare come impostazione predefinita per l'insieme.
defaultLocation	DefaultLocation	Posizione predefinita sulla mappa durante la visualizzazione di questa raccolta.
mosaics	StacMosaic[]	Mosaici di dati predefiniti disponibili per questa raccolta.
renderOptions	RenderOption[]	Opzioni di rendering disponibili per la visualizzazione dei dati.

TileSettings

Oggetto

Configurazione per la visualizzazione delle tessere della mappa.

Nome	Tipo	Descrizione
defaultLocation	DefaultLocation	Posizione predefinita sulla mappa durante la visualizzazione di questa raccolta.
maxItemsPerTile	integer (int32)	Numero massimo di elementi da includere in un singolo riquadro.
minZoom	integer (int32) maximum: 24	Il livello di zoom minimo che può essere richiesto per questa raccolta. Fornisce un limite rigido per i server di riquadri per garantire che non ricevano richieste di livelli di zoom bassi, che causerebbero il recupero di molti file e il blocco dei server di riquadri.

UserCollectionSettings

Oggetto

Impostazioni di raccolta specifiche dell'utente per la visualizzazione.

Nome	Tipo	Descrizione
mosaicInfo	StacMosaicConfiguration	Impostazioni per la visualizzazione del mosaico di dati.
tileSettings	TileSettings	Impostazioni per la visualizzazione delle tessere della mappa.

Condividi tramite

Stac Collection Config - Get

Parametri dell'URI

Risposte

Sicurezza

OAuth2Auth

Ambiti

Esempio

StacCollectionConfig_Get

Esempio di richiesta

Risposta di esempio

Definizioni

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

DefaultLocation

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions

StacMosaic

StacMosaicConfiguration

TileSettings

UserCollectionSettings