华为云用户手册

  • 结构定义 表1 请求Body参数 参数 是否必选 参数类型 描述 etag 是 String 参数说明:Map消息的etag,格式为:地图来源_格式标准_标准对应的版本_扩展说明_时间。仅允许数字、大小写字母及下划线(_)的组合。 mapParts 是 Array of UploadMapPart objects 参数说明:高精地图的区域列表。 表2 UploadMapPart 参数 是否必选 参数类型 描述 referencePoints 是 Array of UploadMapReferencePoint objects 当前区域的分割参考点,即当前区域地图数据需下发的目标设备 nodes 是 Array of UploadMapNode objects 基于V2X MAP消息集定义的node节点,单一分片地图暂定最大63个node 表3 UploadMapReferencePoint 参数 是否必选 参数类型 描述 deviceType 是 String 参考点设备的设备类型。 deviceId 是 String 参考点设备的设备id, 若设备类型为RSU则为rsu_id,若设备类型为Edge则为v2x_edge_id。设备id为36位小写字母、数字及中划线(-)的组合" 表4 UploadMapNode 参数 是否必选 参数类型 描述 name 否 String 参数说明:节点属性名称。仅允许小写字母、大写字母、数字、下划线(_)及中划线(-)的组合。 最小长度:1 最大长度:256 id 是 UploadMapNodeReferenceId object 参数说明:地图节点ID。 refPos 是 UploadMapPosition3D object 参数说明:位置信息。 inLinks 否 Array of UploadMapLink objects 参数说明:节点上下游路段集合。 zone 否 Array of UploadMapZone objects 参数说明:特殊区域,如导流线,禁停区等。 表5 UploadMapPosition3D 参数 是否必选 参数类型 描述 lat 是 Number 参数说明:定义纬度数值,北纬为正,南纬为负,单位为:1°,精确到小数点后7位; 最小值:-90 最大值:90 lon 是 Number 参数说明定义经度数值。东经为正,西经为负,单位为:1°,精确到小数点后7位; 最小值:-180 最大值:180 ele 否 Number 参数说明:定义车辆海拔高程,可选,单位为分米。数值-4096 表示无效数值。 最小值:-4096 最大值:61439 表6 UploadMapLink 参数 是否必选 参数类型 描述 name 否 String 参数说明:路段名称。仅允许小写字母、大写字母、数字、下划线(_)及中划线(-)的组合。 最小长度:1 最大长度:256 upstreamNodeId 是 UploadMapNodeReferenceId object 参数说明:地图节点ID。 speedLimits 否 Array of UploadMapSpeedLimit objects 参数说明:限速列表,最大9个。 linkWidth 是 Integer 参数说明:车道宽度,单位cm。 最小值:0 最大值:400 points 否 Array of UploadMapPosition3D objects 参数说明:路段中心点,数量范围(2~31)。 movements 否 Array of UploadMapMovement objects 参数说明:下游信息,最大32个。 lanes 是 Array of UploadMapLane objects 参数说明:路段包含的车道,最大32个。 stopLine 否 Array of UploadMapPosition3D objects 参数说明:道路停止线,一般在红绿灯路口定义多个坐标点连接成为一条线,通常为两点连接为一条直线,也可以是一条折线,数量范围(2-32)。 表7 UploadMapMovement 参数 是否必选 参数类型 描述 remoteIntersection 是 UploadMapNodeReferenceId object 参数说明:地图节点ID。 phaseId 否 Integer 参数说明:信号灯相位ID,数值0表示无效ID。 最小值:0 最大值:255 表8 UploadMapLane 参数 是否必选 参数类型 描述 laneId 是 Integer 参数说明:车道ID。车道定义在每一条有向路段上,同一条有向路段上的每个车道,都拥有一个单独的ID。以该车道行驶方向为参考,自左向右从1开始编号 最小值:0 最大值:20 laneWidth 是 Integer 参数说明:车道宽度,单位cm。 最小值:0 最大值:400 laneAttributes 是 UploadMapLaneAttributes object 参数说明:定义车道属性。包括车道共享情况以及车道本身所属的类别特性。 maneuvers 否 Array of strings 参数说明:车道所允许的行驶方向。 取值范围: straightAllowed:允许直行 leftAllowed:允许左转向 rightAllowed:允许右转向 uTurnAllowed:允许掉头转向 leftTurnOnRedAllowed:红灯情况下允许左转向 rightTurnOnRedAllowed:红灯情况下允许右转向 laneChangeAllowed:允许变道 noStoppingAllowed:不允许停车 yieldAllWaysRequired:非保护车道状态,如永久黄灯状态 goWithHalt:停车,再前行 caution:小心前行 connectsTo 否 Array of UploadMapConnection objects 参数说明:车道与下游路段车道的连接关系列表。 speedLimits 否 Array of UploadMapSpeedLimit objects 参数说明:限速列表,最大9个。 points 是 Array of UploadMapPosition3D objects 参数说明:车道中间点列表。 parkingSlots 否 Array of UploadMapParkingSlot objects 参数说明:路边停车位。 表9 UploadMapLaneAttributes 参数 是否必选 参数类型 描述 shareWith 否 Array of strings 参数说明:定义车道被共享的情况。在已有的车道属性定义基础上,该数据表示此车道还会有其他的交通参与者出现,并可能拥有相同的路权。 取值范围: overlappingLaneDescriptionProvided:当存在其他车道时,描述重叠共享车道的路径。不适用简单交叉车道。 multipleLanesTreatedAsOneLane:当车道对象的路径和宽度细节表示多个车道的情况下,使用该参数判断是否为多个车道。各种模式和交通类型都可以共享该车道。 otherNonMotor:其他非机动车类型的共享车道情况。 individualMotorizedVehicle:个人机动车共享车道情况。 bus:公交车共享车道情况。 taxi:出租车共享车道情况。 pedestrians:人群共享车道情况。 cyclistVehicle:自行车共享车道情况。 trackedVehicle:履带车共享车道情况。 pedestrian:行人共享车道情况。 laneType 是 UploadMapLaneTypeAttributes object 参数说明:道路属性,根据道路类型定义其具体的属性。该属性包含多个子属性,对于一条车道,只有一个属性会生效,正常情况下只携带一个子属性。如果携带了多个子属性,属于异常情况,取第一个携带的子属性。 leftBoundary 是 UploadMapLaneBoundary object 参数说明:定义车道线属性。 rightBoundary 是 UploadMapLaneBoundary object 参数说明:定义车道线属性。 hovTimes 否 Array of UploadMapHovTime objects 参数说明:hov(多成员车道,High-Occupancy Vehicle Lane)生效时间。 busTimes 否 Array of UploadMapBusTime objects 参数说明:公交车道生效时间生效时间。 prohibitInfos 否 Array of UploadMapProhibitInfo objects 参数说明:禁行信息。 表10 UploadMapLaneTypeAttributes 参数 是否必选 参数类型 描述 vehicle 否 Array of strings 参数说明:表达车道相关属性。最大个数:16 取值范围: revocable ramp hovLaneOnly busOnly taxiOnly publicUseOnly emergency permissionOnRequest crosswalk 否 Array of strings 参数说明:表达车道相关属性。最大个数:16 取值范围: revocable bicyleAllowed xWalkFlyOver fixedCycleTime biDirectionalCycleTimes hasPushWalkButton audioSupport rfSignalRequestPresent unsignalizedSegmentsPresent bikeLane 否 Array of strings 参数说明:表达车道相关属性。最大个数:16 取值范围: revocable pedestrianAllowed bikeFlyOver fixedCycleTime biDirectionalCycleTimes isolatedByBarrier unsignalizedSegmentsPresent sidewalk 否 Array of strings 参数说明:表达车道相关属性。最大个数:16 取值范围: revocable bicyleAllowed sidewalkFlyOver walkBikes median 否 Array of strings 参数说明:表达车道相关属性。最大个数:16 取值范围: revocable median whiteLineHashing stripedLines doubleStripedLines trafficCones constructionBarrier trafficChannels lowCurbs highCurbs striping 否 Array of strings 参数说明:表达车道相关属性。最大个数:16 取值范围: revocable drawOnLeft drawOnRight connectingLanesLeft connectingLanesRight connectingLanesAhead trackedVehicle 否 Array of strings 参数说明:表达车道相关属性。最大个数:16 取值范围: revocable commuterRailRoad lightRailRoad heavyRailRoad otherRailType parking 否 Array of strings 参数说明:表达车道相关属性。最大个数:16 取值范围: revocable parallelParking headInParking notParkZone parkingForBus parkingForTaxi noPublicParking 表11 UploadMapLaneBoundary 参数 是否必选 参数类型 描述 type 是 String 参数说明:车道线类型。 取值范围: singleSolidLine: 单实线 doubleSolidLine: 双实线 singleDashedLine: 单虚线 doubleDashedLine: 双虚线 dashedSolidLine: 虚实线(内虚,外实) solidDashedLine: 实虚线(内实,外虚) curbside: 路牙 railing: 栏杆 wall: 墙 color 否 String 参数说明:车道线颜色。 取值范围: white: 白色 yellow: 黄色 width 否 Integer 参数说明:车道线宽度,单位:厘米 最小值:0 最大值:100 表12 UploadMapHovTime 参数 是否必选 参数类型 描述 startTime 是 Integer 参数说明:生效开始时间,定义为一天的分钟数。 最小值:0 最大值:1440 endTime 是 Integer 参数说明:生效结束时间,定义为一天的分钟数。 最小值:0 最大值:1440 validType 否 String 参数说明:生效日期类型。 取值范围: allDate: 所有日期 holiday: 节假日 exceptHoliday: 节假日除外 weekend: 周末 exceptWeekend: 周末除外 表13 UploadMapBusTime 参数 是否必选 参数类型 描述 startTime 是 Integer 参数说明:生效开始时间,定义为一天的分钟数。 最小值:0 最大值:1440 endTime 是 Integer 参数说明:生效结束时间,定义为一天的分钟数。 最小值:0 最大值:1440 validType 否 String 参数说明:生效日期类型。 取值范围: allDate: 所有日期 holiday: 节假日 exceptHoliday: 节假日除外 weekend: 周末 exceptWeekend: 周末除外 表14 UploadMapProhibitInfo 参数 是否必选 参数类型 描述 startTime 是 Integer 参数说明:生效开始时间,定义为一天的分钟数。 最小值:0 最大值:1440 endTime 是 Integer 参数说明:生效结束时间,定义为一天的分钟数。 最小值:0 最大值:1440 vehicleType 是 Integer 参数说明:车辆类型,参考车辆基本类型。 最小值:0 最大值:100 validType 否 String 参数说明:生效日期类型。 取值范围: allDate: 所有日期 holiday: 节假日 exceptHoliday: 节假日除外 weekend: 周末 exceptWeekend: 周末除外 表15 UploadMapConnection 参数 是否必选 参数类型 描述 remoteIntersection 是 UploadMapNodeReferenceId object 参数说明:地图节点ID。 connectingLane 否 UploadMapConnectingLane object 参数说明:用于定位上游车道转向连接的下游车道。包括下游车道 ID 以及该转向的允许行驶行为下游车道 ID 的作用范围是该车道所在的路段。 phaseId 否 Integer 参数说明:定义信号灯相位ID。数值0表示无效。 最小值:0 最大值:255 表16 UploadMapNodeReferenceId 参数 是否必选 参数类型 描述 region 否 Integer 参数说明:所在区域在地图中的编号,数值0仅用于测试。 最小值:0 最大值:65535 id 是 Integer 参数说明:节点编号。路网最基本的构成即节点和节点之间连接的路段。节点可以是路口,也可以是一条路的端点。一个节点的ID在同一个区域内是唯一的。 数值0~255预留为测试使用。 最小值:0 最大值:65535 表17 UploadMapConnectingLane 参数 是否必选 参数类型 描述 laneId 是 Integer 参数说明:车道定义在每一条有向路段上,同一条有向路段上的每个车道,都拥有一个单独的ID。车道号以该车道行驶方向为参考,自左向右从1开始编号。 最小值:1 最大值:255 maneuvers 否 Array of strings 参数说明:车道所允许的行驶方向。 取值范围: straightAllowed:允许直行 leftAllowed:允许左转向 rightAllowed:允许右转向 uTurnAllowed:允许掉头转向 leftTurnOnRedAllowed:红灯情况下允许左转向 rightTurnOnRedAllowed:红灯情况下允许右转向 laneChangeAllowed:允许变道 noStoppingAllowed:不允许停车 yieldAllWaysRequired:非保护车道状态,如永久黄灯状态 goWithHalt:停车,再前行 caution:小心前行 表18 UploadMapSpeedLimit 参数 是否必选 参数类型 描述 type 是 String 参数说明:限速类型。 取值范围: unknown: 未知 maxSpeedInSchoolZone: 学校区域的最大速度 maxSpeedInSchoolZoneWhenChildrenArePresent: 学校区域存在学生时的最大速度 maxSpeedInConstructionZone: 建筑区的最大速度 vehicleMinSpeed: 汽车最小速度 vehicleMaxSpeed: 汽车最大速度 vehicleNightMaxSpeed: 汽车夜间行驶最大速度 truckMinSpeed: 卡车最小速度 truckMaxSpeed: 卡车最大速度 truckMinSpeed: 卡车最小速度 truckNightMaxSpeed: 卡车夜间行驶最大速度 vehiclesWithTrailersMinSpeed: 拖车最小速度 vehiclesWithTrailersMaxSpeed: 拖车最大速度 vehiclesWithTrailersNightMaxSpeed: 拖车夜间行驶最大速度 speed 是 Integer 参数说明:限速大小,单位为0.02m/s。数值8191表示无效数值。 最小值:0 最大值:8191 表19 UploadMapParkingSlot 参数 是否必选 参数类型 描述 polygon 是 Array of UploadMapPosition3D objects 参数说明:停车位区域边界,通过坐标点顺序连接构成的多边形,一般是四边形,最大32个点。 lat 是 Number 参数说明:定义纬度数值,北纬为正,南纬为负,单位为:1°,精确到小数点后7位; 最小值:-90 最大值:90 lon 是 Number 参数说明定义经度数值。东经为正,西经为负,单位为:1°,精确到小数点后7位; 最小值:-180 最大值:180 side 是 Integer 参数说明:停车位与lane的方位关系。左侧:left(0),右侧:right(1),不使用:not used(2) 最小值:0 最大值:2 poiId 是 Integer 参数说明:停车位id。最大为65535。 最小值:0 最大值:65535 表20 UploadMapZone 参数 是否必选 参数类型 描述 type 是 String 参数说明: 区域类型。 取值范围: crosswalk:人行横道 constructionIsolation:施工隔离 guideLine:导流线区域 speedBump:减速带 gridLine:方格线区域 regionalBoundary 是 Array of UploadMapPosition3D objects 参数说明:通过坐标点顺序连接构成的多边形,最大32个点。
  • 响应示例 状态码: 201 Created { "traffic_controller_id" : "13229397084005974033576909202199", "esn" : "17598448011929637214623971962555", "name" : "TrafficController001", "description" : "test001", "lat" : 40.1234567, "lon" : 116.1234567, "ele" : 116.741, "pos_description" : "K08", "installation_mode" : "columnar", "road_name" : "road1", "link_id" : "12345676", "status" : "INITIAL", "last_modified_time" : "2022-01-06T09:30:24Z", "created_time" : "2022-01-06T09:30:24Z", "last_online_time" : 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
  • URI DELETE /v1/{project_id}/vehicles/{vehicle_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID。 取值范围:仅支持数字,a到f的小写字母组合,长度32。 vehicle_id 是 String 参数说明:车辆唯一标识符。 取值范围:长度不超过128,只允许字母、数字、以及_-等字符的组合。
  • 响应示例 状态码: 201 Created { "vehicle_id" : "13229397084005974033576909202199", "plate_no" : "粤B12345", "vin" : "vin121456", "obu_id" : "112412", "imei" : "2313523162", "brand" : "polo", "model" : "model", "style" : "2020", "fuel_type" : "gasoline", "color" : "blue", "plate_color" : "black", "access_type" : "5g", "description" : "description", "status" : "INITIAL", "created_time" : "2022-01-06T09:30:24Z"}
  • 请求示例 PUT https://{endpoint}/v1/{project_id}/traffic-controllers/{traffic_controller_id}Content-Type:application/jsonX-Auth-Token:********Instance-Id:********{ "name" : "TrafficController001", "description" : "test001", "lat" : 40.1234567, "lon" : 116.1234567, "ele" : 116.741, "pos_description" : "K08", "installation_mode" : "columnar", "road_name" : "road2", "link_id" : "12345678"}
  • 响应示例 状态码: 200 OK { "name" : "TrafficController001", "description" : "test001", "lat" : 40.1234567, "lon" : 116.1234567, "ele" : 116.741, "pos_description" : "K08", "installation_mode" : "columnar", "road_name" : "road2", "link_id" : "12345678", "status" : "INITIAL", "last_modified_time" : "2022-01-06T09:30:24Z", "created_time" : "2022-01-06T09:30:24Z", "last_online_time" : null}
  • 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 DRIS.00000002 Invalid input. %s 请求参数不合法 请排查请求参数是否符合文档定义。 400 DRIS.00000012 Resource create failed. 开通资源失败 请联系华为工程师分析解决。 400 DRIS.00000013 Resource already exist. This domain is already create resource. 资源已经存在 资源已经存在,请勿重复开通资源。 400 DRIS.00010001 The RSU ESN already exists. RSU esn已经存在 请更换esn后重试。 400 DRIS.00010005 The RSU model name already exists. RSU型号名称已存在 请更换名称后重试。 400 DRIS.00020002 Invalid input, event type invalid. 事件分类和事件类型不匹配 请参考国标交通事件编码填写。 400 DRIS.00020003 Invalid input, no tenant id found! 帐号ID不合法 请联系华为工程师分析解决。 400 DRIS.00030001 Invalid input. No matching RSU found for this event. 事件位置范围内未匹配到RSU 请检查事件位置是否正确。 400 DRIS.00100001 The number of RSU connection to Edges have reached the upper limit. RSU可关联的Edge数量达上限 请参考修改一个RSU资源调整RSU可关联的Edge数量。 400 DRIS.00100003 The EdgeApps are repeated. Edge App已经存在 请更换edge_app_id后重试。 400 DRIS.00120002 IPC ESN duplicate IPC设备已经存在 请更换esn后重试。 400 DRIS.00130003 Create install command failed. 生成边缘节点安装命令失败 请联系华为工程师分析解决。 400 DRIS.00200000 Instance not found. dris实例不存在 请确认携带的instance_id是否正确。 400 DRIS.00210001 Unknown system mode. 未知的系统模式 请确认携带的systemMode是否正确。 400 DRIS.00210003 Incremental updates are not supported. License不支持增量更新 请尝试使用全量更新操作。 400 DRIS.00210008 ESN not match can not apply. 激活license时esn匹配失败 请联系华为工程师分析解决。 400 DRIS.00280001 The Vehicle VehicleId already exists. 车辆ID已经存在 请更换vehicle_id后重试。 400 DRIS.00290001 The TrafficController TrafficControllerId already exists. 信号机设备已存在 请更换traffic_controller_id后重试。 400 DRIS.00340002 The file not found! 文件不存在 请确认对应file_id的文件是否已经导入到平台。 400 DRIS.00340003 The file has imported! 文件中的设备已经创建 请更换文件后重试。 400 DRIS.00350004 The linkAssetRelation file not found! 该file_id对应的路段设备关系文件不存在 请确认对应file_id的文件是否已经导入到平台后重试。 401 DRIS.00000004 Token is invalid. token不合法 请排查请求中的token是否正确或是否过期。 401 DRIS.00000007 Resource unauthorized. The instance does not belong to this authorized user. 资源未授权 请确认是否已开通资源。 401 DRIS.00000010 Resource unauthorized. URL's project id doesn't match token. 资源访问受限 请检查携带的token是否有权限访问url中指定project_id的项目。 403 DRIS.00000005 Resource limit reached. 请求的资源配额已达上限 请联系华为工程师分析解决。 403 DRIS.00000006 Resource is frozen. 资源已被冻结 请联系华为工程师分析解决。 403 DRIS.00000009 Operation not allowed. The user does not have the permission of this API. 无权访问此API 请联系华为工程师确认用户的权限策略。 403 DRIS.00010004 Rsu resource reach limit. RSU可关联的Edge数量达上限 请参考修改一个RSU资源调整RSU可关联的Edge数量。 403 DRIS.00020004 Traffic event resource reach limit. 交通事件数量达上限 请删除一些交通事件后重试。 403 DRIS.00031005 Simulation task is running! 仿真任务正在执行中 请在任务执行完成后再操作。 403 DRIS.00031006 Simulation task lack scenes! 仿真任务缺少任务应用场景 请根据任务类型补全对应场景。 403 DRIS.00130001 Request forbidden. The system app $edgetepa must be deployed first. 部署边缘应用失败 请先部署边缘系统应用。 403 DRIS.00130005 The EdgeApp cannot be deleted because it has associated DataChannels. 删除边缘应用失败 Edge设备的业务通道存在时无法直接删除边缘应用,请先删除业务通道后重试。 403 DRIS.00150001 Max configurations (10) exceeded. 租户数据转发配置资源(Kafka)数量达上限 请删除未使用的数据转发配置后重试。 403 DRIS.00150002 The broker in your request already exists. Check your Kafka configurations. 数据转发配置中的broker地址已经存在 请更换broker地址及用户名密码后重试。 403 DRIS.00190001 The algorithm model for this function of this road network already exists. 算法模型已经存在 请确认对应road_network_id和model_function的算法模型是否已经添加到平台。 403 DRIS.00190002 The algorithm model of this version is in use. 指定版本的算法模型已经在使用中 请确认此版本的算法模型处于非使用状态后重试 403 DRIS.00200002 Forbidden to operate instance. 禁止操作dris实例 请联系华为工程师分析解决。 403 DRIS.00280003 Vehicle resource reach limit. 车辆数量达上限 请联系华为工程师分析解决。 403 DRIS.00290003 TrafficController resource reach limit. 信号机设备数量达上限 请联系华为工程师分析解决。 403 DRIS.00350001 The number of devices of the same data type on one link exceeds the limit! 该路段下同种数据类型的绑定设备数量超过限制 请先解绑该路段下对应数据类型的已绑定设备后重试。 403 DRIS.00350002 The total number of linkAssetRelation exceeds the limit! 绑定路段设备关系总数超过限制 请先解绑部分未使用的路段设备关系后重试。 403 DRIS.00350003 The linkAssetRelation not bound! 该路段设备关系未绑定 请确认当前输入的link_id,esn,data_type对应的路段设备关系已绑定。 403 DRIS.00350005 The number of subTasks in the file exceeds limit 该文件下对应的子任务数量超过限制 请减少文件中的待操作的数据条数以符合限制后重试。 403 DRIS.00350006 The linkAssetRelation task is running! 已有路段设备任务正在执行 请在当前任务完成后再重试。 404 DRIS.00000011 Resource not found. 资源不存在 请确认是否已开通资源。 404 DRIS.00010002 The RSU not found. RSU不存在 请确认对应的rsu_id或esn是否已经在平台创建RSU。 404 DRIS.00010003 Rsu model not found. RSU型号不存在 请确认对应的rsu_model_id是否已经在平台创建RSU型号。 404 DRIS.00020001 This traffic event is not found. 交通事件不存在 请确认对应的event_id是否已经在平台创建交通事件。 404 DRIS.00040001 Area config not found. 区域配置不存在 请确认对应的area_code是否已经在平台添加区域配置。 404 DRIS.00080001 Rule config not found 交通事件规则配置不存在 请确认对应的event_type或position_id是否已经在平台新增规则。 404 DRIS.00090001 Edge not found. Edge设备不存在 请确认对应的v2x_edge_id是否已经在平台创建Edge设备。 404 DRIS.00100002 The EdgeApp not found. Edge App不存在 请确认对应的edge_app_id是否已经在平台创建Edge App。 404 DRIS.00100004 The EdgeAppVersion not found. Edge App版本不存在 请确认对应的version是否已经在平台创建Edge App版本。 404 DRIS.00120001 This camera does not exist. IPC设备不存在 请确认对应camera_id的IPC设备是否已经添加到平台。 404 DRIS.00130002 The V2XEdgeApp not found 边缘应用不存在 请确认对应v2x_edge_id和edge_app_id的边缘应用是否已经部署。 404 DRIS.00130004 DataChannel not found 业务通道不存在 请确认指定Edge设备(v2x_edge_id)是否已经在平台创建业务通道 404 DRIS.00150003 Kafka config not found 数据转发配置资源(Kafka)不存在 请确认对应的forwarding_config_id是否已经在平台创建数据转发配置。 404 DRIS.00170001 Not Found. 地图区间不存在 请确认地图区间是否已经在平台添加。 404 DRIS.00180001 Not Found. 资源不存在 请确认是否已开通资源。 404 DRIS.00190003 The algorithm model not found. 算法模型不存在 请确认对应model_id的算法模型是否已经添加到平台。 404 DRIS.00210000 The license file does not exist and cannot be updated. License文件不存在 请确认携带的lsn是否正确。 404 DRIS.00210004 ESN not found. license esn不存在 请联系华为工程师分析解决。 404 DRIS.00220001 The file not found. 文件不存在 请联系华为工程师分析解决。 404 DRIS.00230001 The interaction not found. 对接系统不存在 请确认对应interaction_id的对应系统是否已经在平台配置。 404 DRIS.00240001 The ITS asset not found. 交通设施不存在 请确认对应its_asset_id的交通设施是否已经在平台添加。 404 DRIS.00250001 Link not found. 路段不存在 请确认对应link_id的路段是否已经在平台添加。 404 DRIS.00260001 The Road network not found. 路网不存在 请确认对应road_network_id的路网是否已经在平台生成。 404 DRIS.00270001 The control strategy not found. 管控策略不存在 请确认对应strategy_id的管控策略是否已经在平台下发。 404 DRIS.00280002 The Vehicle not found. 车辆不存在 请确认对应vehicle_id的车辆资源是否已经在平台创建。 404 DRIS.00290002 The TrafficController not found. 信号机设备不存在 请确认对应traffic_controller_id的信号机设备是否已经在平台创建。 404 DRIS.00300001 The datasource not found. 数据源不存在 请检查data_source_id是否正确。 404 DRIS.00310001 The simulation task not found! 仿真任务不存在 请确认对应task_id的仿真任务是否已经在平台创建。 404 DRIS.00320001 The common scene not found! 仿真任务普通场景不存在 请确认对应task_id和common_id的普通场景仿真任务是否已经在平台创建。 404 DRIS.00320002 The accident scene not found! 仿真任务事故场景不存在 请确认对应task_id和accident_id的事故场景仿真任务是否已经在平台创建。 404 DRIS.00320003 The construction scene not found! 仿真任务施工场景不存在 请确认对应task_id和construction_id的施工场景仿真任务是否已经在平台创建。 404 DRIS.00320004 The common speed-limit scene not found! 仿真任务限速场景不存在 请确认对应task_id和speed_limit_id的限速场景仿真任务是否已经在平台创建。 404 DRIS.00320005 The common flow-control scene not found! 仿真任务匝道流控场景不存在 请确认对应task_id和flow_control_id的匝道流控场景仿真任务是否已经在平台创建。 404 DRIS.00320006 The emergency-lan-open scene not found! 仿真任务开放应急车道场景不存在 请确认对应task_id和emergency_lan_open_id的开放应急车道场景仿真任务是否已经在平台创建。 404 DRIS.00330001 The statistics result not found! 仿真任务的统计结果不存在 请检查任务是否已经执行成功。 404 DRIS.00330002 The detector result not found! 仿真任务的检测器结果不存在 请检查任务是否已经执行成功且检测器已经存在。 404 DRIS.00340001 The task not found! 任务不存在 请确认对应task_id的任务是否已经在平台创建。 404 DRIS.00350007 The linkAssetRelation task not found! 该task_id对应的路段设备关系任务不存在 请确认对应task_id的路段设备关系任务是否已经在平台创建。 405 DRIS.00000003 Method not allowed. Http request method not supported, just supports: %s Http Method不合法 请排查Http Method是否与文档一致。 429 DRIS.00000008 Request reached the maximum rate limit %s. 请求被流控 请在流控范围内请求接口。 500 DRIS.00000001 Internal server error. %s 服务器内部错误 请联系华为工程师分析解决。 500 DRIS.00200001 Instance create failed. %s 创建dris实例失败 请联系华为工程师分析解决。 500 DRIS.00200003 Create vpc endpoint failed. 创建vpcep失败 请联系华为工程师分析解决。 500 DRIS.00200004 Create iotda out channel failed. 创建IoTDA的网络通道失败 请联系华为工程师分析解决。 500 DRIS.00210002 Update device limit failed. 更新设备数上限配置时发生错误 请联系华为工程师分析解决。 500 DRIS.00210005 Get key file content failed. 获取license key文件失败 请联系华为工程师分析解决。 500 DRIS.00210006 Get revoke code failed. 更新license为失败状态时获取失效码失败 请联系华为工程师分析解决。 500 DRIS.00210007 Parse license failed. license解析失败 请联系华为工程师分析解决。
  • 概述 西北原则指对于一段道路,选择西、北的点作为起点,先西后北。 道路走向按照西北原则选择“起点”和“终点”,整体的“起点”和“终点”确定后,道路的整体走向就确定了。从起点”到“终点”为正向,从“终点”到“起点”为逆向,匝道的走向和道路的走向相同,即: 汇入正向,则为正向; 从正向流出,为正向; 汇入逆向,则为逆向; 从逆向流出,为逆向; 如果遇到高架桥,存在匝道绕行后,从正向到逆向的情况,则需要针对这种匝道做特殊处理,数据拆分成两份,一份作为正向的流出,一份作为逆向的汇入,不影响流量预测模型的分析处理。 图1 西北原则确定起点终点示意图
  • 响应示例 状态码: 200 OK { "count" : 1, "vehicles" : [ { "vehicle_id" : "12302463411926825917269660281057", "plate_no" : "Huawei", "vin" : "74512845126", "obu_id" : "OBU_007", "imei" : "987954asdfasdf", "brand" : "Huawei", "model" : "Huawei", "style" : "2022", "fuel_type" : "gasoline", "color" : "white", "plate_color" : "black", "access_type" : "5g", "description" : "description", "last_modified_time" : "2020-09-01T01:37:01Z", "created_time" : "2020-09-01T01:37:01Z", "last_online_time" : "2020-11-01T01:37:01Z", "status" : "OFFLINE" } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 参数说明:返回车辆的总体数量。 最小值:0 最大值:2147483647 vehicles Array of VehicleDTO objects 参数说明:数据列表。 表5 VehicleDTO 参数 参数类型 描述 vehicle_id String 参数说明:车辆唯一标识符。 取值范围:长度不超过128,只允许字母、数字、以及_-等字符的组合。 plate_no String 参数说明:车牌号。 取值范围:长度最小1最大64,支持中文、字母、数字、下划线(_)、横杠(-)的组合。 vin String 参数说明:VIN码,车辆的17位VIN码。 取值范围:长度不超过17,只允许字母、数字字符的组合。 最大长度:17 obu_id String "参数说明:车载OBU的唯一标识。 取值范围:长度不超过128,只允许字母、数字、以及_-等字符的组合。 imei String 参数说明:IMEI,OBU上电子序列号。 取值范围:长度最小1最大255,支持纯数字的组合。 brand String 参数说明:车俩品牌。 取值范围:长度最小1最大64,支持中文、字母、数字、下划线(_)、横杠(-)的组合。 model String 参数说明:车牌型号。 取值范围:长度最小1最大64,支持字母、数字、下划线(_)、横杠(-)的组合。 style String 参数说明:车辆年款。 取值范围:长度最小1最大64,支持纯数字的组合。 fuel_type String 参数说明:定义车辆的燃料动力类。 取值范围: unknownFuel:未知 gasoline:汽油 ethanol:乙醇 diesel:柴油 electric:电动 hybrid:混合燃料类型 hydrogen:氢气 natGasLiquid:液化天然气 natGasComp:压缩天然气 propane:丙烷 color String 参数说明:车辆颜色。 取值范围: black:黑色 white:白色 gray:灰色 red:红色 blue:蓝色 yellow:黄色 orange:橙色 brown:棕色 green:绿色 purple:紫色 cyan:青色 pink:粉红色 transparent:透明色 other:其他 plate_color String 参数说明:车辆颜色。 取值范围: black:黑色 white:白色 blue:蓝色 yellow:黄色 green:绿色 access_type String 参数说明:车辆接入网络的方式。 取值范围: 5g 4g 3g 2g pc5Only pc5And5g pc5And4g pc5And3g pc5And2g description String 参数说明:描述。 取值范围:长度不超过2048,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最大长度:2048 last_modified_time String 参数说明:最后修改的时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z created_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 status String 参数说明:设备状态。 取值范围: ONLINE:在线 OFFLINE:离线 INITIAL:初始化
  • 请求示例 PUT https://{endpoint}/v1/{project_id}/vehicles/{vehicle_id}Content-Type:application/jsonX-Auth-Token:********Instance-Id:********{ "imei" : "imei", "brand" : "polo", "model" : "model", "style" : "2020", "fuel_type" : "gasoline", "color" : "blue", "plate_color" : "black", "access_type" : "5g", "description" : "description"}
  • 响应示例 状态码: 200 OK { "vehicle_id" : "13229397084005974033576909202199", "plate_no" : "粤B12345", "vin" : "vin121456", "obu_id" : "112412", "brand" : "polo", "model" : "model", "style" : "2020", "fuel_type" : "gasoline", "color" : "blue", "plate_color" : "black", "access_type" : "5g", "description" : "description", "status" : "INITIAL", "created_time" : "2022-01-06T09:30:24Z"}
  • 响应示例 状态码: 200 OK { "v2x_edge_id" : "ab6cb4ca-bc7a-4b3d-8629-7212c5d9a6b0", "name" : "name", "description" : "test", "esn" : "ESN01234567", "ip" : "127.0.0.1", "port" : "8880", "hardware_type" : "ATLAS", "position_description" : "testtest", "location" : { "lat" : 22.4, "lon" : 124 }, "cameras" : [ "ab6cb4ca-bc7a-4b3d-8629-7212c5d9a6b0" ], "radars" : [ "ab6cb4ca-bc7a-4b3d-8629-7212c5d9a6b0" ], "local_rsus" : [ "rsu_test_01" ], "edge_general_config" : { "avp_enabled" : true, "rsm_enabled" : true, "time_compensate" : true, "log_level" : false, "road_detection_length" : 10, "ramp_detection_length" : 10, "gat1400_username" : "dris_user", "user_name" : "dris_user" }, "edge_advance_config" : { "testKey" : "testValue" }, "status" : "ONLINE", "node_id" : "536434354358674544874543587", "created_time" : "2020-09-01T01:37:01Z", "last_modified_time" : "2020-09-01T01:37:01Z"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 v2x_edge_id String 参数说明:Edge ID,用于唯一标识一个Edge。 最小长度:0 最大长度:255 name String 参数说明:名称。 取值范围:长度不超过128,只允许中文、字母、数字、以及_.-等字符的组合。 最大长度:128 description String 参数说明:Edge描述。 最小长度:0 最大长度:255 esn String 参数说明:设备编码,全局唯一。 取值范围:长度不超过64,只允许字母、数字、以及_等字符的组合。 ip String 参数说明:网络I,例如127.0.0.1。 port Integer ITS800,ATLAS 端口号 最小值:0 最大值:65535 hardware_type String 参数说明:硬件类型。 取值范围:ITS800 或者 ATLAS。 position_description String 参数说明:安装位置编码,由用户自定义。 取值范围:长度不低于1不超过128,只允许字母、数字、下划线(_)的组合。 location Location object 参数说明:经纬度坐标。 cameras Array of IdAndStatus objects 参数说明:Edge关联的摄像头列表。 radars Array of IdAndStatus objects 参数说明:Edge关联的雷达列表。 local_rsus Array of IdAndStatus objects 参数说明:Edge关联的本地RSU列表。 edge_general_config EdgeGeneralConfigInResponse object 参数说明:Edge通用配置。 edge_advance_config Object 参数说明:Edge高级配置,Json格式 最大长度:4096 status String 参数说明:状态。 取值范围: UNINSTALLED: 待部署 INSTALLED:部署中 OFFLINE:离线 ONLINE:在线: UPGRADING:升级中 DELETING:删除中 channel_status String 参数说明:业务通道状态。 取值范围: ONLINE:在线 OFFLINE:离线 INITIAL:初始化 node_id String 参数说明:边缘管理服务返回的node_id,用于关联EdgeManager的资源。 最小长度:0 最大长度:255 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。 表4 Location 参数 参数类型 描述 lat Number 参数说明:定义纬度数值,北纬为正,南纬为负,单位°,精度小数点后7位。 最小值:-90 最大值:90 lon Number 参数说明:定义经度数值。东经为正,西经为负。单位°,精度小数点后7位。 最小值:-180 最大值:180 表5 IdAndStatus 参数 参数类型 描述 id String 参数说明:摄像头、雷达或RSU的ID。 最小长度:0 最大长度:255 status String 参数说明:摄像头、雷达或RSU的状态。 取值范围: ONLINE:在线 OFFLINE:离线 INITIAL:初始化 表6 EdgeGeneralConfigInResponse 参数 参数类型 描述 avp_enabled Boolean 参数说明:AVP场景。 rsm_enabled Boolean 参数说明:RSM上报:默认不上报。 time_compensate Boolean 参数说明:时延补偿:是否启动Edge时延补偿功能。 rsi_positioning_enabled Boolean 参数说明:RSI事件定位功能。 log_level String 参数说明:应用日志级别 取值范围:on/off,默认关闭。 缺省值:off road_detection_length Double 参数说明:道路检测长度,单位:米。 最小值:1 最大值:1000 ramp_detection_length Double 参数说明:匝道检测长度,单位:米。 最小值:1 最大值:1000 gat1400_username String 参数说明:1400接口用户名。 取值范围:长度不小于8,不大于32,只允许数字字母下划线组合,且不能以数字下划线开头,不能有中文和特殊字符,gat1400用户名不能与gat1400密码相同。 user_name String 参数说明:ITS800鉴权用的用户名和密码。 最小长度:0 最大长度:255
  • 响应示例 状态码: 200 ok { "count" : 1, "radars" : [ { "radar_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "name" : "radar00001", "v2x_edge_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "ip" : "127.0.0.1", "status" : "ONLINE", "esn" : "abcd00001", "position_description" : "k01", "created_time" : "2020-09-01T01:37:01Z", "last_modified_time" : "2020-09-01T01:37:01Z", "last_online_time" : "2020-09-01T01:37:01Z" } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 参数说明:总数 最小值:0 最大值:1000 radars Array of RadarResourceDTO objects 参数说明:数据列表 表5 RadarResourceDTO 参数 参数类型 描述 radar_id String 参数说明:雷达ID 取值范围:长度不小于1,不大于36的英文字母、数字和下划线(_)的组合。 最小长度:1 最大长度:36 name String 参数说明:名称 取值范围:长度不小于1,不大于128的汉字、英文字母、数字、下划线(_)和横杠(-)的组合。 v2x_edge_id String 参数说明:所属的EdgeId 取值范围:长度不小于1,不大于128的英文字母、数字、下划线(_)和横杠(-)的组合。 ip String 参数说明:设备IP status String 参数说明:状态值 取值范围: ONLINE:在线 OFFLINE:离线 UNKNOWN:未知 SLEEP:睡眠 esn String 参数说明:设备编号 取值范围:长度不小于1,不大于64的英文字母、数字和下划线(_)的组合。 position_description String 参数说明:位置描述 取值范围:长度不小于1,不大于128的英文字母、数字和下划线(_)的组合。 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
  • 概述 欢迎使用路网数字化服务(Digital Road Infrastructure Service,DRIS),本服务通过车路协同、物联网等智能技术,打造人、车、路、云的全面协同,构建协作式的智慧交通,使能协同式的自动驾驶,给出行者提供更安全、更高效、更便捷的出行,给管理者提供全路段感知、全天候通行、全过程管控的智慧运营。 您可以使用本文档提供的API对道路设备和感知事件等资源进行相关操作,如RSU资源管理、交通事件资源管理等,支持的全部操作请参见API概览。业务数据开放接口的数据集定义满足标准编号为YD/T 3709-2020的《基于LTE的车联网无线通信技术 消息层技术要求》以及标准编号为TCSAE 53-2017的《合作式智能运输系统 车用通信系统应用层及应用数据交互标准》的标准要求。 在调用DRIS API之前,请确保已经充分了解路网数字化服务相关概念,详细信息请参见产品介绍。 父主题: 使用前必读
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的帐号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-1”,您可以从地区和终端节点获取。 scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表格内容。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型(格式)。推荐用户使用默认值application/json,有其他取值时会在具体接口中专门说明。 是 application/json Instance-Id 路网数字化服务的实例ID,请参考获取Instance-Id获取实例ID。 否 部分接口调用要求必选。 c7ff8b76-9e6c-46c1-863e-a2225bb637ef project-id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 终端节点 终端节点(Endpoint)即调用API的请求地址,您可以直接访问地区和终端节点获取路网数字化服务的终端节点。 路网数字化服务的终端节点如下表所示,请您根据业务需要选择对应区域的终端节点。 表1 路网数字化服务的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京四 cn-north-4 ocv2x-api.cn-north-4.myhuaweicloud.com 父主题: 使用前必读
  • Token认证 Token是服务端生成的一串字符串,作为客户端进行请求的一个令牌。第一次登录后,服务器生成一个Token并将此Token返回给客户端,以后客户端只需带上这个Token前来请求数据即可,无需再次带上用户名和密码。Token有效期是24小时,从客户端获取开始算起(24小时是相对时间),需要使用同一个Token鉴权时,建议缓存起来使用,避免频繁调用。在Token过期前,务必刷新Token或重新获取Token,否则Token过期后会在服务端鉴权失败。 如果您获取Token多次,以最新的为准,前面的Token会被覆盖并失效。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxxxxxx" } } } } 加粗的斜体字段需要根据实际值填写,其中username为IAM用户名,domainname为IAM用户所属帐号名,********为IAM用户的登录密码,xxxxxxxxxxxxxxxxxx为IAM用户所属账号的项目名称,如“cn-north-1”,您可以参考我的凭证页面获取。 接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值为获取到的Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 POST https://ocv2x-api.cn-north-4.myhuaweicloud.com/v1/{project_id}/traffic-eventsContent-Type: application/json X-Auth-Token: ABCDEFJ....Instance-Id: xxxxxx 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • 响应消息体(可选) 该部分可选。响应消息体通常以结构化格式(如JSON或XML)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-1", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_code": "DRIS.01010002", "error_msg": "The RSU not found. "} 其中,error_code表示错误码,error_msg表示错误描述信息。error_msg值会变动,内容以实际情况为准。
  • 基本概念 帐号 用户注册时的帐号,帐号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于帐号是付费主体,为了确保帐号安全,建议您不要直接使用帐号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由帐号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 您可以在我的凭证下,您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中,您需要用到帐号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下,您可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 父主题: 使用前必读
  • URI POST /v1/{project_id}/v2x-edges/{v2x_edge_id}/deployment-code 表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参数 参数 参数类型 描述 rsu_model_id String 参数说明:RSU型号ID,用于唯一标识一个RSU型号,在平台创建RSU型号后由平台分配获得。 取值范围:长度不小于1不超过36,只允许字母、数字、连接符(-)的组合。 name String 参数说明: RSU型号名称。 取值范围:长度不低于1不超过64,只允许中文、字母、数字、下划线(_)、问号(?)、反引号(')、井号(#)、左小括号(()、右小括号())、点(.)、逗号(,)、与(&)、百分号(%)、At(@)、感叹号(!)、连接符(-)的组合。 manufacturer_name String 参数说明: RSU的厂商名称。 取值范围:长度不低于1不超过32,只允许中文、字母、数字、下划线(_)、问号(?)、反引号(')、井号(#)、左小括号(()、右小括号())、点(.)、逗号(,)、与(&)、百分号(%)、At(@)、感叹号(!)、连接符(-)的组合。 description String 参数说明: RSU型号的描述信息。 取值范围:长度不低于1不超过128,只允许中文、字母、数字、下划线(_)、问号(?)、反引号(')、井号(#)、左小括号(()、右小括号())、点(.)、逗号(,)、与(&)、百分号(%)、At(@)、感叹号(!)、连接符(-)的组合。 last_modified_time String 参数说明: RSU型号更新的时间。 格式:yyyy-MM-dd'T'HH:mm:ss'Z' 例如:2020-12-07T01:32:17Z created_time String 参数说明: 在平台创建RSU型号的时间。 格式:yyyy-MM-dd'T'HH:mm:ss'Z' 例如:2020-12-07T01:32:17Z
共100000条