Stac Collection Config - Get

Služba:: Planetary Computer

Verze rozhraní API:: 2025-04-30-preview

Získat konfiguraci
Získání kompletní konfigurace uživatele pro danou kolekci

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Jedinečný identifikátor pro kolekci STAC.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	UserCollectionSettings	Požadavek byl úspěšný.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

UserCollectionSettings

Požadavek byl úspěšný.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

StacCollectionConfig_Get

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
  }
}

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DefaultLocation	Definuje výchozí geografickou polohu pro vizualizaci mapy.
LegendConfigType	Typ legendy, který se má vytvořit, jeden z: `continuous`, `classmap`, `interval` nebo `none` (poznámka, `none` je řetězcový literál).
RenderOption	Definuje parametry vizualizace pro vykreslování dat na mapě.
RenderOptionCondition	Definuje podmínku pro povolení možnosti vykreslování.
RenderOptionLegend	Konfigurace pro generování legendy dat.
RenderOptionType	Určuje typy voleb vykreslování pro vizualizaci mapy.
RenderOptionVectorOptions	Definuje parametry pro vykreslování vektorových dlaždic.
StacMosaic	Definuje pojmenovanou mozaiku s kritérii filtrování.
StacMosaicConfiguration	Konfigurace pro vizualizaci datové mozaiky.
TileSettings	Konfigurace pro vizualizaci mapových dlaždic.
UserCollectionSettings	Nastavení kolekce specifické pro uživatele pro vizualizaci.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

DefaultLocation

Objekt

Definuje výchozí geografickou polohu pro vizualizaci mapy.

Name	Typ	Description
coordinates	number[] (float)	Výchozí středové souřadnice [zeměpisná šířka, délka] pro mapu.
zoom	integer (int32)	Výchozí úroveň přiblížení mapy.

LegendConfigType

Výčet

Typ legendy, který se má vytvořit, jeden z: continuous, classmap, interval nebo none (poznámka, none je řetězcový literál).

Hodnota	Description
continuous	Souvislá legenda barevné rampy.
classmap	Klasifikovaná mapa s diskrétními barvami pro třídy.
interval	Intervalová legenda s diskrétními rozsahy.
none	Žádná legenda.

RenderOption

Objekt

Definuje parametry vizualizace pro vykreslování dat na mapě.

Name	Typ	Default value	Description
conditions	RenderOptionCondition[]		Seznam podmínek vlastnosti/hodnoty, které musí být v aktivním mozaikovém CQL, aby byla tato možnost vykreslování povolena
description	string		Delší popis možnosti vykreslování, který lze použít k vysvětlení jejího obsahu.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Jedinečný identifikátor pro možnost vykreslování.
legend	RenderOptionLegend		Konfigurace legendy pro tuto možnost vykreslování.
minZoom	integer (int32) maximum: 24	12	Minimální úroveň zvětšení, při které se má tato vrstva zobrazit.
name	string maxLength: 40		Krátký popisný název pro možnost vykreslování.
options	string		Řetězec zakódovaný v řetězci dotazu URL s možnostmi vykreslování TiTiler. Platí pouze pro `raster-tile` typy. Viz parametry dotazu.
type	RenderOptionType	raster-tile	Typ vykreslování, který se má použít (rastrové nebo vektorové).
vectorOptions	RenderOptionVectorOptions		Možnosti pro vykreslování vektorových dlaždic. Platí pouze pro `vt-polygon` a `vt-line` typy.

RenderOptionCondition

Objekt

Definuje podmínku pro povolení možnosti vykreslování.

Name	Typ	Description
property	string	Název vlastnosti, který chcete zkontrolovat v aktivním filtru CQL.
value	string	Hodnota, které se vlastnost musí rovnat.

RenderOptionLegend

Objekt

Konfigurace pro generování legendy dat.

