文档首页/ 路网数字化服务 DRIS/ API参考/ API/ 应用侧API参考/ 数据转发配置管理/ 创建数据转发配置

更新时间：2024-10-24 GMT+08:00

查看PDF

创建数据转发配置

功能介绍

创建数据转发配置。当前仅支持数据转发至kafka，数据转发配置成功添加后配置中的Topic消息将会转发至指定的brokers。

调试

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

URI

POST /v1/{project_id}/forwarding-configs

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数说明：项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。取值范围：仅支持数字，a到f的小写字母组合，长度32。

请求参数

表2 请求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认证”。

表3 请求Body参数
参数	是否必选	参数类型	描述
forwarding_type	是	String	参数说明：转发配置的类型。取值范围：当前仅支持“kafka，mrskafka”。
forwarding_config	是	ForwardingConfigRequestDTO object	参数说明：转发配置信息。

表4 ForwardingConfigRequestDTO
参数	是否必选	参数类型	描述
kafka_config	否	KafkaConfigRequestDTO object	参数说明：Kafka配置。
mrs_kafka_config	否	MrsKafkaConfigRequestDTO object	参数说明：mrsKafka配置。

表5 KafkaConfigRequestDTO
参数	是否必选	参数类型	描述
topic_prefix	否	String	参数说明：Topic前缀，不携带时以user_topics中具体Topic为准，携带时前缀将拼接在user_topics中的topic前方，例如：topic_prefixv2x-v1-tracks，topic_prefixv2x-v1-bsm。取值范围：长度不超过255，只允许字母、数字、连接符（-）、下划线（_）的组合。
user_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上报的车流量统计信息数据 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	是	Array of strings	参数说明：Kafka broker列表。
username	否	String	参数说明：kafka用户名。取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。
password	否	String	参数说明：kafka密码。
certificate	否	String	参数说明：kafka安全协议SASL_SSL的X.509格式证书，用于连接开启认证的kafka server
model_ids	否	Array of strings	参数说明：模型ID列表。 user_topics包含model-data时必选，仅支持非系统、分层为gdm的动态模型。可通过 GET /{project_id}/models 查询模型列表接口获取。取值范围：仅支持字母，数字以及中划线（-）的组合，长度为36。

表6 MrsKafkaConfigRequestDTO
参数	是否必选	参数类型	描述
user_topics	否	Array of strings	参数说明：mrskafka的主题列表，根据需要转发的消息类型填写。取值范围： 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上报的车流量统计信息数据 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	是	Array of strings	参数说明：mrsKafka broker列表。
username	否	String	参数说明：mrskafka用户名，若开启安全认证该参数必填。取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。
authentication	否	Boolean	参数说明：是否开启kerberos安全认证的开关。若开启安全认证则需要先上传kerberos安全认证的凭证。
krb5_content	否	String	参数说明：若开启安全认证则需要先上传kerberos安全认证的krb5_file的凭证内容。
keytab_content	否	String	参数说明：若开启安全认证则需要先上传kerberos安全认证的keytab_file的凭证内容。
model_ids	否	Array of strings	参数说明：模型ID列表。 user_topics包含model-data时必选，仅支持非系统、分层为gdm的动态模型。可通过 GET /{project_id}/models 查询模型列表接口获取。取值范围：仅支持字母，数字以及中划线（-）的组合，长度为36。

响应参数

状态码： 201

表7 响应Body参数
参数	参数类型	描述
forwarding_type	String	参数说明：转发配置的类型。取值范围：当前仅支持“kafka、mrskafka”。
kafka_config	KafkaConfigResponseDTO object	参数说明：Kafka配置信息。
mrs_kafka_config	MrsKafkaConfigResponseDTO object	参数说明：mrsKafka配置信息。

表8 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

表9 CertificateInfo
参数	参数类型	描述
effective_date	String	证书生效日期
expiry_date	String	证书失效日期

**表10** 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

请求示例

POST https://{endpoint}/v1/{project_id}/forwarding-configs
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********

{
  "forwarding_type" : "kafka",
  "forwarding_config" : {
    "kafka_config" : {
      "topic_prefix" : "prefix",
      "user_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",
      "password" : "1234567890",
      "model_ids" : [ "40f96952-ea2f-4a10-8a92-e641aa1c6e49" ]
    }
  }
}

响应示例

状态码： 201

Created

{
  "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" ],
    "topic_prefix" : "prefix",
    "brokers" : [ "127.0.0.1:10000" ],
    "username" : "1234567890",
    "status" : "OFFLINE",
    "model_ids" : [ "40f96952-ea2f-4a10-8a92-e641aa1c6e49" ],
    "created_time" : "2015-12-12T12:12:12Z",
    "last_modified_time" : "2015-12-12T12: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"
  }
}

状态码

状态码	描述
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
409	Conflict
429	Too Many Requests
500	Internal Server Error

错误码

请参见错误码。

父主题： 数据转发配置管理

上一篇：数据转发配置管理

下一篇：查询数据转发配置列表

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建数据转发配置

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线