查询流量计预测。
HTTP 请求
GET https://floodforecasting.googleapis.com/v1/gauges:queryGaugeForecasts
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
gaugeIds[] |
必需。指标 ID 列表。支持的列表大小上限为 500。如果提供的列表包含的元素超过 500 个,则会失败并显示 INVALID_REQUEST 错误。 |
issuedTimeStart |
可选。最早的预报发布时间(采用 ISO 8601 格式),例如“2023-06-17T10:34:00Z”或日期字符串,例如“2023-10-13”。开始时间不能早于“2023-10-01”。默认值为一周前。 |
issuedTimeEnd |
可选。以字符串 (ISO 8601) 格式表示的最新预报发布时间,例如“2023-06-17T10:34:00Z”或日期字符串,例如“2023-10-13”。默认值为“现在”。 |
请求正文
请求正文必须为空。
响应正文
gauges.queryGaugeForecasts 的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"forecasts": {
string: {
object ( |
字段 | |
---|---|
forecasts |
从水位计 ID 到预测集的映射。 包含一系列 |
ForecastSet
一个流量计的一组预测数据。
JSON 表示法 |
---|
{
"forecasts": [
{
object ( |
字段 | |
---|---|
forecasts[] |
天气预报。 |
预测
单个水位站针对多个提前期的预测。例如,预报的发布时间可能是下午 5 点,其中包含下午 6 点、7 点、8 点等的预报。
注意:部分预测范围可能早于发布时间。这种情况可能是由模型输入数据的延迟造成的。在上述示例中,问题时间可能是下午 5 点,而预测范围是下午 4 点、下午 5 点、下午 6 点等。
注意:区间的长度和区间之间的距离各不相同。以下是一些可能的范围示例:
[下午 5 点 - 下午 5 点]、[下午 6 点 - 下午 6 点]、[晚上 7 点 - 晚上 7 点]
[3 月 1 日中午 12 点 - 3 月 2 日中午 12 点]、[3 月 2 日中午 12 点 - 3 月 3 日中午 12 点]、[3 月 3 日中午 12 点 - 3 月 4 日中午 12 点]
JSON 表示法 |
---|
{
"forecastRanges": [
{
object ( |
字段 | |
---|---|
forecastRanges[] |
预测由多个“预测范围”组成,这些范围是与不同时间范围相关的不同预测值。如果范围的开始和结束时间相同,则表示这是一个时间点。 |
gaugeId |
相应预测所针对的水位计的 ID。 |
issuedTime |
预报的发布时间 (ISO 8601),例如“2023-06-17T10:34:00Z”。发布时间是指生成天气预报的时间。 |
ForecastTimedValue
与时间范围相关的预测值。其单位由与之关联的 GaugeModel 定义。如果开始时间和结束时间相同,则表示这是一个时间点。
JSON 表示法 |
---|
{ "value": number, "forecastStartTime": string, "forecastEndTime": string } |
字段 | |
---|---|
value |
预测值。 |
forecastStartTime |
区间的开始时间。 |
forecastEndTime |
区间的结束时间。 |