Stac Collection Config - Get

Serviço:: Planetary Computer

Versão da API:: 2025-04-30-preview

Obter configuração
Obter a configuração completa do usuário para uma determinada coleção

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Identificador exclusivo para a coleção STAC.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	UserCollectionSettings	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

UserCollectionSettings

A solicitação foi bem-sucedida.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

Exemplos

StacCollectionConfig_Get

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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
  }
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DefaultLocation	Define uma localização geográfica padrão para visualização de mapa.
LegendConfigType	Tipo de legenda a ser feito, um dos seguintes: `continuous`, `classmap`, `interval` ou `none` (nota, `none` é um literal de cadeia de caracteres).
RenderOption	Define parâmetros de visualização para renderizar dados em um mapa.
RenderOptionCondition	Define uma condição para habilitar uma opção de renderização.
RenderOptionLegend	Configuração para gerar uma legenda de dados.
RenderOptionType	Especifica os tipos de opções de renderização para visualização de mapa.
RenderOptionVectorOptions	Define parâmetros para renderização de blocos vetoriais.
StacMosaic	Define um mosaico nomeado com critérios de filtragem.
StacMosaicConfiguration	Configuração para visualização do mosaico de dados.
TileSettings	Configuração para visualização de bloco de mapa.
UserCollectionSettings	Configurações de coleção específicas do usuário para visualização.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação do erro em formato legível por humanos.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

DefaultLocation

Objeto

Define uma localização geográfica padrão para visualização de mapa.

Nome	Tipo	Description
coordinates	number[] (float)	Coordenadas centrais padrão [latitude, longitude] para o mapa.
zoom	integer (int32)	Nível de zoom padrão para o mapa.

LegendConfigType

Enumeração

Tipo de legenda a ser feito, um dos seguintes: continuous, classmap, interval ou none (nota, none é um literal de cadeia de caracteres).

Valor	Description
continuous	Legenda de rampa de cores contínua.
classmap	Mapa classificado com cores discretas para as classes.
interval	Legenda baseada em intervalo com intervalos discretos.
none	Sem lenda.

RenderOption

Objeto

Define parâmetros de visualização para renderizar dados em um mapa.

Nome	Tipo	Valor padrão	Description
conditions	RenderOptionCondition[]		Uma lista de condições de propriedade/valor que devem estar no CQL do mosaico ativo para que essa opção de renderização seja habilitada
description	string		Uma descrição mais longa da opção de renderização que pode ser usada para explicar seu conteúdo.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Identificador exclusivo para a opção de renderização.
legend	RenderOptionLegend		Configuração de legenda para esta opção de renderização.
minZoom	integer (int32) maximum: 24	12	Nível mínimo de zoom no qual exibir esta camada.
name	string maxLength: 40		Nome descritivo curto para a opção de renderização.
options	string		Uma string codificada de string de consulta de URL de opções de renderização do TiTiler. Válido apenas para `raster-tile` tipos. Veja parâmetros de consulta.
type	RenderOptionType	raster-tile	O tipo de renderização a ser aplicada (raster ou vetor).
vectorOptions	RenderOptionVectorOptions		Opções para renderizar blocos vetoriais. Válido apenas para `vt-polygon` e `vt-line` tipos.

RenderOptionCondition

Objeto

Define uma condição para habilitar uma opção de renderização.

Nome	Tipo	Description
property	string	Nome da propriedade para fazer check-in do filtro CQL ativo.
value	string	Valor que a propriedade deve igualar.

RenderOptionLegend

Objeto

Configuração para gerar uma legenda de dados.

Nome	Tipo	Description
labels	string[]	Rótulos de texto a serem exibidos na legenda.
scaleFactor	number (float)	Um fator pelo qual multiplicar rótulos de legenda de intervalo. Útil para rasters dimensionados cujas definições de mapa de cores são mapeadas para valores não dimensionados, mostrando efetivamente rótulos de legenda como valores dimensionados.
trimEnd	integer (int32)	Número de itens a serem cortados do final da legenda.
trimStart	integer (int32)	O número de itens a serem cortados desde o início da definição da legenda. Usado se houver valores importantes para renderização (por exemplo, nodata) que não são desejáveis na legenda.
type	LegendConfigType	Tipo de legenda a ser feito, um dos seguintes: `continuous`, `classmap`, `interval` ou `none` (nota, `none` é um literal de cadeia de caracteres).

RenderOptionType

Enumeração

Especifica os tipos de opções de renderização para visualização de mapa.

Valor	Description
raster-tile	Tipo de renderização de bloco raster.
vt-polygon	Tipo de renderização de polígono de bloco vetorial.
vt-line	Tipo de renderização de linha de bloco vetorial.

RenderOptionVectorOptions

Objeto

Define parâmetros para renderização de blocos vetoriais.

Nome	Tipo	Description
fillColor	string	Cor de preenchimento para feições de polígono.
filter	string[]	Expressão de filtro GL do MapBox para filtrar recursos.
sourceLayer	string	Nome da camada de origem nos blocos de vetor.
strokeColor	string	Cor do traçado para feições de linha.
strokeWidth	integer (int32)	Largura dos traços de linha em pixels.
tilejsonKey	string	Chave de ativo que contém a URL TileJSON.

StacMosaic

Objeto

Define um mosaico nomeado com critérios de filtragem.

Nome	Tipo	Description
cql	Cql[]	Uma lista de expressões CQL2-JSON válidas usadas para filtrar a coleção para moasic.
description	string	Descrição detalhada do mosaico.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Identificador exclusivo para o mosaico.
name	string maxLength: 30	Nome descritivo curto para o mosaico.

StacMosaicConfiguration

Objeto

Configuração para visualização do mosaico de dados.

Nome	Tipo	Description
defaultCustomQuery		Uma lista de CQL-JSON expressões a serem usadas como padrão para esta coleção.
defaultLocation	DefaultLocation	Localização padrão do mapa ao exibir esta coleção.
mosaics	StacMosaic[]	Mosaicos de dados predefinidos disponíveis para esta coleção.
renderOptions	RenderOption[]	Opções de renderização disponíveis para visualizar os dados.

TileSettings

Objeto

Configuração para visualização de bloco de mapa.

Nome	Tipo	Description
defaultLocation	DefaultLocation	Localização padrão do mapa ao exibir esta coleção.
maxItemsPerTile	integer (int32)	Número máximo de itens a serem incluídos em um único bloco.
minZoom	integer (int32) maximum: 24	O nível mínimo de zoom que pode ser solicitado para esta coleção. Fornece um limite rígido para os servidores de bloco para garantir que eles não recebam solicitações de níveis de zoom baixos, o que faria com que muitos arquivos fossem buscados e os servidores de bloco travassem.

UserCollectionSettings

Objeto

Configurações de coleção específicas do usuário para visualização.

Nome	Tipo	Description
mosaicInfo	StacMosaicConfiguration	Configurações para visualização de mosaico de dados.
tileSettings	TileSettings	Configurações para visualização de bloco de mapa.

Compartilhar via

Stac Collection Config - Get

Parâmetros de URI

Respostas

Segurança

OAuth2Auth

Escopos

Exemplos

StacCollectionConfig_Get

Solicitação de exemplo

Resposta de exemplo

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

DefaultLocation

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions

StacMosaic

StacMosaicConfiguration

TileSettings

UserCollectionSettings