文档首页/ 路网数字化服务 DRIS/ API参考/ API/ 应用侧API参考/ 数据转发配置管理/ 查询数据转发配置列表
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

查询数据转发配置列表

功能介绍

查询数据转发配置列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/forwarding-configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数说明：项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。

取值范围：仅支持数字，a到f的小写字母组合，长度32。
表2 Query参数

参数

是否必选

参数类型

描述

forwarding_type

是

String

参数说明：转发配置的类型。

取值范围：当前仅支持“kafka，mrskafka”。

offset

否

Integer

参数说明：查询配置列表的偏移量。

limit

否

Integer

参数说明：查询时每页显示的记录数。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

否

String

参数说明：实例ID。DRIS物理实例的唯一标识，获取方法请参见“API参考 > 附录 > 获取Instance-Id”。

取值范围：仅支持数字，小写字母和连接符（-）的组合，长度36。

X-Auth-Token

否

String

参数说明：用户Token，Token认证鉴权时必选。通过调用IAM服务 “获取IAM用户Token”接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见“API参考 > API > 应用侧API参考 > 如何调用API > 认证鉴权 > Token认证”。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数说明：满足查询条件的记录总数。

forwarding_configs

Array of ForwardingConfig objects

参数说明：转发配置的列表。
表5 ForwardingConfig

参数

参数类型

描述

forwarding_type

String

参数说明：转发配置的类型。

取值范围：当前仅支持“kafka、mrskafka”。

kafka_config

KafkaConfigResponseDTO object

参数说明：Kafka配置信息。

mrs_kafka_config

MrsKafkaConfigResponseDTO object

参数说明：mrsKafka配置信息。
表6 KafkaConfigResponseDTO

参数

参数类型

描述

kafka_config_id

String

参数说明：每一套Kafka配置的唯一ID。

取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。

kafka_topics

Array of strings

参数说明：kafka的主题列表。

取值范围：

  • v2x-v1-tracks：edge上报的车辆轨迹数据

  • v2x-v1-bsm：车载T-BOX，RSU上报的BSM消息数据

  • v2x-v1-rsi：RSU，edge上报的RSI消息数据

  • v2x-v1-rsm： RSU，edge上报的RSM消息数据

  • v2x-v1-spat：RSU上报的SPAT消息数据

  • v2x-v1-edge-flow：edge上报的车流量统计信息数据

brokers

Array of strings

参数说明：Kafka broker列表。

username

String

参数说明：kafka用户名。

取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。

topic_prefix

String

参数说明：Topic前缀。

取值范围：长度不超过255，只允许字母、数字、下划线（_）、连接符（-）的组合。

status

String

参数说明：一套kafka的连接状态。

取值范围：

  • OFFLINE：离线

  • ONLINE：在线

cert_info

CertificateInfo object

参数说明：证书信息。

model_ids

Array of strings

参数说明：模型ID列表。 user_topics包含model-data时必选，仅支持非系统、分层为gdm的动态模型。 可通过 GET /{project_id}/models 查询模型列表接口获取。

取值范围：仅支持字母，数字以及中划线（-）的组合，长度为36。

created_time

String

参数说明：创建时间。

格式为yyyy-MM-dd'T'HH:mm:ss'Z'

例如：2015-12-12T12:12:12Z

last_modified_time

String

参数说明：修改时间。

格式为yyyy-MM-dd'T'HH:mm:ss'Z'

例如：2015-12-12T12:12:12Z
表7 CertificateInfo

参数

参数类型

描述

effective_date

String

证书生效日期

expiry_date

String

证书失效日期
表8 MrsKafkaConfigResponseDTO

参数

参数类型

描述

kafka_config_id

String

参数说明：每一套Kafka配置的唯一ID。

取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。

kafka_topics

Array of strings

参数说明：kafka的主题列表。

取值范围：

  • v2x-v1-tracks：edge上报的车辆轨迹数据

  • v2x-v1-bsm：车载T-BOX，RSU上报的BSM消息数据

  • v2x-v1-rsi：RSU，edge上报的RSI消息数据

  • v2x-v1-rsm： RSU，edge上报的RSM消息数据

  • v2x-v1-spat：RSU上报的SPAT消息数据

  • v2x-v1-edge-flow：edge上报的车流量统计信息数据

brokers

Array of strings

参数说明：Kafka broker列表。

username

String

参数说明：mrskafka用户名，若开启安全认证该参数必填。

取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。

status

String

参数说明：一套kafka的连接状态。

取值范围：

  • OFFLINE：离线

  • ONLINE：在线

authentication

Boolean

参数说明：是否开启kerberos安全认证的开关。若开启安全认证则需要先上传kerberos安全认证的凭证。

model_ids

Array of strings

参数说明：模型ID列表。 user_topics包含model-data时必选，仅支持非系统、分层为gdm的动态模型。 可通过 GET /{project_id}/models 查询模型列表接口获取。

取值范围：仅支持字母，数字以及中划线（-）的组合，长度为36。

created_time

String

参数说明：创建时间。

格式为yyyy-MM-dd'T'HH:mm:ss'Z'

例如：2015-12-12T12:12:12Z

last_modified_time

String

参数说明：修改时间。

格式为yyyy-MM-dd'T'HH:mm:ss'Z'

例如：2015-12-12T12:12:12Z

请求示例

GET https://{endpoint}/v1/{project_id}/forwarding-configs?offset={offset}&limit={limit}&forwarding_type={forwarding_type}
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********

响应示例

状态码： 200

OK

{
  "count" : 1,
  "forwarding_configs" : [ {
    "forwarding_type" : "kafka",
    "kafka_config" : {
      "kafka_config_id" : "1234567890",
      "kafka_topics" : [ "v2x-v1-tracks", "v2x-v1-bsm", "v2x-v1-rsi", "v2x-v1-rsm", "v2x-v1-spat", "v2x-v1-edge-flow", "realtime-traffic", "junction-realtime-traffic", "forecast-traffic", "recommended-strategies", "executed-strategies", "strategy-evaluations", "confirmed-event", "traffic-event", "compositive-tracks", "model-data", "request-strategies", "congestion-event", "congestion-prediction-event" ],
      "brokers" : [ "127.0.0.1:10000" ],
      "username" : "1234567890",
      "topic_prefix" : "abc",
      "status" : "ONLINE",
      "model_ids" : [ "40f96952-ea2f-4a10-8a92-e641aa1c6e49" ],
      "created_time" : "2015-12-12T12:12:12Z",
      "last_modified_time" : "2015-12-13T12:12:12Z"
    },
    "mrs_kafka_config" : {
      "kafka_config_id" : null,
      "kafka_topics" : [ "v2x-v1-tracks", "v2x-v1-bsm", "v2x-v1-rsi", "v2x-v1-rsm", "v2x-v1-spat", "v2x-v1-edge-flow", "realtime-traffic", "junction-realtime-traffic", "forecast-traffic", "recommended-strategies", "executed-strategies", "strategy-evaluations", "confirmed-event", "traffic-event", "compositive-tracks", "model-data", "request-strategies", "congestion-event", "congestion-prediction-event" ],
      "brokers" : [ "127.0.0.1:10000" ],
      "username" : null,
      "status" : null,
      "authentication" : false,
      "model_ids" : [ "40f96952-ea2f-4a10-8a92-e641aa1c6e49" ],
      "created_time" : "2015-12-12T12:12:12Z",
      "last_modified_time" : "2015-12-12T12:12:12Z"
    }
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

429

Too Many Requests

500

Internal Server Error

错误码

请参见错误码。

相关文档