你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Mosaics Register Search - Register

参考

服务:: Planetary Computer

API 版本:: 2025-04-30-preview

注册搜索
注册搜索查询

POST https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/data/mosaic/register?api-version=2025-04-30-preview

URI 参数

名称	在	必需	类型	说明
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	类型	说明
bbox	number (double)	用于筛选项目的地理边界框 [west， south， east， north]
collections	string[]	要包含在马赛克中的 STAC 集合 ID 列表
datetime	string	RFC 3339 格式或间隔的临时筛选器
filter	CqlFilter	过滤器
filter-lang	FilterLang	filter 参数中使用的查询语言格式
ids	string[]	要包含在镶嵌中的特定 STAC 项目 ID 的列表
intersects	GeoJson	GeoJSON 几何图形，用于按交集在空间上筛选项目
metadata	Metadata	要与镶嵌关联的其他元数据
query	object	查询
sortby	SortExtension[]	对 mosaic 中的项目进行排序的标准

响应

名称	类型	说明
200 OK	RegisterResponse	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

RegisterResponse

请求已成功。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://geocatalog.spatio.azure.com/.default

示例

MosaicsRegisterSearch_Register

示例请求

HTTP

POST https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/data/mosaic/register?api-version=2025-04-30-preview

{
  "filter-lang": "cql2-json",
  "filter": {
    "op": "and",
    "args": [
      {
        "op": "=",
        "args": [
          {
            "property": "collection"
          },
          "maxar"
        ]
      }
    ]
  },
  "sortby": [
    {
      "field": "datetime",
      "direction": "desc"
    }
  ]
}

示例响应

状态代码:: 200

