调用该接口新增驱动版本。
限制条件
单阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateEdgeDriverVersion |
系统规定参数。取值:CreateEdgeDriverVersion。 |
DriverId | String | 是 | fec565038d7544978d9aed5c1a****** |
驱动ID。在边缘计算控制台的驱动管理页面中,鼠标悬浮在目标驱动名称上获取ID。 您也可以调用QueryEdgeDriver接口获取。 |
DriverVersion | String | 是 | 1.2.0 |
驱动版本号。必须是该驱动唯一的版本号,即一个驱动不可以设置两个相同的版本号。允许中文、英文字母、数字、下划线(_)、短划线(-)和英文句号(.),长度不超过64个字符。 |
EdgeVersion | String | 是 | 2.0.0 |
驱动适配的边缘版本,即该驱动只能在该边缘版本及以上版本的网关中运行。例如2.4.0,表示在v2.4.0及以上的边缘版本中运行该驱动。 |
Argument | String | 否 | -XX:+PrintGCDetails |
JVM(Java Virtual Machine)启动参数。 |
Description | String | 否 | Led驱动 |
驱动描述。长度不超过256个字节。 |
SourceConfig | String | 否 | {"ossAddress":"http://nova-scene-daily.oss-cn-shanghai.aliyuncs.com/driver/a8d6e4acc6941ecea8f0cfb30c******/ck3n3koe200003h6zf******.zip"} |
驱动代码来源配置。JSON格式字符串,格式如下: {"ossAddress":"http://***/driver_code.zip"}
其中, |
DriverConfig | String | 否 | [{"format":"JSON","content":"{\"defaultConfig\":\"this is default driver config demo\"}"}] |
驱动配置。JSON格式字符串,格式如下: {"format":"JSON","content":"{}"}
参数说明如下所示。
|
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
实例ID。公共实例不传此参数,企业版实例需传入。 |
ConfigCheckRule | String | 否 | {"deviceConfig":{"required":false},"driverConfig":{"required":false}} |
配置校验规则。JSON格式字符串,格式如下: {"deviceConfig":{"required":false},"driverConfig":{"required":false}
参数说明如下。
|
ContainerConfig | String | 否 | {"privileged":1,"devMappings":[],"volumeMappings":[],"hostNetworkMode":0,"portMappings":[]} |
容器配置。JSON格式字符串。更多信息,请参见本文下方ContainerConfig表格。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
ContainerConfig参数说明
名称 |
类型 |
是否必需 |
描述 |
---|---|---|---|
privileged |
Integer |
否 |
是否启动特权模式。 0:表示否。 1:表示是。 |
hostNetworkMode |
Integer |
否 |
是否使用宿主机host模式。 0:表示否。 1:表示是。 |
portMappings |
List |
否 |
网络端口映射。使用宿主机host模式时无须配置此项。最多可添加10个网络端口映射。格式请参考本文下方portMappings表格。 |
devMappings |
List |
否 |
设备映射。使用特权模式时无须配置此项。最多可添加10个设备映射。格式请参考本文下方devMappings表格。 |
volumeMappings |
List |
否 |
卷映射。最多可添加10个卷映射。格式请参考本文下方volumeMappings表格。 |
名称 |
类型 |
是否必需 |
描述 |
---|---|---|---|
hostPort |
Integer |
是 |
宿主机端口。端⼝取值范围为1~65535。 |
containerPort |
Integer |
是 |
容器内端口。端⼝取值范围为1~65535。 |
protocol |
Integer |
是 |
协议类型。取值有tcp和udp两种。 |
名称 |
类型 |
是否必需 |
描述 |
---|---|---|---|
hostPath |
String |
是 |
设备名称。需要以/dev/开头,长度为1~128个字符。 |
permission |
String |
是 |
读写权限。 ro:只读权限。 rw:读写权限。 |
comment |
String |
否 |
注释信息。长度为1~128个字符。 |
名称 |
类型 |
是否必需 |
描述 |
---|---|---|---|
hostPath |
String |
是 |
源路径。长度为1~128个字符,不支持空格。 |
containerPath |
String |
是 |
目的路径。须填写绝对路径,不支持根目录,以正斜杠(/)开头,长度为2~128个字符,不支持空格。 |
permission |
String |
是 |
读写权限。 ro:只读权限。 rw:读写权限。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | Success |
接口返回码。Success表示成功,其它表示错误码。详情请参见错误码。 |
ErrorMessage | String | request parameter error |
调用失败时,返回的出错信息。 |
RequestId | String | 001ADA35-8846-4B6F-93E7-E5C076F8BB56 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
表示是否调用成功。true表示调用成功,false表示调用失败。 |
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateEdgeDriverVersion
&ContainerConfig={"privileged":1,"devMappings":[],"volumeMappings":[],"hostNetworkMode":0,"portMappings":[]}
&DriverId=fec565038d7544978d9aed5c1a******
&Description=Led驱动
&DriverVersion=1.2.0
&Argument=-XX:+PrintGCDetails
&SourceConfig={"ossAddress":"http://nova-scene-daily.oss-cn-shanghai.aliyuncs.com/driver/a8d6e4acc6941ecea8f0cfb30c******/ck3n3koe200003h6zfgrxxlua.zip"}
&DriverConfig=[{"format":"JSON","content":"{\"defaultConfig\":\"this is default driver config demo\"}"}]
&EdgeVersion=2.0.0
&ConfigCheckRule={"deviceConfig":{"required":false},"driverConfig":{"required":false}}
&<公共请求参数>
正常返回示例
XML
格式
<CreateEdgeDriverVersionResponse>
<RequestId>001ADA35-8846-4B6F-93E7-E5C076F8BB56</RequestId>
<Code>Success</Code>
<Success>true</Success>
</CreateEdgeDriverVersionResponse>
JSON
格式
{
"RequestId": "001ADA35-8846-4B6F-93E7-E5C076F8BB56",
"Code": "Success",
"Success": true
}
错误码
访问错误中心查看更多错误码。