Ingestion Runs - Get

服务:

Planetary Computer

API 版本:

2025-04-30-preview

运行摄取

GET https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/inma/collections/{collectionId}/ingestions/{ingestionId}/runs/{runId}?api-version=2025-04-30-preview

URI 参数

名称	在	必需	类型	说明
collectionId	path	True	string maxLength: 500 pattern: .*	目录集合 ID
ingestionId	path	True	string maxLength: 500 pattern: ^[a-zA-Za0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$	摄取 ID
runId	path	True	string (uuid)	运行 ID
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	Ingestions.IngestionRuns.IngestionRun	请求已成功。
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

示例

IngestionRuns_Get

示例请求

HTTP

GET https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/inma/collections/weather-sample/ingestions/94659cc0-538e-4688-9d01-8c7f464b885b/runs/23e710f1-d004-4dbc-84b0-259398ef7bab?api-version=2025-04-30-preview

示例响应

状态代码:

200

{
  "id": "23e710f1-d004-4dbc-84b0-259398ef7bab",
  "creationTime": "2024-10-09T08:43:36.585622Z",
  "sourceCatalogUrl": "https://sample.blob.core.windows.net/observatory/purple-tiger_predict_clean_10.json",
  "skipExistingItems": false,
  "keepOriginalAssets": false,
  "operation": {
    "id": "5623987f-8ccd-457e-81d1-41b430510b8a",
    "status": "Success",
    "statusHistory": [
      {
        "status": "Pending",
        "timestamp": "2024-10-09T08:43:36.585622Z"
      },
      {
        "status": "Running",
        "timestamp": "2024-10-09T08:43:53.223514Z"
      },
      {
        "status": "Success",
        "timestamp": "2024-10-09T08:44:08.433909Z"
      }
    ],
    "creationTime": "2024-10-09T08:43:36.585622Z",
    "startTime": "2024-10-09T08:43:36.585622Z",
    "finishTime": "2024-10-09T08:44:08.433909Z",
    "totalItems": 10,
    "totalPendingItems": 0,
    "totalSuccessfulItems": 10,
    "totalFailedItems": 0
  }
}

定义

名称	说明
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。
Ingestions.IngestionRuns.IngestionRun	空间地理目录摄取运行
Ingestions.IngestionRuns.IngestionRunOperation	空间地理目录摄取运行作
OperationStatus	操作状态
OperationStatusHistoryItem	作状态历史记录项

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	内部错误。

Ingestions.IngestionRuns.IngestionRun

Object

空间地理目录摄取运行

名称	类型	说明
creationTime	string (date-time)	创建时间
id	string (uuid)	运行 ID
keepOriginalAssets	boolean	保留原始源资产
operation	Ingestions.IngestionRuns.IngestionRunOperation	操作
parentRunId	string (uuid)	此运行关联的运行 ID becase 已重试或重新运行
skipExistingItems	boolean	跳过 GeoCatalog 中已存在的任何项目
sourceCatalogUrl	string (uri)	源目录的 URL

Ingestions.IngestionRuns.IngestionRunOperation

Object

空间地理目录摄取运行作

名称	类型	说明
creationTime	string (date-time)	创建作的 UTC 时间
finishTime	string (date-time)	作完成执行的 UTC 时间
id	string (uuid)	操作 ID
startTime	string (date-time)	启动作的 UTC 时间
status	OperationStatus	操作状态
statusHistory	OperationStatusHistoryItem[]	作状态的历史记录（以时间表示）
totalFailedItems	integer (int32)	处理失败的项目数
totalItems	integer (int32)	要处理的总项目数
totalPendingItems	integer (int32)	待处理的项目数
totalSuccessfulItems	integer (int32)	成功处理的项目数

OperationStatus

枚举

操作状态

值	说明
Canceled	用户取消了作
Canceling	正在取消作
Failed	作失败
Pending	作已接受并准备运行
Running	作正在运行
Succeeded	作已完成执行

OperationStatusHistoryItem

Object

作状态历史记录项

名称	类型	说明
errorCode	string	如果状态为 failed，则会显示错误代码
errorMessage	string	如果状态为 failed，则会显示错误消息
status	OperationStatus	作的状态
timestamp	string (date-time)	设置状态的 UTC 时间