调用该接口查询驱动某一版本的信息。
限制条件
单阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetEdgeDriverVersion |
系统规定参数。取值:GetEdgeDriverVersion。 |
DriverId | String | 是 | fec565038d7544978d9aed5c1a****** |
驱动ID。在边缘计算控制台的驱动管理页面中,鼠标悬浮在目标驱动名称上获取ID。 您也可以调用QueryEdgeDriver接口获取。 |
DriverVersion | String | 是 | 1.2.0 |
驱动版本号。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
实例ID。公共实例不传此参数,企业版实例需传入。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | Success |
接口返回码。Success表示成功,其它表示错误码。详情请参见错误码。 |
Data | Struct |
调用成功时,返回的数据。 |
|
Argument | String | -XX:+PrintGCDetails |
JVM(Java Virtual Machine)启动参数。 |
ConfigCheckRule | String | {\"deviceConfig\":{\"required\":false},\"driverConfig\":{\"required\":false}} |
配置校验规则。JSON格式字符串,格式如下: {"deviceConfig":{"required":false},"driverConfig":{"required":false}
参数说明如下。
|
ContainerConfig | String | {\"devMappings\":[],\"hostNetworkMode\":0,\"portMappings\":[],\"privileged\":1,\"volumeMappings\":[]} |
容器配置。JSON格式字符串,参数说明,请参见本文下方ContainerConfig表格。 |
Description | String | Led驱动 |
驱动描述。 |
DriverConfig | String | [{\"content\":\"{\\\"defaultConfig\\\":\\\"this is default driver config demo\\\"}\",\"format\":\"JSON\"}] |
驱动配置。JSON格式字符串,格式如下: {"format":"JSON","content":"{}"}
参数说明如下所示。
|
DriverId | String | fec565038d7544978d9aed5c1a****** |
驱动ID。 |
DriverVersion | String | 1.2.0 |
驱动版本号。 |
EdgeVersion | String | 2.0.0 |
驱动适配的边缘版本。 |
GmtCreateTimestamp | Long | 1581912859713 |
创建驱动的Unix时间戳。 |
GmtModifiedTimestamp | Long | 1581912859713 |
最后一次更新驱动的Unix时间戳。 |
SourceConfig | String | {\"ossAddress\":\"http://nova-scene-daily.oss-cn-shanghai.aliyuncs.com/driver/a8d6e4acc6941ecea8f0cfb30******/ck3n3koe200003h6zfg******.zip\",\"temporaryOssAddress\":\"http://nova-scene-daily.oss-cn-shanghai.aliyuncs.com/driver/a8d6e4acc6941ecea8f0cfb30******/ck3n3koe200003h6zf******.zip?Expires\u003d1575******\u0026OSSAccessKeyId\u003daS4MT0IYrP******\u0026Signature\u003dm6cpmcaB8rm3YfbkhTYgb0******\"} |
驱动代码来源配置。JSON格式字符串,格式如下: {"ossAddress":"http://***/driver_code.zip","temporaryOssAddress":"http://***/driver_code.zip?Expires***"}
其中, |
VersionState | String | 0 |
驱动版本状态。
|
ErrorMessage | String | request parameter error |
调用失败时,返回的出错信息。 |
RequestId | String | 6ECE664B-E670-47BA-A6AD-62B9F35E3A7B |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
表示是否调用成功。true表示调用成功,false表示调用失败。 |
ContainerConfig参数说明
名称 |
类型 |
描述 |
---|---|---|
privileged |
Integer |
是否启动特权模式。 0:表示否。 1:表示是。 |
hostNetworkMode |
Integer |
是否使用宿主机host模式。 0:表示否。 1:表示是。 |
portMappings |
List |
网络端口映射。格式请参考本文下方portMappings表格。 |
devMappings |
List |
设备映射。格式请参考本文下方devMappings表格。 |
volumeMappings |
List |
卷映射。格式请参考本文下方volumeMappings表格。 |
名称 |
类型 |
描述 |
---|---|---|
hostPort |
Integer |
宿主机端口。 |
containerPort |
Integer |
容器内端口。 |
protocol |
Integer |
协议类型。取值有tcp和udp两种。 |
名称 |
类型 |
描述 |
---|---|---|
hostPath |
String |
设备名称。 |
permission |
String |
读写权限。 ro:只读权限。 rw:读写权限。 |
comment |
String |
注释信息。 |
名称 |
类型 |
描述 |
---|---|---|
hostPath |
String |
源路径。 |
containerPath |
String |
目的路径。 |
permission |
String |
读写权限。 ro:只读权限。 rw:读写权限。 |
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetEdgeDriverVersion
&DriverId=fec565038d7544978d9aed5c1a******
&DriverVersion=1.2.0
&<公共请求参数>
正常返回示例
XML
格式
<GetEdgeDriverVersionResponse>
<RequestId>6ECE664B-E670-47BA-A6AD-62B9F35E3A7B</RequestId>
<Data>
<ContainerConfig>{"devMappings":[],"hostNetworkMode":0,"portMappings":[],"privileged":1,"volumeMappings":[]}</ContainerConfig>
<GmtCreate>2019-12-01 22:28:01</GmtCreate>
<DriverId>fec565038d7544978d9aed5c1a******</DriverId>
<Description>Led驱动</Description>
<DriverVersion>1.2.0</DriverVersion>
<SourceConfig>{"ossAddress":"http://nova-scene-daily.oss-cn-shanghai.aliyuncs.com/driver/a8d6e4acc6941ecea8f0cfb30******/ck3n3koe200003h6zf******.zip","temporaryOssAddress":"http://nova-scene-daily.oss-cn-shanghai.aliyuncs.com/driver/a8d6e4acc6941ecea8f0cfb30******/ck3n3koe200003h6zf******.zip?Expires=1575******&OSSAccessKeyId=aS4MT0IYrPSPj6******;Signature=m6cpmcaB8rm3YfbkhTYgb0W******"}</SourceConfig>
<GmtModified>2019-12-01 22:28:01</GmtModified>
<DriverConfig>[{"content":"{\"defaultConfig\":\"this is default driver config demo\"}","format":"JSON"}]</DriverConfig>
<EdgeVersion>2.0.0</EdgeVersion>
<ConfigCheckRule>{"deviceConfig":{"required":false},"driverConfig":{"required":false}}</ConfigCheckRule>
<VersionState>0</VersionState>
</Data>
<Code>Success</Code>
<Success>true</Success>
</GetEdgeDriverVersionResponse>
JSON
格式
{
"RequestId": "6ECE664B-E670-47BA-A6AD-62B9F35E3A7B",
"Data": {
"ContainerConfig": "{\"devMappings\":[],\"hostNetworkMode\":0,\"portMappings\":[],\"privileged\":1,\"volumeMappings\":[]}",
"GmtCreate": "2019-12-01 22:28:01",
"DriverId": "fec565038d7544978d9aed5c1a******",
"Description": "Led驱动",
"DriverVersion": "1.2.0",
"SourceConfig": "{\"ossAddress\":\"http://nova-scene-daily.oss-cn-shanghai.aliyuncs.com/driver/a8d6e4acc6941ecea8f0cfb30******/ck3n3koe200003h6zfg******.zip\",\"temporaryOssAddress\":\"http://nova-scene-daily.oss-cn-shanghai.aliyuncs.com/driver/a8d6e4acc6941ecea8f0cfb30******/ck3n3koe200003h6zf******.zip?Expires\u003d1575******\u0026OSSAccessKeyId\u003daS4MT0IYrP******\u0026Signature\u003dm6cpmcaB8rm3YfbkhTYgb0******\"}",
"GmtModified": "2019-12-01 22:28:01",
"DriverConfig": "[{\"content\":\"{\\\"defaultConfig\\\":\\\"this is default driver config demo\\\"}\",\"format\":\"JSON\"}]",
"EdgeVersion": "2.0.0",
"ConfigCheckRule": "{\"deviceConfig\":{\"required\":false},\"driverConfig\":{\"required\":false}}",
"VersionState": 0
},
"Code": "Success",
"Success": true
}
错误码
访问错误中心查看更多错误码。