调用DescribeOsVersion获取单个系统版本的详细信息。

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

调试

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

请求参数

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

系统规定参数。取值：DescribeOsVersion。

ProjectId String 是 P0VFCREU

项目ID
RegionId String 是 cn-shanghai

地域ID
VersionId Long 是 12345

版本ID

返回数据

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

请求ID
OsVersion

版本基本信息
BlackVersionList String 2.0.1,3.0.1

系统版本黑名单列表，英文逗号隔开。
DeviceModelId String 123

设备型号ID
DeviceModelName String DM1

机型名
GmtCreate String 2018-04-24 12:23:45

版本创建时间，格式：yyyy-MM-dd HH:mm:ss。

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

版本创建时间，格式：yyyy-MM-dd HH:mm:ss。

Id Long 12345

版本ID
IsForceNightUpgrade String N

是否强制夜间升级，Y或N；不允许和是否强制升级同时设置为Y。
IsForceUpgrade String N

是否强制升级，Y或N。
IsMilestone String Y

是否里程碑，Y或N。
MaxClientVersion String 200

允许的OTA SDK的最大版本versioncode。
MinClientVersion String 100

允许的OTA SDK的最小版本versioncode。
NightUpgradeOption

夜间升级选项
DownloadType String 1

夜间升级下载类型。

  • 1表示WIFI下下载。
  • 2表示任全网下载。
IsAllowedCancel String N

夜间升级是否允许取消，取值：Y或N。
IsShowTip String N

夜间升级时是否给出提示框，取值：Y或N。
ReleaseNote String 改用UI用户体验，提升系统稳定性

版本发布说明
Remark String 版本备注信息，终端设备不可见

备注
RomList

升级包列表
BaseVersion String 2.0.1-R-20180502.1205

基准系统版本，如果是全量包，则为空。
DownloadUrl String https://www.cdn-server.com/file.zip

升级包下载地址
GmtCreate String 2018-04-24 12:23:45

升级包创建时间，格式：yyyy-MM-dd HH:mm:ss。

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

升级包修改时间，格式：yyyy-MM-dd HH:mm:ss。

Id Long 100

升级包ID
Md5 String we3utrw4esdfgkhsdlfha

升级包MD5
OriginalUrl String http://www.oss-server.com/file.zip

升级包原始地址
Size String 10000

升级包大小，单位字节
SplitNum String 10

升级包分片数，10MB一个分片
VersionId Long 12345

升级包所属的版本ID
Status String PUBLISHED

版本状态，所有的状态有：

  • INITIAL：初始状态
  • CREATING：创建中
  • CREATE_FAILED：创建失败
  • CREATE_COMPLETED：创建完成
  • TESTING：测试中
  • TEST_PASSED：测试已通过
  • PREPUBLISHED：预发布
  • PUBLISHED：已发布
  • UNUSED：已废弃
  • FROZEN：已冻结
  • DOWN：已下架
StatusName String 已发布

版本状态的中文名
SystemVersion String 2.0.1-R-20180506.0824

系统版本号
WhiteVersionList String 2.0.1,3.0.1

系统版本白名单列表
EnableMobileDownload String Y

是否允许移动网络下载升级包
MobileDownloadMaxSize String 10

允许移动网络下载的包的最大限制，单位为M，在允许移动网络下载包的情况下，大于该限制的包也不会自动下载。

示例

请求示例


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

正常返回示例

XML 格式 

<DescribeOsVersionResponse>
	  <OsVersion>
		    <BlackVersionList>2.0.1,3.0.1</BlackVersionList>
		    <DeviceModelId>100</DeviceModelId>
		    <DeviceModelName>DM1</DeviceModelName>
		    <GmtCreate>2017-12-06 12:04:08</GmtCreate>
		    <GmtModify>2017-12-06 13:04:06</GmtModify>
		    <Id>123</Id>
		    <IsDisableCheckMd5>N</IsDisableCheckMd5>
		    <IsForceNightUpgrade>Y</IsForceNightUpgrade>
		    <IsForceReboot>N</IsForceReboot>
		    <IsForceUpgrade>N</IsForceUpgrade>
		    <IsMilestone>N</IsMilestone>
		    <IsSilentUpgrade>N</IsSilentUpgrade>
		    <MaxClientVersion>200</MaxClientVersion>
		    <MinClientVersion>100</MinClientVersion>
		    <NightUpgradeOption>
			      <DownloadType>1</DownloadType>
			      <IsAllowedCancel>N</IsAllowedCancel>
			      <IsShowTip>N</IsShowTip>
		    </NightUpgradeOption>
		    <ReleaseNote>sample release note</ReleaseNote>
		    <Remark>sample remark</Remark>
		    <RomList>
			      <BaseVersion>1.0.1-R-20180409.0612</BaseVersion>
			      <DownloadUrl>http://www.cdn-server.com/file.zip</DownloadUrl>
			      <GmtCreate>2017-12-06 12:04:08</GmtCreate>
			      <GmtModify>2017-12-06 12:04:08</GmtModify>
			      <Id>123</Id>
			      <Md5>234der456ere56dhwer45ty6eghr570</Md5>
			      <OriginalUrl>http://www.oss-server.com/file.zip</OriginalUrl>
			      <Size>123456</Size>
			      <SplitNum>20</SplitNum>
			      <VersionId>234</VersionId>
		    </RomList>
		    <Status>PUBLISHED</Status>
		    <StatusName>已发布</StatusName>
		    <SystemVersion>2.0.1-R-20180502.1208</SystemVersion>
		    <WhiteVersionList>2.0.1,3.0.1</WhiteVersionList>
	  </OsVersion>
	  <RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>
</DescribeOsVersionResponse>

JSON 格式 

{
	"RequestId":"6F25F67C-F411-499F-BCE2-67CA563CB064",
	"OsVersion":{
		"ReleaseNote":"sample release note",
		"IsForceUpgrade":"N",
		"DeviceModelName":"DM1",
		"IsDisableCheckMd5":"N",
		"NightUpgradeOption":{
			"DownloadType":"1",
			"IsShowTip":"N",
			"IsAllowedCancel":"N"
		},
		"IsSilentUpgrade":"N",
		"DeviceModelId":100,
		"GmtCreate":"2017-12-06 12:04:08",
		"IsMilestone":"N",
		"MaxClientVersion":"200",
		"Status":"PUBLISHED",
		"BlackVersionList":"2.0.1,3.0.1",
		"IsForceNightUpgrade":"Y",
		"RomList":[
			{
				"Md5":"234der456ere56dhwer45ty6eghr570",
				"SplitNum":20,
				"OriginalUrl":"http://www.oss-server.com/file.zip",
				"DownloadUrl":"http://www.cdn-server.com/file.zip",
				"VersionId":234,
				"Id":123,
				"BaseVersion":"1.0.1-R-20180409.0612",
				"GmtCreate":"2017-12-06 12:04:08",
				"Size":123456,
				"GmtModify":"2017-12-06 12:04:08"
			}
		],
		"WhiteVersionList":"2.0.1,3.0.1",
		"SystemVersion":"2.0.1-R-20180502.1208",
		"StatusName":"已发布",
		"Id":123,
		"MinClientVersion":"100",
		"Remark":"sample remark",
		"GmtModify":"2017-12-06 13:04:06",
		"IsForceReboot":"N"
	}
}

错误码

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