文档首页> 路网数字化服务 DRIS> API参考> API> 应用侧API参考> 数据转发配置管理> 修改数据转发配置
更新时间：2024-03-14 GMT+08:00
查看PDF
分享

修改数据转发配置

功能介绍

根据转发配置的唯一ID（forwarding_config_id）修改数据转发配置，当前支持更新的字段有topicPrefix、userTopics、brokers，需要把该字段新的对应值全量写入。

调试

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

URI

PUT /v1/{project_id}/forwarding-configs/{forwarding_config_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

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

forwarding_config_id

是

String

参数说明：转发配置的唯一ID。

最小长度：1

最大长度：255
表2 Query参数

参数

是否必选

参数类型

描述

forwarding_type

是

String

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

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

最小长度：1

最大长度：255

请求参数

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

最小长度：1

最大长度：20000
表4 请求Body参数

参数

是否必选

参数类型

描述

kafka_config

否

UpdateKafkaConfigRequestDTO object

参数说明：kafka更新配置，支持topicPrefix、userTopics、brokers，需要把该字段新的对应值全量写入。

mrs_kafka_config

否

UpdateMrsKafkaConfigRequestDTO object

参数说明：kafka更新配置，支持topicPrefix、userTopics、brokers，需要把该字段新的对应值全量写入。
表5 UpdateKafkaConfigRequestDTO

参数

是否必选

参数类型

描述

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上报的车流量统计信息数据

数组长度：0 - 7

brokers

否

Array of strings

参数说明：用户kafka的brokers列表。

最小长度：0

最大长度：255

数组长度：0 - 255

username

否

String

参数说明：kafka用户名。

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

最小长度：1

最大长度：255

password

否

String

参数说明：kafka密码。

最小长度：1

最大长度：255

certificate

否

String

参数说明：kafka安全协议SASL_SSL的X.509格式证书，用于连接开启认证的kafka server

最小长度：1

最大长度：1048576
表6 UpdateMrsKafkaConfigRequestDTO

参数

是否必选

参数类型

描述

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上报的车流量统计信息数据

数组长度：0 - 7

brokers

否

Array of strings

参数说明：用户mrskafka的brokers列表。

最小长度：0

最大长度：255

数组长度：0 - 255

username

否

String

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

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

最小长度：0

最大长度：255

authentication

否

Boolean

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

缺省值：false

krb5_content

否

String

参数说明：若开启安全认证则需要先上传kerberos安全认证的krb5_file的凭证内容。

keytab_content

否

String

参数说明：若开启安全认证则需要先上传kerberos安全认证的keytab_file的凭证内容。

响应参数

状态码： 200

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

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

最小长度：1

最大长度：255

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上报的车流量统计信息数据

数组长度：0 - 7

brokers

Array of strings

参数说明：Kafka broker列表。

最小长度：1

最大长度：255

数组长度：1 - 255

username

String

参数说明：kafka用户名。

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

最小长度：1

最大长度：255

topic_prefix

String

参数说明：Topic前缀。

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

status

String

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

取值范围：

  • OFFLINE：离线

  • ONLINE：在线

枚举值：

  • OFFLINE

  • ONLINE

cert_info

CertificateInfo object

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。

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

最小长度：1

最大长度：255

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上报的车流量统计信息数据

数组长度：0 - 7

brokers

Array of strings

参数说明：Kafka broker列表。

最小长度：1

最大长度：255

数组长度：1 - 255

username

String

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

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

最小长度：0

最大长度：255

status

String

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

取值范围：

  • OFFLINE：离线

  • ONLINE：在线

枚举值：

  • OFFLINE

  • ONLINE

authentication

Boolean

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

缺省值：false

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

请求示例

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

{
  "kafka_config" : {
    "topic_prefix" : "abc",
    "user_topics" : [ "v2x-v1-tracks", "v2x-v1-bsm", "v2x-v1-rsi", "v2x-v1-rsm", "v2x-v1-spat", "v2x-v1-edge-flow" ],
    "brokers" : [ "127.0.0.1:1000" ],
    "username" : "1234567890",
    "password" : "1234567890"
  }
}

响应示例

状态码： 200

OK

{
  "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" ],
    "brokers" : [ "127.0.0.1:10000" ],
    "username" : "1234567890",
    "topic_prefix" : "abc",
    "status" : "ONLINE",
    "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" ],
    "brokers" : [ "127.0.0.1:10000" ],
    "username" : null,
    "status" : null,
    "authentication" : false,
    "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

错误码

请参见错误码。

分享：

    相关文档

    相关产品