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

Weather - Create Data Ingestion Job

创建天气数据引入作业。

PUT /weather/ingest-data/{jobId}?api-version=2023-06-01-preview

URI 参数

名称 必需 类型 说明
jobId
path True

string

用户提供的作业 ID。

api-version
query True

string

请求的 API 版本

请求头

名称 必需 类型 说明
Authorization True

string

请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。

请求正文

名称 必需 类型 说明
boundaryId True

string

要为其提取天气数据的边界对象的 ID。

extensionApiInput True

扩展 api 输入字典,用于馈送请求查询/正文/参数信息。

extensionApiName True

string

要向其发出请求的扩展 API 名称。

extensionId True

string

要用于 providerInput 的扩展的 ID。 例如 DTN。ClearAg。

partyId True

string

要为其提取天气数据的群的 ID。

description

string

资源的文本说明。

extensionDataProviderApiKey

string

天气数据提供程序的 API 密钥。

extensionDataProviderAppId

string

天气数据提供程序的应用 ID。

name

string

用于标识资源的名称。

properties

属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和 datetime (yyyy-MM-ddTHH:mm:ssZ) 值。

响应

名称 类型 说明
202 Accepted

WeatherDataIngestionJob

已接受

Other Status Codes

ErrorResponse

错误

标头

x-ms-error-code: string

安全性

Authorization

请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。

类型: apiKey
在: header

示例

Weather_CreateDataIngestionJob

示例请求

PUT /weather/ingest-data/JOB123?api-version=2023-06-01-preview

{
  "partyId": "test_party",
  "boundaryId": "test_boundary",
  "extensionId": "dtn.clearAg",
  "extensionApiName": "dailyforecast",
  "extensionApiInput": {
    "start": 0,
    "end": 5
  },
  "name": "TestWeatherJob",
  "description": "Daily Forecast data for 5 days",
  "properties": {
    "region": "Asia"
  }
}

示例响应

{
  "durationInSeconds": 12.4,
  "id": "weather-job",
  "status": "Waiting",
  "message": "Created job to fetch weather data for job name 'TestWeatherJob', party id 'test_party' and field id 'test_field'.",
  "createdDateTime": "2021-04-16T11:33:45Z",
  "lastActionDateTime": "2021-04-16T11:33:45Z",
  "startTime": "2021-04-16T11:33:45Z",
  "endTime": "2021-04-16T11:33:45Z",
  "partyId": "test_party",
  "boundaryId": "test_boundary",
  "extensionId": "dtn.clearAg",
  "extensionApiName": "dailyforecast",
  "extensionApiInput": {
    "start": 0,
    "end": 5
  },
  "name": "TestWeatherJob",
  "description": "Daily Forecast data for 5 days",
  "properties": {
    "region": "Asia"
  }
}

定义

名称 说明
Error

Azure AgPlatform 服务出错。

ErrorResponse

来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。

InnerError

包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object

WeatherDataIngestionJob

天气引入作业的架构。

Error

Azure AgPlatform 服务出错。

名称 类型 说明
code

string

服务器定义的错误代码集。

details

Error[]

有关导致此报告错误的特定错误的详细信息数组。

innererror

InnerError

包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object

message

string

错误的用户可读表示形式。

target

string

错误的目标。

ErrorResponse

来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。

名称 类型 说明
error

Error

Azure AgPlatform 服务出错。

traceId

string

唯一跟踪 ID。

InnerError

包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object

名称 类型 说明
code

string

包含的错误提供的特定错误代码。

innererror

InnerError

包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object

WeatherDataIngestionJob

天气引入作业的架构。

名称 类型 说明
boundaryId

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

作业失败时的错误代码。

extensionApiInput

扩展 api 输入字典,用于馈送请求查询/正文/参数信息。

extensionApiName

string

要向其发出请求的扩展 API 名称。

extensionDataProviderApiKey

string

天气数据提供程序的 API 密钥。

extensionDataProviderAppId

string

天气数据提供程序的应用 ID。

extensionId

string

要用于 providerInput 的扩展的 ID。 例如 DTN。ClearAg。

id

string

唯一的作业 ID。

lastActionDateTime

string

上次执行作业的时间是 dateTime。 示例格式:yyyy-MM-ddTHH:mm:ssZ。

message

string

用于捕获更多作业详细信息的状态消息。

modifiedBy

string

由用户/租户 ID 修改。

name

string

用于标识资源的名称。

partyId

string

要为其提取天气数据的群的 ID。

properties

属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和 datetime (yyyy-MM-ddTHH:mm:ssZ) 值。

startTime

string

作业开始时间(如果可用)。 示例格式:yyyy-MM-ddTHH:mm:ssZ。

status

string

作业的状态。 可能的值:“Waiting”、“Running”、“Succeeded”、“Failed”、“Cancelled”。