华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 参数说明：总数 最小值：0 最大值：2000 ipcs Array of IpcResponseDTO objects 参数说明：IPC列表 表5 IpcResponseDTO 参数 参数类型 描述 camera_id String 参数说明：摄像头ID，console界面查询摄像头IPC列表中的设备Id。 最小长度：0 最大长度：255 v2x_edge_id String 参数说明：Edge ID，用于唯一标识一个Edge，创建Edge后获得。方法参见 创建Edge。 最小长度：0 最大长度：128 name String 参数说明：摄像头名称。 最小长度：0 最大长度：255 cross_id String 参数说明：摄像头所感知的路口或者路段的Id。 最小长度：0 最大长度：255 focal_type String 参数说明：摄像头聚焦类型。 long：长焦 short：短焦 parent_connect_code String 参数说明：摄像头连接的ITS800的互联编码。 最小长度：0 最大长度：128 connect_code String 参数说明：摄像头的互联编码。 最小长度：0 最大长度：128 description String 参数说明：描述。 最大长度：255 esn String 参数说明：IPC的设备编码。 最大长度：64 ip String 参数说明：该摄像头的ip地址。 最大长度：255 status String 参数说明：摄像机的状态。 取值范围： ONLINE：在线 OFFLINE：离线 INITIAL：初始化 UNKNOWN：未知 SLEEP：休眠 枚举值： ONLINE OFFLINE INITIAL UNKNOWN SLEEP created_time String 参数说明：创建时间。 格式：yyyy-MM-dd''T''HH:mm:ss''Z''。 例如 2020-09-01T01:37:01Z。 last_modified_time String 参数说明：最后修改时间。 格式：yyyy-MM-dd''T''HH:mm:ss''Z''。 例如 2020-09-01T01:37:01Z。 last_online_time String 参数说明：最后在线时间。 格式：yyyy-MM-dd''T''HH:mm:ss''Z''。 例如 2020-09-01T01:37:01Z。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 camera_id String 参数说明：摄像头ID，console界面查询摄像头IPC列表中的设备Id。 最小长度：0 最大长度：255 v2x_edge_id String 参数说明：Edge ID，用于唯一标识一个Edge，创建Edge后获得。方法参见 创建Edge。 最小长度：0 最大长度：128 name String 参数说明：摄像头名称。 最小长度：0 最大长度：255 cross_id String 参数说明：摄像头所感知的路口或者路段的Id。 最小长度：0 最大长度：255 focal_type String 参数说明：摄像头聚焦类型。 long：长焦 short：短焦 parent_connect_code String 参数说明：摄像头连接的ITS800的互联编码。 最小长度：0 最大长度：128 connect_code String 参数说明：摄像头的互联编码。 最小长度：0 最大长度：128 description String 参数说明：描述。 最大长度：255 esn String 参数说明：IPC的设备编码。 最大长度：64 ip String 参数说明：该摄像头的ip地址。 最大长度：255 status String 参数说明：摄像机的状态。 取值范围： ONLINE：在线 OFFLINE：离线 INITIAL：初始化 UNKNOWN：未知 SLEEP：休眠 枚举值： ONLINE OFFLINE INITIAL UNKNOWN SLEEP created_time String 参数说明：创建时间。 格式：yyyy-MM-dd''T''HH:mm:ss''Z''。 例如 2020-09-01T01:37:01Z。 last_modified_time String 参数说明：最后修改时间。 格式：yyyy-MM-dd''T''HH:mm:ss''Z''。 例如 2020-09-01T01:37:01Z。 last_online_time String 参数说明：最后在线时间。 格式：yyyy-MM-dd''T''HH:mm:ss''Z''。 例如 2020-09-01T01:37:01Z。

