你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Farm Operations - Get Data Ingestion Job Details
获取服务器场操作数据引入作业。
GET {endpoint}/farm-operations/ingest-data/{jobId}?api-version=2023-11-01-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
命名空间的主机名,例如 admaInstanceName.farmbeats.azure.net |
job
|
path | True |
string |
作业的 ID。 |
api-version
|
query | True |
string |
请求的 API 版本 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
Authorization | True |
string |
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
错误 标头 x-ms-error-code: string |
安全性
Authorization
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。
类型:
apiKey
在:
header
示例
FarmOperations_GetDataIngestionJobDetails
示例请求
GET {endpoint}/farm-operations/ingest-data/JOB123?api-version=2023-11-01-preview
示例响应
{
"providerInput": {
"shapeType": "Point",
"shapeResolution": "EachSection"
},
"durationInSeconds": 11.2,
"id": "farm-operations-job",
"status": "Succeeded",
"message": "string",
"createdDateTime": "2021-04-16T08:24:50Z",
"lastActionDateTime": "2021-04-16T08:24:50Z",
"startTime": "2021-04-16T08:24:50Z",
"endTime": "2021-04-16T08:24:50Z",
"name": "Farm operations Job",
"description": "Test job",
"properties": {
"Region": "Asia"
},
"partyId": "PARTY123",
"authProviderId": "JOHNDEERE",
"operations": [
"AllOperations"
],
"startYear": 2012
}
定义
名称 | 说明 |
---|---|
Error |
Azure AgPlatform 服务出错。 |
Error |
来自 Azure AgPlatform 服务的错误响应。 有关 ErrorResponse 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。 |
Farm |
服务器场操作数据引入作业的架构。 |
Farm |
服务器场操作作业的提供程序输入的架构。 |
Inner |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
Shape |
要从 JohnDeere 引入的形状文件的分辨率。 形状文件分辨率的可能值取自 - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile。 |
Shape |
要从 JohnDeere 引入的形状文件的类型。 形状文件类型的可能值取自 - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile。 |
Error
Azure AgPlatform 服务出错。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的错误代码集。 |
details |
Error[] |
有关导致此报告错误的特定错误的详细信息数组。 |
innererror |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
|
message |
string |
错误的用户可读表示形式。 |
target |
string |
错误的目标。 |
ErrorResponse
来自 Azure AgPlatform 服务的错误响应。 有关 ErrorResponse 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
名称 | 类型 | 说明 |
---|---|---|
error |
Azure AgPlatform 服务出错。 |
|
traceId |
string |
唯一跟踪 ID。 |
FarmOperationDataIngestionJob
服务器场操作数据引入作业的架构。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
authProviderId |
string |
身份验证提供程序 ID。 |
|
createdBy |
string |
由用户/租户 ID 创建。 |
|
createdDateTime |
string |
在 dateTime 创建的作业。 示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
|
description |
string |
资源的文本说明。 |
|
durationInSeconds |
number |
作业持续时间(以秒为单位)。 |
|
endTime |
string |
作业结束时间(如果可用)。 示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
|
errorCode |
string |
作业失败时的错误代码。 |
|
id |
string |
唯一的作业 ID。 |
|
isIncremental |
boolean |
False |
使用此方法仅从上次运行中提取增量更改。 |
lastActionDateTime |
string |
上次执行作业的时间是 dateTime。 示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
|
message |
string |
用于捕获更多作业详细信息的状态消息。 |
|
modifiedBy |
string |
由用户/租户 ID 修改。 |
|
name |
string |
用于标识资源的名称。 |
|
operations |
string[] |
需要为其下载数据的操作类型的列表。 可用值:AllOperations、Application、Planting、Harvest、Tillage。 |
|
partyId |
string |
群 ID。 |
|
properties |
属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和日期时间 (yyyy-MM-ddTHH:mm:ssZ) 值。 |
||
providerInput |
服务器场操作作业的提供程序输入的架构。 |
||
startTime |
string |
作业开始时间(如果可用)。 示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
|
startYear |
integer |
Start Year (Minimum = 2000, Maximum = CurrentYear) 。 |
|
status |
string |
作业的状态。 可能的值:“Waiting”、“Running”、“Succeeded”、“Failed”、“Cancelled”。 |
FarmOperationJobProviderInput
服务器场操作作业的提供程序输入的架构。
名称 | 类型 | 说明 |
---|---|---|
shapeResolution |
要从 JohnDeere 引入的形状文件的分辨率。 形状文件分辨率的可能值取自 - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile。 |
|
shapeType |
要从 JohnDeere 引入的形状文件的类型。 形状文件类型的可能值取自 - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile。 |
InnerError
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
包含错误提供的特定错误代码。 |
innererror |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
ShapeResolution
要从 JohnDeere 引入的形状文件的分辨率。 形状文件分辨率的可能值取自 - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile。
名称 | 类型 | 说明 |
---|---|---|
EachSection |
string |
|
EachSensor |
string |
|
None |
string |
|
OneHertz |
string |
ShapeType
要从 JohnDeere 引入的形状文件的类型。 形状文件类型的可能值取自 - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
Point |
string |
|
Polygon |
string |