Name	Typ	Description
labels	string[]	Textové popisky se zobrazí v legendě.
scaleFactor	number (float)	Faktor, kterým se mají vynásobit popisky legendy intervalu. To je užitečné pro rastry se změněným měřítkem, jejichž definice mapy barev se mapují na hodnoty bez měřítka, takže popisky legendy se efektivně zobrazují jako hodnoty se změněným měřítkem.
trimEnd	integer (int32)	Počet položek, které mají být oříznuty od konce legendy.
trimStart	integer (int32)	Počet položek, které mají být oříznuty od začátku definice legendy. Používá se, pokud existují hodnoty důležité pro vykreslování (např. nodata), které nejsou v legendě žádoucí.
type	LegendConfigType	Typ legendy, který se má vytvořit, jeden z: `continuous`, `classmap`, `interval` nebo `none` (poznámka, `none` je řetězcový literál).

RenderOptionType

Výčet

Určuje typy voleb vykreslování pro vizualizaci mapy.

Hodnota	Description
raster-tile	Typ vykreslování rastrových dlaždic.
vt-polygon	Typ vykreslování vektorových dlaždic polygonu.
vt-line	Typ vykreslování vektorových dlaždic.

RenderOptionVectorOptions

Objekt

Definuje parametry pro vykreslování vektorových dlaždic.

Name	Typ	Description
fillColor	string	Barva výplně pro polygonální prvky.
filter	string[]	MapBox GL filtruje výraz pro filtrování vlastností.
sourceLayer	string	Název zdrojové vrstvy ve vektorových dlaždicích.
strokeColor	string	Barva tahu pro prvky čáry.
strokeWidth	integer (int32)	Šířka tahů čar v pixelech.
tilejsonKey	string	Klíč datového zdroje obsahující adresu URL TileJSON.

StacMosaic

Objekt

Definuje pojmenovanou mozaiku s kritérii filtrování.

Name	Typ	Description
cql	Cql[]	Seznam platných CQL2-JSON výrazů použitých k filtrování kolekce na moasic.
description	string	Podrobný popis mozaiky.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Jedinečný identifikátor mozaiky.
name	string maxLength: 30	Krátký popisný název mozaiky.

StacMosaicConfiguration

Objekt

Konfigurace pro vizualizaci datové mozaiky.

Name	Typ	Description
defaultCustomQuery		Seznam CQL-JSON výrazů, které se mají použít jako výchozí pro tuto kolekci.
defaultLocation	DefaultLocation	Výchozí umístění mapy při zobrazení této kolekce.
mosaics	StacMosaic[]	Pro tuto kolekci jsou k dispozici předdefinované datové mozaiky.
renderOptions	RenderOption[]	Dostupné možnosti vykreslování pro vizualizaci dat.

TileSettings

Objekt

Konfigurace pro vizualizaci mapových dlaždic.

Name	Typ	Description
defaultLocation	DefaultLocation	Výchozí umístění mapy při zobrazení této kolekce.
maxItemsPerTile	integer (int32)	Maximální počet položek, které mají být zahrnuty do jedné dlaždice.
minZoom	integer (int32) maximum: 24	Minimální úroveň přiblížení, kterou lze pro tuto kolekci požadovat. Poskytuje pevný limit pro dlaždicové servery, aby se zajistilo, že neobdrží požadavky na nízké úrovně přiblížení, které by způsobily načtení mnoha souborů a zablokování dlaždicových serverů.

UserCollectionSettings

Objekt

Nastavení kolekce specifické pro uživatele pro vizualizaci.

Name	Typ	Description
mosaicInfo	StacMosaicConfiguration	Nastavení pro vizualizaci datové mozaiky.
tileSettings	TileSettings	Nastavení pro vizualizaci mapových dlaždic.

Sdílet prostřednictvím

Stac Collection Config - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

OAuth2Auth

Rozsahy

Příklady

StacCollectionConfig_Get

Ukázkový požadavek

Ukázková odpověď

Definice

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

DefaultLocation

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions

StacMosaic

StacMosaicConfiguration

TileSettings

UserCollectionSettings