响应示例 状态码： 200 OK { "camera_id" : "816931939627432304820000000000000000", "v2x_edge_id" : "99678cc3-1665-4cc0-be01-b69346094542", "name" : "camera2", "cross_id" : "code", "focal_type" : "long", "parent_connect_code" : "connectcode", "connect_code" : "code", "description" : "test", "esn" : "124546416113", "ip" : "127.0.0.1", "status" : "ONLINE", "created_time" : "2021-12-23T12:59:43.935Z", "last_modified_time" : "2021-12-23T12:59:43.935Z", "last_online_time" : "2021-12-23T12:59:43.935Z"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Instance-Id 否 String 参数说明：实例ID。dris物理实例的唯一标识。获取方法参见获取Instance-Id。 取值范围：仅支持数字，小写字母和横杠（-）的组合，长度36。 X-Auth-Token 否 String 参数说明：用户Token，Token认证鉴权时必选。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：1 最大长度：20000

响应示例 状态码： 200 OK { "count" : 1, "edges" : [ { "v2x_edge_id" : "74297d76-6f99-4fe2-a435-1e27a524e4c8", "name" : "name", "esn" : "ESN0001123234", "ip" : "127.0.0.1", "position_description" : "test", "status" : "ONLINE", "channel_status" : "ONLINE", "created_time" : "2020-09-01T01:37:01Z" } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 参数说明：总数。 最小值：0 最大值：2147483647 edges Array of V2XEdgeListResponseDTO objects 参数说明：数据列表。 表5 V2XEdgeListResponseDTO 参数 参数类型 描述 v2x_edge_id String 参数说明：Edge ID，用于唯一标识一个Edge。 最小长度：0 最大长度：255 name String 参数说明：V2XEdge的名称 取值范围：长度不超过128，只允许中文、字母、数字、以及_.-等字符的组合。 最大长度：128 esn String 参数说明：设备编码，全局唯一。 取值范围：长度不超过64，只允许字母、数字、以及_等字符的组合。 ip String 参数说明：网络IP，例如127.0.0.1。 position_description String 参数说明：安装位置编码，由用户自定义。 取值范围：长度不低于1不超过128，只允许字母、数字、下划线（_）的组合。 location Location object 经纬度坐标 status String 参数说明：状态。 取值范围： UNINSTALLED： 待部署 INSTALLED：部署中 OFFLINE：离线 ONLINE：在线： UPGRADING：升级中 DELETING：删除中 channel_status String 参数说明：业务通道状态。 枚举值： ONLINE OFFLINE UNKNOWN created_time String 参数说明：创建时间。 格式：yyyy-MM-dd''T''HH:mm:ss''Z''。 例如 2020-09-01T01:37:01Z。 表6 Location 参数 参数类型 描述 lat Number 参数说明：定义纬度数值，北纬为正，南纬为负，单位°，精度小数点后7位。 最小值：-90 最大值：90 lon Number 参数说明：定义经度数值。东经为正，西经为负。单位°，精度小数点后7位。 最小值：-180 最大值：180

请求示例 PUT https://{endpoint}/v1/{project_id}/forwarding-configs/{forwarding_config_id}?forwarding_type={forwarding_type}Content-Type:application/jsonX-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 表4 响应Body参数 参数 参数类型 描述 forwarding_type String 参数说明：转发配置的类型。 取值范围：当前仅支持“kafka、mrskafka”。 kafka_config_id String 参数说明：每一套Kafka配置的唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：1 最大长度：255 kafka_topics Array of strings 参数说明：kafka的主题列表。 取值范围： v2x-v1-tracks：edge上报的车辆轨迹数据 v2x-v1-bsm：车载T-BOX，mqtt协议接入rsu， websocket协议接入rsu上报的BSM消息数据 v2x-v1-rsi：mqtt协议接入rsu，edge上报的RSI消息数据 v2x-v1-rsm： mqtt协议接入rsu，edge上报的RSM消息数据 v2x-v1-spat：mqtt协议接入rsu， websocket协议接入rsu上报的SPAT消息数据 v2x-v1-edge-flow：edge上报的车流量统计信息数据 brokers Array of strings 参数说明：Kafka broker列表。 最小长度：1 最大长度：255 username String 参数说明：kafka用户名。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：1 最大长度：255 topic_prefix String 参数说明：Topic前缀。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：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

响应示例 状态码： 200 OK { "forwarding_type" : "kafka", "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" ], "topic_prefix" : "prefix", "brokers" : [ "127.0.0.1:10000" ], "username" : "1234567890", "status" : "OFFLINE", "authentication" : false, "created_time" : "2015-12-12T12:12:12Z", "last_modified_time" : "2015-12-12T12:12:12Z"}

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Instance-Id 否 String 参数说明：实例ID。dris物理实例的唯一标识。获取方法参见获取Instance-Id。 取值范围：仅支持数字，小写字母和连接符（-）的组合，长度36。 X-Auth-Token 否 String 参数说明：用户Token，Token认证鉴权时必选。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：1 最大长度：20000

URI DELETE /v1/{project_id}/forwarding-configs/{forwarding_config_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID。 取值范围：仅支持数字，a到f的小写字母组合，长度32。 forwarding_config_id 是 String 参数说明：转发配置的唯一ID。 最小长度：1 最大长度：255 表2 Query参数 参数 是否必选 参数类型 描述 forwarding_type 是 String 参数说明：转发配置的类型。 取值范围：当前仅支持“kafka，mrskafka”。 最小长度：1 最大长度：255

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 参数说明：满足查询条件的记录总数。 最小值：0 最大值：10000 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。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：1 最大长度：255 kafka_topics Array of strings 参数说明：kafka的主题列表。 取值范围： v2x-v1-tracks：edge上报的车辆轨迹数据 v2x-v1-bsm：车载T-BOX，mqtt协议接入rsu， websocket协议接入rsu上报的BSM消息数据 v2x-v1-rsi：mqtt协议接入rsu，edge上报的RSI消息数据 v2x-v1-rsm： mqtt协议接入rsu，edge上报的RSM消息数据 v2x-v1-spat：mqtt协议接入rsu， websocket协议接入rsu上报的SPAT消息数据 v2x-v1-edge-flow：edge上报的车流量统计信息数据 brokers Array of strings 参数说明：Kafka broker列表。 最小长度：1 最大长度：255 username String 参数说明：kafka用户名。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：1 最大长度：255 topic_prefix String 参数说明：Topic前缀。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：0 最大长度：255 status String 参数说明：一套kafka的连接状态。 取值范围： OFFLINE：离线 ONLINE：在线 枚举值： OFFLINE ONLINE 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 MrsKafkaConfigResponseDTO 参数 参数类型 描述 kafka_config_id String 参数说明：每一套Kafka配置的唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：1 最大长度：255 kafka_topics Array of strings 参数说明：kafka的主题列表。 取值范围： v2x-v1-tracks：edge上报的车辆轨迹数据 v2x-v1-bsm：车载T-BOX，mqtt协议接入rsu， websocket协议接入rsu上报的BSM消息数据 v2x-v1-rsi：mqtt协议接入rsu，edge上报的RSI消息数据 v2x-v1-rsm： mqtt协议接入rsu，edge上报的RSM消息数据 v2x-v1-spat：mqtt协议接入rsu， websocket协议接入rsu上报的SPAT消息数据 v2x-v1-edge-flow：edge上报的车流量统计信息数据 brokers Array of strings 参数说明：Kafka broker列表。 最小长度：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

响应示例 状态码： 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" ], "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 { "edge_app_id" : "14414341626215826433476361010249", "version" : "1.0.2", "description" : "hello", "created_time" : "2020-05-28T11:31:29.740Z", "last_modified_time" : "2020-05-28T11:31:29.740Z", "state" : "DRAFT", "command" : [ "tets" ], "args" : [ "tets" ], "container_settings" : { "configs" : { "privileged" : false, "host_network" : true, "restart_policy" : "Always", "container_port_list" : [ { "container_port" : 2656, "host_port" : 2656, "host_ip" : "1.1.1.1" } ] }, "image_url" : "/sfwevwefw", "envs" : { "test" : "test" }, "volumes" : [ { "name" : "config", "type" : "LOG", "source" : "/iot/opt/test", "destination" : "/iot/opt/test", "read_only" : false } ], "resources" : { "limits" : { "cpu" : 2, "memory" : 2, "gpu" : 2, "npu" : 2 }, "requests" : { "cpu" : 4, "memory" : 4, "gpu" : 4, "npu" : 4 } }, "ext_devices" : null }, "publish_time" : "2020-05-28T11:31:29.740Z", "off_shelf_time" : "2020-05-28T11:31:29.740Z"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 edge_app_id String 参数说明：用户自定义应用唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）、美元符号（$）的组合。 最小长度：0 最大长度：32 version String 参数说明：应用版本。 最小长度：0 最大长度：32 description String 参数说明：应用描述。 取值范围：只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文引号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）的组合。 最小长度：0 最大长度：255 created_time String 参数说明：创建时间。 最小长度：0 最大长度：255 last_modified_time String 参数说明：最后一次修改时间。 最小长度：0 最大长度：255 state String 参数说明：应用版本状态。 取值范围： DRAFT：草稿 PUBLISHED：发布 OFF_SHELF：下线 command Array of strings 参数说明：启动命令。 args Array of strings 参数说明：启动参数。 container_settings ContainerSettingsDTO object 参数说明：容器配置。 publish_time String 参数说明：发布时间。 最小长度：0 最大长度：255 off_shelf_time String 参数说明：下线时间。 最小长度：0 最大长度：255 表4 ContainerSettingsDTO 参数 参数类型 描述 configs ContainerConfigsDTO object 参数说明：容器特殊参数。 image_url String 参数说明：镜像存储地址。 最小长度：1 最大长度：1000000 envs Object 参数说明：环境变量。 volumes Array of VolumeDTO objects 参数说明：卷配置。 resources ResourceDTO object 参数说明：资源配额。 ext_devices Array of ExtDevice objects 参数说明：外挂设备配置。 表5 ContainerConfigsDTO 参数 参数类型 描述 privileged Boolean 参数说明：开启容器特权模式。 缺省值：false host_network Boolean 参数说明：是否使用主机网络模式。 缺省值：true restart_policy String 参数说明：重启策略，容器执行健康检查后失败后的策略。 最小长度：1 最大长度：255 container_port_list Array of ContainerPortDTO objects 参数说明：容器端口映射值。 表6 ContainerPortDTO 参数 参数类型 描述 container_port Integer 参数说明：构成一堆映射的容器端口。 最小值：1 最大值：65535 host_port Integer 参数说明：构成一对映射的物理机对应网卡端口。 最小值：1 最大值：65535 host_ip String 参数说明：对应网卡地址。 表7 VolumeDTO 参数 参数类型 描述 name String 参数说明：卷名称。 最小长度：1 最大长度：63 type String 参数说明：挂载类型。 source String 参数说明：源路径。 destination String 参数说明：卷挂载路径。 read_only Boolean 参数说明：只读，默认只读。 表8 ResourceDTO 参数 参数类型 描述 limits ResourceConfigDTO object 参数说明：允许容器使用的最大资源。 requests ResourceConfigDTO object 参数说明：容器需要使用的最小资源。 表9 ResourceConfigDTO 参数 参数类型 描述 cpu Float 参数说明：cpu个数。 最小值：0.01 最大值：1000 memory Float 参数说明：内存大小。 最小值：0.01 最大值：1024000 gpu Float 参数说明：gpu个数。 最小值：0.01 最大值：1024000 npu Float 参数说明：npu个数。 最小值：0.01 最大值：1000 表10 ExtDevice 参数 参数类型 描述 source String 参数说明：源路径。 destination String 参数说明：卷挂载路径。 cgroup_permissions String 参数说明：只读，默认MRW。 最小长度：1 最大长度：63

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 edge_app_id String 参数说明：用户自定义应用唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）、美元符号（$）的组合。 最小长度：1 最大长度：32 description String 参数说明：应用描述。 取值范围：只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文引号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）的组合。 最小长度：0 最大长度：255 created_time String 参数说明：创建时间。 最小长度：0 最大长度：255 last_modified_time String 参数说明：更新时间。 最小长度：0 最大长度：255 last_published_version String 参数说明：最新发布版本。 最小长度：0 最大长度：64

响应示例 状态码： 200 Ok { "edge_app_id" : "13125481330735066213121901779837", "description" : "this is a test app", "created_time" : "2021-12-23T12:29:08", "last_modified_time" : "2021-12-23T12:29:09.367", "last_published_version" : null}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Instance-Id 否 String 参数说明：实例ID。dris物理实例的唯一标识。获取方法参见获取Instance-Id。 取值范围：仅支持数字，小写字母和连接符（-）的组合，长度36。 X-Auth-Token 否 String 参数说明：用户Token，Token认证鉴权时必选。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：1 最大长度：20000

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 v2x_edge_id String 参数说明：Edge ID，用于唯一标识一个Edge。 最小长度：0 最大长度：255 edge_app_id String 参数说明：用户自定义应用唯一ID。 最小长度：1 最大长度：32 app_version String 参数说明：应用版本，比如1.0.0。 最小长度：1 最大长度：64 status String 参数说明：应用部署状态。 取值范围： UNINSTALLED：待部署 INSTALLED：部署中 OFFLINE：离线 ONLINE：在线 UPGRADING：升级中 DELETING：删除中 RUNNING：运行中

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Instance-Id 否 String 参数说明：实例ID。dris物理实例的唯一标识。获取方法参见获取Instance-Id。 取值范围：仅支持数字，小写字母和连接符（-）的组合，长度36。 X-Auth-Token 否 String 参数说明：用户Token，Token认证鉴权时必选。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：1 最大长度：20000

URI DELETE /v1/{project_id}/v2x-edges/{v2x_edge_id}/apps/{edge_app_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID。 取值范围：仅支持数字，a到f的小写字母组合，长度32。 edge_app_id 是 String 参数说明：用户自定义应用唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）、美元符号（$）的组合。 最小长度：1 最大长度：32 v2x_edge_id 是 String 参数说明：Edge ID，用于唯一标识一个Edge，创建Edge后获得。方法参见 创建Edge。 最大长度：255

请求示例 POST https://{endpoint}/v1/{project_id}/v2x-edges/{v2x_edge_id}/data-channelContent-Type:application/jsonX-Auth-Token:********Instance-Id:********{ "platform_type" : "DRIS", "platform_para" : { "address" : "127.0.0.1:8080", "username" : "username", "passwd" : "password" }}

响应参数 状态码： 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 参数说明：鉴权用户名。 最小长度：0 最大长度：255 passwd String 参数说明：鉴权密码，ITS800或者ATLAS500的密码 最小长度：0 最大长度：255

Message示例 { "header" : { "instance_id" : "f24b3b95-4a2a-4f6f-a80c-855156b50af7", "event" : "ADDED" }, "body" : { "spat_source" : { "spat_source_type" : "rsu", "spat_source_id" : "RSU0123456789" }, "intersections" : [ { "intersection_id" : { "region" : 1, "node_id" : 301 }, "intersection_status_object" : { "manual_control_is_enabled" : true, "stop_time_is_activated" : false, "failure_flash" : false, "preempt_is_active" : false, "signal_priority_is_active" : false, "fixed_time_operation" : false, "traffic_dependent_operation" : false, "standby_operation" : false, "failure_mode" : false, "controller_off" : false, "recent_map_message_update" : false, "recent_change_in_map_assigned_lanes_ids_used" : false, "no_valid_map_is_available_at_this_time" : false, "no_valid_spat_is_available_at_this_time" : false }, "time_stamp" : "2015-12-12T12:12:12.126Z", "time_confidence" : 5, "phases" : 5 } ], "time_stamp" : "2015-12-12T12:12:12.126Z", "name" : "12345" }}

Message参数 表1 请求Body参数 参数 是否必选 参数类型 描述 body 是 OpenV2XSPATTopicBodyDTO object 参数说明：信号灯消息。 header 是 OpenSPATTopicHeaderDTO object 参数说明：信号灯消息的附加信息。 表2 OpenV2XSPATTopicBodyDTO 参数 是否必选 参数类型 描述 spat_source 否 SPATSource object 参数说明：消息来源。 intersections 是 Array of IntersectionStateDTO objects 参数说明：路口信号灯集合。 time_stamp 否 String 参数说明：平台推送消息的UTC时间。 格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 例如2021-12-18T07:20:51.683Z。 name 否 String 参数说明：供理解的名称描述。 最小长度：1 最大长度：63 表3 SPATSource 参数 是否必选 参数类型 描述 spat_source_type 是 String 参数说明：来源的具体类型。 枚举值： unknown police government meteorological internet detection v2xServer rsu obu signalMachine spat_source_id 否 String 参数说明：来源的唯一标识码ID。 最小长度：0 最大长度：255 表4 IntersectionStateDTO 参数 是否必选 参数类型 描述 intersection_id 是 NodeReferenceId object 参数说明：节点属性ID。 intersection_status_object 否 IntersectionStatusObject object 参数说明：路口信号机的工作状态指示。 time_stamp 否 String 参数说明：信号机发送信号时携带的UTC时间。 格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 如2021-12-18T07:20:51.683Z。 time_confidence 否 Integer 参数说明：数值描述了95%置信水平的时间精度。参考时间精度参数说明。 最小值：0 最大值：39 phases 是 Array of PhaseDTO objects 参数说明：信号灯各道路方向的灯态列表。 表5 NodeReferenceId 参数 是否必选 参数类型 描述 region 否 Integer 参数说明：所在区域在地图中的编号，数值0仅用于测试。 最小值：0 最大值：65535 node_id 是 Integer 参数说明：节点编号。路网最基本的构成即节点和节点之间连接的路段。节点可以是路口，也可以是一条 路的端点。一个节点的ID在同一个区域内是唯一的。数值 0~255 预留为测试使用。 最小值：0 最大值：65535 表6 IntersectionStatusObject 参数 是否必选 参数类型 描述 manual_control_is_enabled 否 Boolean 参数说明：手动控制状态开启。 stop_time_is_activated 否 Boolean 参数说明：停止计时状态激活。 failure_flash 否 Boolean 参数说明：用于硬件故障检测。 preempt_is_active 否 Boolean 参数说明：优先状态激活。 signal_priority_is_active 否 Boolean 参数说明：信号优先级状态激活。 fixed_time_operation 否 Boolean 参数说明：固定配时。 traffic_dependent_operation 否 Boolean 参数说明：基于交通流状态的配时。 standby_operation 否 Boolean 参数说明：备用操作，可部分关闭或闪烁。 failure_mode 否 Boolean 参数说明：故障模式。 controller_off 否 Boolean 参数说明：控制状态关闭。 recent_map_message_update 否 Boolean 参数说明：近期地图内容数据更新。 recent_change_in_map_assigned_lanes_ids_used 否 Boolean 参数说明：近期地图道路id数据更新。 no_valid_map_is_available_at_this_time 否 Boolean 参数说明：此时无有效地图。 no_valid_spat_is_available_at_this_time 否 Boolean 参数说明：此时无有效spat信息。 表7 PhaseDTO 参数 是否必选 参数类型 描述 phase_id 是 Integer 参数说明：定义信号灯相位ID。数值0表示无效ID。 最小值：0 最大值：255 phase_states 是 Array of PhaseStateDTO objects 参数说明：一个信号灯的一个相位状态列表。列表中每一个相位状态物理上对应了一种相位灯色，其属性包括了该状态的实时计时信息。 表8 PhaseStateDTO 参数 是否必选 参数类型 描述 light_state 是 Integer 参数说明：定义信号灯相位的灯色状态。支持GB14886规定的红绿黄三种信号灯灯色，以及亮灯、 闪烁和熄灭三种状态。 取值范围： 0：不可用 1：黑色 2：红色闪烁 3：红色 4：绿色闪烁 5：通行允许相位（通行绿） 6：通行保护相位（保护绿） 7：黄色 8：黄色闪烁 最小值：0 最大值：8 timing 否 TimeChangeDetailsDTO object 参数说明：定义一个信号灯相位的计时状态。提供了两种可选的计时状态格式，一种是倒计时形式，另一种是UTC世界标准时间的形式。在实际使用时，由路侧设施根据实际情况选用。 表9 TimeChangeDetailsDTO 参数 是否必选 参数类型 描述 counting 否 TimeCountingDownDTO object 参数说明：用倒计时形式，描述一个信号灯相位状态的完整计时状态。 utc_timing 否 UTCTimingDTO object 参数说明：用UTC世界标准时间形式，描述一个信号灯相位状态的完整计时状态。 表10 TimeCountingDownDTO 参数 是否必选 参数类型 描述 start_time 是 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 min_end_time 否 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 max_end_time 否 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 likely_end_time 是 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 time_confidence 否 Integer 参数说明：定义置信度。单位为0.5%。 最小值：0 最大值：200 next_start_time 否 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 next_duration 否 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 表11 UTCTimingDTO 参数 是否必选 参数类型 描述 start_utc_time 是 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 min_end_utc_time 否 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 max_end_utc_time 否 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 likely_end_utc_time 是 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 time_confidence 否 Integer 参数说明：定义置信度。单位为0.5%。 最小值：0 最大值：200 next_start_utc_time 否 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 next_end_utc_time 否 TimeMark object 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 表12 TimeMark 参数 是否必选 参数类型 描述 time_mark 是 Integer 参数说明：以0.1秒为单位，定义一小时中的时间。可以表示当前小时中的时刻，也可以表示长度不超过1小时的时间段，单位为0.1秒。 取值范围：0~35999。数值36000表示大于1小时的时间长度。数值36001表示无效数值。 最小值：0 最大值：36001 表13 OpenSPATTopicHeaderDTO 参数 是否必选 参数类型 描述 instance_id 是 String 参数说明：实例ID。dris物理实例的唯一标识。获取方法参见获取Instance-Id。 取值范围：仅支持数字，小写字母和横杠（-）的组合，长度36。 event 是 String 参数说明：操作描述。" 取值范围： MODIFIED：修改 ADDED：新增 DELETED：删除 枚举值： MODIFIED ADDED DELETED

URI DELETE /v1/{project_id}/v2x-edges/{v2x_edge_id}/data-channel 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID。 取值范围：仅支持数字，a到f的小写字母组合，长度32。 v2x_edge_id 是 String 参数说明：Edge ID，用于唯一标识一个Edge。 最小长度：1 最大长度：255

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Instance-Id 否 String 参数说明：实例ID。dris物理实例的唯一标识。获取方法参见获取Instance-Id。 取值范围：仅支持数字，小写字母和横杠（-）的组合，长度36。 X-Auth-Token 否 String 参数说明：用户Token，Token认证鉴权时必选。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：1 最大长度：20000

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 platform_type String 参数说明：平台类型。 取值范围： DRIS：华为路网数字化平台 LITONG：利通 ZHONGQIYAN：中汽研 platform_para PlatformPara object 参数说明：platform_type为非DRIS时有效，表示第三方平台的对接参数 channel_status String 参数说明：华为路网数字化平台或第三方业务平台连接状态。 取值范围： ONLINE：在线 OFFLINE：离线 INITIAL：初始化 表4 PlatformPara 参数 参数类型 描述 address String 参数说明：第三方业务平台的ip地址和端口。 username String 参数说明：鉴权用户名。 最小长度：0 最大长度：255 passwd String 参数说明：鉴权密码，ITS800或者ATLAS500的密码 最小长度：0 最大长度：255

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Instance-Id 否 String 参数说明：实例ID。dris物理实例的唯一标识。获取方法参见获取Instance-Id。 取值范围：仅支持数字，小写字母和横杠（-）的组合，长度36。 X-Auth-Token 否 String 参数说明：用户Token，Token认证鉴权时必选。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：1 最大长度：20000