调用DescribeAppVersion获取系统版本的详细信息。

说明 用户希望查看应用版本详情时,可以调用此接口获取版本详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAppVersion

系统规定参数。取值:DescribeAppVersion

ProjectId String P0VFCREU

项目ID

VersionId String 12345

版本ID

RegionId String cn-shanghai

地域ID

返回数据

名称 类型 示例值 描述
RequestId String 6F25F67C-F411-499F-BCE2-67CA563CB064

请求ID

AppVersion

版本基本信息

Adapters

应用版本的适配机型列表

DeviceModelId String 123

适配的设备型号ID

DeviceModelName String DM1

机型名

Id Long 1234

升级包的ID

MaxOsVersion String 2.0.1-R-20180412.0923

最高允许的系统版本号

MinOsVersion String 3.0.1-R-20180412.0923

最低允许的系统版本号

VersionId Long 12345

当前版本ID

ApkMd5 String 34653456wertwe234653retwewer3456

APK的MD5值

AppId String 12

应用ID

AppName String iovcc-ota

应用名称

AppVersion String 2.0.1

应用版本号

BlackVersionList String 10,20,30

版本黑名单,versioncode英文逗号拼接。

DownloadUrl String http://www.cdn-server.com/file.zip

升级包下载地址

GmtCreate String 2018-04-24 12:23:45

创建时间

GmtModify String 2018-04-24 12:23:45

更新时间

Id Long 12345

版本ID

InstallType String auto

应用升级包安装方式。取值:auto / customize

IsAllowNewInstall String Y

当客户端不存在该应用时,服务端是否允许返回该应用版本,取值:Y | N

IsForceUpgrade String N

是否强制升级,取值:Y | N

IsNeedRestart String N

是否需要重启,取值:Y | N

IsSilentUpgrade String N

是否静默升级,取值:Y | N

Md5 String 345adsff2094asas2345et3

升级包MD5

OriginalUrl String http://www.oss-server.com/file.zip

升级包原始地址

PackageName String com.aliyun.iovcc.ota

应用包名

ReleaseNote String sample release note

版本发布说明

Remark String sample remark

版本备注信息,终端设备不可见。

RestartAppParam String k1:v1

应用重启参数

RestartAppType String activity

如果restartType为应用重启,则这个字段表示应用重启的类型。取值:

  • service:表示Service重启
  • activity:表示Activity重启
RestartType String app

应用安装完成后的重启类型,取值:

  • system:表示系统重启
  • app:表示应用重启
Size String 1204560

升级包大小,字节为单位

Status String PUBLISHED

应用版本状态,状态定义和系统版本一致。

StatusName String 已发布

版本状态的中文名

VersionCode Long 201

应用版本versioncode,用于版本升级比较大小的逻辑。

WhiteVersionList String 10,20,30

版本白名单,versioncode英文逗号拼接。

示例

请求示例


http(s)://iovcc.cn-shanghai.aliyuncs.com/?Action=DescribeAppVersion
&ProjectId=P0VFCREU
&VersionId=12345
&<公共请求参数>

正常返回示例

XML 格式

<DescribeAppVersionResponse>
	  <AppVersion>
		    <Adapters>
			      <DeviceModelId>10</DeviceModelId>
			      <Id>100010</Id>
			      <MaxOsVersion>3.0.1-R-20180412.0923</MaxOsVersion>
			      <MinOsVersion>2.0.1-R-20180412.0923</MinOsVersion>
			      <VersionId>123</VersionId>
		    </Adapters>
		    <ApkMd5>645adsff2094asas2345et8</ApkMd5>
		    <AppId>12</AppId>
		    <AppName>iovcc-ota</AppName>
		    <AppVersion>2.0.1</AppVersion>
		    <BlackVersionList></BlackVersionList>
		    <DownloadUrl>http://www.cdn-server.com/file.zip</DownloadUrl>
		    <GmtCreate>2018-04-24 12:23:45</GmtCreate>
		    <GmtModify>2018-04-24 12:23:45</GmtModify>
		    <Id>123</Id>
		    <InstallType>auto</InstallType>
		    <IsAllowNewInstall>N</IsAllowNewInstall>
		    <IsDisableCheckMd5>N</IsDisableCheckMd5>
		    <IsForceUpgrade>N</IsForceUpgrade>
		    <IsNeedRestart>N</IsNeedRestart>
		    <IsSilentUpgrade>N</IsSilentUpgrade>
		    <Md5>345adsff2094asas2345et3</Md5>
		    <OriginalUrl>http://www.oss-server.com/file.zip</OriginalUrl>
		    <PackageName>com.aliyun.iovcc.ota</PackageName>
		    <ReleaseNote>sample release note</ReleaseNote>
		    <Remark>sample remark</Remark>
		    <RestartAppParam>k1:v1</RestartAppParam>
		    <RestartAppType>N</RestartAppType>
		    <RestartType>system</RestartType>
		    <Size>12234523</Size>
		    <Status>PUBLISHED</Status>
		    <StatusName>已发布</StatusName>
		    <VersionCode>201</VersionCode>
		    <WhiteVersionList></WhiteVersionList>
	  </AppVersion>
	  <RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>
</DescribeAppVersionResponse>

JSON 格式

{
	"AppVersion":{
		"Md5":"345adsff2094asas2345et3",
		"RestartType":"system",
		"IsForceUpgrade":"N",
		"ReleaseNote":"sample release note",
		"AppId":"12",
		"IsDisableCheckMd5":"N",
		"IsSilentUpgrade":"N",
		"RestartAppParam":"k1:v1",
		"WhiteVersionList":"",
		"StatusName":"已发布",
		"DownloadUrl":"http://www.cdn-server.com/file.zip",
		"AppName":"iovcc-ota",
		"IsAllowNewInstall":"N",
		"GmtModify":"2018-04-24 12:23:45",
		"Size":"12234523",
		"Adapters":[
			{
				"MaxOsVersion":"3.0.1-R-20180412.0923",
				"MinOsVersion":"2.0.1-R-20180412.0923",
				"VersionId":123,
				"Id":100010,
				"DeviceModelId":"10"
			}
		],
		"AppVersion":"2.0.1",
		"OriginalUrl":"http://www.oss-server.com/file.zip",
		"InstallType":"auto",
		"GmtCreate":"2018-04-24 12:23:45",
		"Status":"PUBLISHED",
		"BlackVersionList":"",
		"PackageName":"com.aliyun.iovcc.ota",
		"IsNeedRestart":"N",
		"RestartAppType":"N",
		"VersionCode":201,
		"Id":123,
		"Remark":"sample remark",
		"ApkMd5":"645adsff2094asas2345et8"
	},
	"RequestId":"6F25F67C-F411-499F-BCE2-67CA563CB064"
}

错误码

访问错误中心查看更多错误码。