Queries information about a driver version.
Limits
Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | GetEdgeDriverVersion |
The operation that you want to perform. Set the value to GetEdgeDriverVersion. |
DriverId | String | Yes | fec565038d7544978d9aed5c1a****** |
The ID of the driver. To obtain the driver ID, perform the following steps: Log on to the Link IoT Edge console. On the Drivers page, move the pointer over the name of the driver whose version information you want to query and obtain the driver ID. You can also call the QueryEdgeDriver operation to query the driver ID. |
DriverVersion | String | Yes | 1.2.0 |
The version number of the driver. |
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** |
The ID of the Internet of Things (IoT) service instance. This parameter is not required for the public instance but required for Enterprise Edition instances. |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information about common request parameters, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | Success |
The return code of the operation. A value of Success indicates that the call was successful. Other values indicate that specific errors occurred. For more information, see Error codes. |
Data | Struct |
The data that is returned if the call was successful. |
|
Argument | String | -XX:+PrintGCDetails |
The Java Virtual Machine (JVM) startup parameter. |
ConfigCheckRule | String | {\"deviceConfig\":{\"required\":false},\"driverConfig\":{\"required\":false}} |
The rule for verifying configurations. The value is a JSON string in the following format: {"deviceConfig":{"required":false},"driverConfig":{"required":false}
The JSON string contains the following parameters:
|
ContainerConfig | String | {\"devMappings\":[],\"hostNetworkMode\":0,\"portMappings\":[],\"privileged\":1,\"volumeMappings\":[]} |
The configuration of the container where the driver runs. The value is a JSON string. For more information about parameters in the JSON string, see the following parameter description of ContainerConfig. |
Description | String | LED driver |
The description of the driver. |
DriverConfig | String | [{\"content\":\"{\\\"defaultConfig\\\":\\\"this is default driver config demo\\\"}\",\"format\":\"JSON\"}] |
The configuration of the driver. The value is a JSON string in the following format: {"format":"JSON","content":"{}"}
The JSON string contains the following parameters:
|
DriverId | String | fec565038d7544978d9aed5c1a****** |
The ID of the driver. |
DriverVersion | String | 1.2.0 |
The version number of the driver. |
EdgeVersion | String | 2.0.0 |
The earliest version of Link IoT Edge that is supported by the driver. |
GmtCreateTimestamp | Long | 1581912859713 |
The UNIX timestamp when the driver was created. |
GmtModifiedTimestamp | Long | 1581912859713 |
The last UNIX timestamp when the driver was updated. |
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******\"} |
The source of the driver code. The value is a JSON string in the following format: {"ossAddress":"http://***/driver_code.zip","temporaryOssAddress":"http://***/driver_code.zip?Expires***"}
In the JSON string, |
VersionState | String | 0 |
The status of the driver version. Valid values:
|
ErrorMessage | String | request parameter error |
The error message that is returned if the call failed. |
RequestId | String | 6ECE664B-E670-47BA-A6AD-62B9F35E3A7B |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful. A value of true indicates that the call was successful. A value of false indicates that the call failed. |
Parameter description of ContainerConfig
Parameter |
Type |
Description |
---|---|---|
privileged |
Integer |
Indicates whether the privilege mode was enabled for the container. Valid values: 0: disabled 1: enabled |
hostNetworkMode |
Integer |
Indicates whether the host mode was enabled for the container. Valid values: 0: disabled 1: enabled |
portMappings |
List |
The mapping of network ports. For more information about specific parameters, see the following parameter description of portMappings. |
devMappings |
List |
The mapping of devices. For more information about specific parameters, see the following parameter description of devMappings. |
volumeMappings |
List |
The mapping of volumes. For more information about specific parameters, see the following parameter description of volumeMappings. |
Parameter |
Type |
Description |
---|---|---|
hostPort |
Integer |
The port number of the host where the container resides. |
containerPort |
Integer |
The port number of the container. |
protocol |
Integer |
The type of the protocol that is used for communication between the mapping ports. Valid values: tcp and udp. |
Parameter |
Type |
Description |
---|---|---|
hostPath |
String |
The name of the device that the driver needs to access. |
permission |
String |
The permissions that the driver has for the device. Valid values: ro: The driver has only the read permissions for the device. rw: The driver has both the read and write permissions for the device. |
comment |
String |
The remarks for the mapping. |
Parameter |
Type |
Description |
---|---|---|
hostPath |
String |
The host path of the volume that the driver needs to access. |
containerPath |
String |
The path for accessing the volume in the container. |
permission |
String |
The permissions that the driver has for the volume. Valid values: ro: The driver has only the read permissions for the volume. rw: The driver has both the read and write permissions for the volume. |
Examples
Sample requests
http(s)://iot.cn-shanghai.aliyuncs.com/? Action=GetEdgeDriverVersion
&DriverId=fec565038d7544978d9aed5c1a******
&DriverVersion=1.2.0
&<Common request parameters>
Sample success responses
XML
format
<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 driver</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
format
{
"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 driver",
"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
}
Error codes
For a list of error codes, visit the API Error Center.