{
  "searchId": "e32e0b12176246816953d75e3356d613",
  "links": [
    {
      "href": "https://stacforge.axarcnccdbcsduc4.eastus.geocatalog.spatio.azure.com/data/mosaic/e32e0b12176246816953d75e3356d613/info",
      "rel": "metadata",
      "type": "application/json",
      "title": "Mosaic metadata"
    },
    {
      "href": "https://stacforge.axarcnccdbcsduc4.eastus.geocatalog.spatio.azure.com/data/mosaic/e32e0b12176246816953d75e3356d613/tilejson.json",
      "rel": "tilejson",
      "type": "application/json",
      "title": "Link for TileJSON"
    },
    {
      "href": "https://stacforge.axarcnccdbcsduc4.eastus.geocatalog.spatio.azure.com/data/mosaic/e32e0b12176246816953d75e3356d613/WMTSCapabilities.xml",
      "rel": "wmts",
      "type": "application/json",
      "title": "Link for WMTS"
    }
  ]
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。
CqlFilter	CQL Filter 模型
FilterLang	POST 请求中的 filter-lang 值选项。依据 https://github.com/stac-api-extensions/filter#queryables 请注意添加了 cql2-json，它由 pgstac 后端使用，但未包含在上面的规范中。定义 STAC API 查询支持的筛选条件语言。
Link	链接模型。参考：http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml 表示链接。
LinkType	链接的 MIME 类型。
Metadata	镶嵌或搜索结果的元数据信息
MetadataType	系统中元数据资源的类型
RegisterMosaic	用于注册 STAC 项的新马赛克的输入参数
RegisterResponse	来自包含搜索 ID 和相关链接的成功镶嵌配准的响应
SortDirections	定义 STAC API 中查询结果的排序方向。
SortExtension	https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort#sort-api-extension 表示 STAC API 查询的排序规范。

Azure.Core.Foundations.Error

Object

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	有关错误的可读的表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

CqlFilter

Object

CQL Filter 模型

名称	类型	说明
args	CqlArgument[]	逻辑运算符的参数
op	string	逻辑运算符

FilterLang

枚举

POST 请求中的 filter-lang 值选项。

依据 https://github.com/stac-api-extensions/filter#queryables

请注意添加了 cql2-json，它由 pgstac 后端使用，但未包含在上面的规范中。

定义 STAC API 查询支持的筛选条件语言。

值	说明
cql-json	JSON 格式的通用查询语言。
cql2-json	JSON 格式的通用查询语言 2
cql2-text	文本格式的通用查询语言 2。

Link

Object

链接模型。

参考：http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml

表示链接。

名称	类型	默认值	说明
body	object		对于 POST 请求，资源可以将 HTTP 正文指定为 JSON 对象。
headers	object		映射到标头的对象键值对。示例：{ “accept”： “application/json” }。
href	string		链接的 URL。
hreflang	string		链接资源的语言。
length	integer (int32)		链接资源的长度。
merge	boolean	False	指示客户端是否希望在访问链接之前将 body 值合并到当前请求正文中。这仅在服务器响应 POST 请求时有效。默认值：false。
method	enum: GET POST	GET	指定资源所需的 HTTP 方法。默认值：GET。
rel	string		链接的关系类型。
title	string		链接的标题。
type	LinkType	application/json	链接资源的 MIME 类型。

LinkType

枚举

链接的 MIME 类型。

值	说明
application/geo+json	表示 application/geo+json。
application/json	表示 application/json。
application/x-binary	表示 application/x 二进制文件。
application/x-protobuf	表示 application/x-protobuf。
application/xml	表示 application/xml。
image/jp2	表示 image/jp2。
image/jpeg	表示 image/jpeg。
image/jpg	表示 image/jpg。
image/png	表示 image/png。
image/tiff; application=geotiff	表示具有 application=geotiff 的图像/tiff。
image/webp	表示图像/webp。
text/html	表示 text/html。
text/plain	表示 text/plain。

Metadata

Object

镶嵌或搜索结果的元数据信息

名称	类型	默认值	说明
assets	string[]		资源中包含的资产标识符列表
bounds	string		[west， south， east， north] 格式的地理边界框
defaults	object		默认值
maxzoom	integer (int32)		支持的最大缩放级别
minzoom	integer (int32)		支持的最小缩放级别
name	string		资源的可读名称
type	MetadataType	mosaic	元数据资源的类型

MetadataType

枚举

系统中元数据资源的类型

值	说明
mosaic	多个栅格资产的镶嵌元数据
search	搜索查询结果的元数据

RegisterMosaic

Object

用于注册 STAC 项的新马赛克的输入参数

名称	类型	说明
bbox	number (double)	用于筛选项目的地理边界框 [west， south， east， north]
collections	string[]	要包含在马赛克中的 STAC 集合 ID 列表
datetime	string	RFC 3339 格式或间隔的临时筛选器
filter	CqlFilter	过滤器
filter-lang	FilterLang	filter 参数中使用的查询语言格式
ids	string[]	要包含在镶嵌中的特定 STAC 项目 ID 的列表
intersects	GeoJson	GeoJSON 几何图形，用于按交集在空间上筛选项目
metadata	Metadata	要与镶嵌关联的其他元数据
query	object	查询
sortby	SortExtension[]	对 mosaic 中的项目进行排序的标准

RegisterResponse

Object

来自包含搜索 ID 和相关链接的成功镶嵌配准的响应

名称	类型	说明
links	Link[]	已注册马赛克的相关链接
searchId	string	已注册搜索的唯一标识符

SortDirections

枚举

定义 STAC API 中查询结果的排序方向。

值	说明
asc	按升序对结果进行排序。
desc	按降序对结果进行排序。

SortExtension

Object

https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort#sort-api-extension

表示 STAC API 查询的排序规范。

名称	类型	说明
direction	SortDirections	排序方向（升序或降序）。
field	string minLength: 1	要作为排序依据的字段名称。

通过

Mosaics Register Search - Register

URI 参数

请求正文

响应

安全性

OAuth2Auth

作用域

示例

MosaicsRegisterSearch_Register

示例请求

示例响应

定义

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CqlFilter

FilterLang

Link

LinkType

Metadata

MetadataType

RegisterMosaic

RegisterResponse

SortDirections

SortExtension