文档首页/ 路网数字化服务 DRIS/ API参考/ API/ 应用侧API参考/ 业务通道管理/ 创建业务通道
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

创建业务通道

功能介绍

创建业务通道，用于创建Edge消息上报的数据通道。

调试

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

URI

POST /v1/{project_id}/v2x-edges/{v2x_edge_id}/data-channel

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

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

v2x_edge_id

是

String

参数说明：Edge ID，用于唯一标识一个Edge。

取值范围：长度36，只允许小写字母、数字、连接符（-）的组合。

请求参数

表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参数

参数

是否必选

参数类型

描述

platform_type

是

String

参数说明：平台类型。

取值范围：

  • DRIS：华为路网数字化平台

  • LITONG：利通

  • ZHONGQIYAN：中汽研

platform_para

否

PlatformPara object

参数说明：platform_type为非DRIS时有效，表示第三方平台的对接参数。
表4 PlatformPara

参数

是否必选

参数类型

描述

address

否

String

参数说明：第三方业务平台的ip地址和端口。

username

否

String

参数说明：鉴权用户名。

取值范围：长度不超过255，只允许字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

passwd

否

String

参数说明：鉴权密码，ITS800或者ATLAS500的密码

取值范围：长度不超过255，只允许字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

platform_type

String

参数说明：平台类型。

取值范围：

  • DRIS：华为路网数字化平台

  • LITONG：利通

  • ZHONGQIYAN：中汽研

platform_para

PlatformPara object

参数说明：platform_type为非DRIS时有效，表示第三方平台的对接参数

channel_status

String

参数说明：华为路网数字化平台或第三方业务平台连接状态。

取值范围：

  • ONLINE：在线

  • OFFLINE：离线

  • INITIAL：初始化
表6 PlatformPara

参数

参数类型

描述

address

String

参数说明：第三方业务平台的ip地址和端口。

username

String

参数说明：鉴权用户名。

取值范围：长度不超过255，只允许字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

passwd

String

参数说明：鉴权密码，ITS800或者ATLAS500的密码

取值范围：长度不超过255，只允许字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

请求示例

POST https://{endpoint}/v1/{project_id}/v2x-edges/{v2x_edge_id}/data-channel
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********

{
  "platform_type" : "DRIS",
  "platform_para" : {
    "address" : "127.0.0.1:8080",
    "username" : "username",
    "passwd" : "password"
  }
}

响应示例

状态码： 200

OK

{
  "platform_type" : "DRIS",
  "channel_status" : "ONLINE",
  "platform_para" : {
    "address" : "127.0.0.1:8080",
    "username" : "username",
    "passwd" : "password"
  }
}

状态码

状态码

描述

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

错误码

请参见错误码。

父主题： 业务通道管理

相关文档