Stac Collection Config - Get

Service:: Planetary Computer

Version d'API:: 2026-04-15

Obtenir la configuration
Obtenez la configuration utilisateur complète pour une collection donnée

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Identificateur unique de la collection STAC.
endpoint	path	True	string (uri)	Terminaison GeoCatalog, par exemple `https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com`
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	UserCollectionSettings	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

UserCollectionSettings

La demande a réussi.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

StacCollectionConfig_Get

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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
  }
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DefaultLocation	Définit un emplacement géographique par défaut pour la visualisation de la carte.
LegendConfigType	Type de légende à former, l’un des suivants : `continuous`, `classmap`, `interval` ou `none` (note, `none` est un littéral de la corde).
RenderOption	Définit des paramètres de visualisation pour le rendu des données sur une carte.
RenderOptionCondition	Définit une condition pour activer une option de rendu.
RenderOptionLegend	Configuration pour générer une légende de données.
RenderOptionType	Spécifie les types d’options de rendu pour la visualisation de cartes.
RenderOptionVectorOptions	Définit des paramètres pour le rendu de tuiles vectorielles.
StacMosaic	Définit une mosaïque nommée avec des critères de filtrage.
StacMosaicConfiguration	Configuration pour la visualisation de la mosaïque de données.
TileSettings	Configuration pour la visualisation des tuiles de carte.
UserCollectionSettings	Paramètres de collection spécifiques à l’utilisateur pour la visualisation.

Azure.Core.Foundations.Error

Objet

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Objet

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

DefaultLocation

Objet

Définit un emplacement géographique par défaut pour la visualisation de la carte.

Nom	Type	Description
coordinates	number[] (float)	Coordonnées centrales par défaut [latitude, longitude] de la carte.
zoom	integer (int32)	Niveau de zoom par défaut pour la carte.

LegendConfigType

Énumération

Type de légende à former, l’un des suivants : continuous, classmap, interval ou none (note, none est un littéral de la corde).

Valeur	Description
continuous	Inscription en rampe colorée continue.
classmap	Carte classifiée avec des couleurs discrètes pour les classes.
interval	Légende basée sur les intervalles avec des plages discrètes.
none	Aucune légende.

RenderOption

Objet

Définit des paramètres de visualisation pour le rendu des données sur une carte.

Nom	Type	Valeur par défaut	Description
conditions	RenderOptionCondition[]		Une liste des conditions de propriété/valeur qui doivent être dans le CQL de la mosaïque active pour que cette option de rendu soit activée
description	string		Une description plus longue de l’option de rendu qui peut être utilisée pour expliquer son contenu.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Identifiant unique pour l’option de rendu.
legend	RenderOptionLegend		Configuration de légende pour cette option de rendu.
minZoom	integer (int32) maximum: 24	12	Niveau de zoom minimal pour afficher ce calque.
name	string maxLength: 40		Nom descriptif court pour l’option de rendu.
options	string		Une chaîne d’options de rendu TiTiler encodée par une chaîne de requête. Valable uniquement pour `raster-tile` les types. Voir paramètres de requête.
type	RenderOptionType	raster-tile	Le type de rendu à appliquer (raster ou vectoriel).
vectorOptions	RenderOptionVectorOptions		Options pour le rendu des tuiles vectorielles. Valable uniquement pour `vt-polygon` et `vt-line` types.

RenderOptionCondition

Objet

Définit une condition pour activer une option de rendu.

Nom	Type	Description
property	string	Nom de propriété à vérifier dans le filtre CQL actif.
value	string	Valeur que la propriété doit égaler.

RenderOptionLegend

Objet

Configuration pour générer une légende de données.

Nom	Type	Description
labels	string[]	Des étiquettes textuelles à afficher sur la légende.
scaleFactor	number (float)	Un facteur pour multiplier les labels de légendes d’intervalle par. Utile pour les rasters à échelle dont les définitions de colormap correspondent à des valeurs non mises à l’échelle, affichant effectivement les étiquettes de légende comme des valeurs mises à l’échelle.
trimEnd	integer (int32)	Nombre d’éléments à couper à partir de la fin de la légende.
trimStart	integer (int32)	Le nombre d’éléments à tailler depuis le début de la définition de la légende. Utilisé s’il y a des valeurs importantes pour le rendu (par exemple nodata) qui ne sont pas souhaitables dans la légende.
type	LegendConfigType	Type de légende à former, l’un des suivants : `continuous`, `classmap`, `interval` ou `none` (note, `none` est un littéral de la corde).

RenderOptionType

Énumération

Spécifie les types d’options de rendu pour la visualisation de cartes.

Valeur	Description
raster-tile	Type de rendu de tuiles raster.
vt-polygon	Type de rendu polygonal en tuiles vectorielles.
vt-line	Type de rendu de lignes en tuiles vectorielles.

RenderOptionVectorOptions

Objet

Définit des paramètres pour le rendu de tuiles vectorielles.

Nom	Type	Description
fillColor	string	Couleur de remplissage pour les caractéristiques polygonales.
filter	string[]	Expression du filtre MapBox GL vers les caractéristiques du filtre.
sourceLayer	string	Nom de la couche source dans les tuiles vectorielles.
strokeColor	string	Couleur de trait pour les traits de ligne.
strokeWidth	integer (int32)	Largeur des traits de ligne en pixels.
tilejsonKey	string	Clé d’atout contenant l’URL TileJSON.

StacMosaic

Objet

Définit une mosaïque nommée avec des critères de filtrage.

Nom	Type	Description
cql	Cql[]	Liste des expressions CQL2-JSON valides utilisées pour filtrer la collection sur moasique.
description	string	Description détaillée de la mosaïque.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Identifiant unique de la mosaïque.
name	string maxLength: 30	Nom descriptif abrégé de la mosaïque.

StacMosaicConfiguration

Objet

Configuration pour la visualisation de la mosaïque de données.

Nom	Type	Description
defaultCustomQuery		Liste des expressions CQL-JSON à utiliser par défaut pour cette collection.
defaultLocation	DefaultLocation	Emplacement par défaut de la carte lors de l’affichage de cette collection.
mosaics	StacMosaic[]	Mosaïques de données prédéfinies disponibles pour cette collection.
renderOptions	RenderOption[]	Options de rendu disponibles pour visualiser les données.

TileSettings

Objet

Configuration pour la visualisation des tuiles de carte.

Nom	Type	Description
defaultLocation	DefaultLocation	Emplacement par défaut de la carte lors de l’affichage de cette collection.
maxItemsPerTile	integer (int32)	Nombre maximal d’éléments à inclure dans une seule tuile.
minZoom	integer (int32) maximum: 24	Le niveau de zoom minimum qui peut être demandé pour cette collection. Fournit une limite stricte pour les serveurs de tuiles afin de s’assurer qu’ils ne reçoivent pas de demandes pour de faibles niveaux de zoom, ce qui entraînerait l’extraction de nombreux fichiers et le blocage des serveurs de tuiles.

UserCollectionSettings

Objet

Paramètres de collection spécifiques à l’utilisateur pour la visualisation.

Nom	Type	Description
mosaicInfo	StacMosaicConfiguration	Paramètres de visualisation de la mosaïque de données.
tileSettings	TileSettings	Paramètres de visualisation des tuiles de carte.

Partager via

Stac Collection Config - Get

Paramètres URI

Réponses

Sécurité

OAuth2Auth

Étendues

Exemples

StacCollectionConfig_Get

Exemple de requête

Exemple de réponse

Définitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

DefaultLocation

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions

StacMosaic

StacMosaicConfiguration

TileSettings

UserCollectionSettings