CreateEdgeDriverVersion_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

限制条件

单阿里云账号调用该接口的每秒请求数(QPS)最大限制为 10。

说明 RAM 用户共享主账号配额。

流控信息

请求速率为10/1(s)。更多流控信息,请前往配额中心查看

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。公共实例不传此参数,企业版实例需传入。

示例值:iot_instc_pu****_c*-v64********
DriverIdstring

驱动 ID。在边缘计算控制台驱动管理页面中,鼠标悬浮在目标驱动名称上获取 ID。展开详情

示例值:fec565038d7544978d9aed5c1a******参考取值来源:
    QueryEdgeDriver
    CreateEdgeDriver
    BindDriverToEdgeInstance
    ReleaseEdgeDriverVersion
DriverVersionstring

驱动版本号。必须是该驱动唯一的版本号,即一个驱动不可以设置两个相同的版本号。允许中文、英文字母、数字、下划线(_)、短划线(-)和英文句号(.),长度不超过 64 个字符。

示例值:1.2.0参考取值来源:
    QueryEdgeDriverVersion
    ReleaseEdgeDriverVersion
EdgeVersionstring

驱动适配的边缘版本,即该驱动只能在该边缘版本及以上版本的网关中运行。例如 2.4.0,表示在 v2.4.0 及以上的边缘版本中运行该驱动。

示例值:2.0.0参考取值来源:
    GetEdgeDriverVersion
    QueryEdgeDriverVersion
Descriptionstring

驱动描述。长度不超过 256 个字节。

示例值:Led驱动
SourceConfigstring

驱动代码来源配置。JSON 格式字符串,格式如下:展开详情

示例值:{"ossAddress":"http://nova-scene-daily.oss-cn-shanghai.aliyuncs.com/driver/a8d6e4acc6941ecea8f0cfb30c******/ck3n3koe200003h6zf******.zip"}
DriverConfigstring

驱动配置。JSON 格式字符串,格式如下:展开详情

示例值:[{"format":"JSON","content":"{\"defaultConfig\":\"this is default driver config demo\"}"}]参考取值来源:
    GetEdgeDriverVersion
    QueryEdgeDriverVersion
    BatchGetEdgeInstanceDriverConfigs
ContainerConfigstring

容器配置。JSON 格式字符串。更多信息,请参见本文下方 ContainerConfig 表格。

示例值:{"privileged":1,"devMappings":[],"volumeMappings":[],"hostNetworkMode":0,"portMappings":[]}
ConfigCheckRulestring

配置校验规则。JSON 格式字符串,格式如下:展开详情

示例值:{"deviceConfig":{"required":false},"driverConfig":{"required":false}}
Argumentstring

JVM(Java Virtual Machine)启动参数。

示例值:-XX:+PrintGCDetails

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

ContainerConfig 参数说明

名称类型是否必需描述
privilegedInteger是否启动特权模式。
0:表示否。
1:表示是。
hostNetworkModeInteger是否使用宿主机 host 模式。
0:表示否。
1:表示是。
portMappingsList网络端口映射。使用宿主机 host 模式时无须配置此项。最多可添加 10 个网络端口映射。格式请参考本文下方 portMappings 表格。
devMappingsList设备映射。使用特权模式时无须配置此项。最多可添加 10 个设备映射。格式请参考本文下方 devMappings 表格。
volumeMappingsList卷映射。最多可添加 10 个卷映射。格式请参考本文下方 volumeMappings 表格。

portMappings 参数说明

名称类型是否必需描述
hostPortInteger宿主机端口。端⼝取值范围为 1~65535。
containerPortInteger容器内端口。端⼝取值范围为 1~65535。
protocolInteger协议类型。取值有 tcp 和 udp 两种。

devMappings 参数说明

名称类型是否必需描述
hostPathString设备名称。需要以**/dev/**开头,长度为 1~128 个字符。
permissionString读写权限。
ro:只读权限。
rw:读写权限。
commentString注释信息。长度为 1~128 个字符。

volumeMappings 参数说明

名称类型是否必需描述
hostPathString源路径。长度为 1~128 个字符,不支持空格。
containerPathString目的路径。须填写绝对路径,不支持根目录,以正斜杠(/)开头,长度为 2~128 个字符,不支持空格。
permissionString读写权限。
ro:只读权限。
rw:读写权限。

返回参数

字段名称字段详情
Codestring

接口返回码。Success 表示成功,其它表示错误码。详情请参见错误码

示例值:Success
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:request parameter error
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:001ADA35-8846-4B6F-93E7-E5C076F8BB56
Successboolean

表示是否调用成功。true 表示调用成功,false 表示调用失败。

示例值:true

返回示例

变更历史

暂无变更历史

相关示例