全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

描述镜像信息

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数
参数名称
类型
必填
描述
Action String
公共参数,本接口取值:DescribeImages。
Version String
公共参数,本接口取值:2016-03-04。
ImageId String

镜像ID。 b1e3731b-c200-4499-be42-f6bfbbda990e。

ImageType String

镜像分类。 system

返回参数

参数名称
类型
描述
RequestId String
示例值:3ce9fdc9-dd6a-4685-acaf-9075018828002
ImagesSet Object[]
ImageId String
示例值:31c78c89-98bd-4d5b-8ddf-7eff4622cc
InstantAccess Boolean
ContainerFormat String

如果是标准镜像,值为ovf;如果是自定义镜像,值为assembled_image

示例值:assembled_image
SnapshotSet Object[]
SnapshotId String
示例值:5432
DiskType String
示例值:xx
DiskSize Int
示例值:20
Type String
示例值:xx
VolumeType String
示例值:xx
AvailabilityZone String
示例值:xx
ExportingStatus String
示例值:sxs
ExportingFinishedTime String
示例值:66
Type String

镜像类型 ,枚举值:标准镜像 自定义镜像

示例值:CommonImage
Name String
示例值:ksyun_centos65_performance
ImageState String

镜像状态

示例值:active
CreationDate String
示例值:2018-07-17T20:48:25Z
Platform String

版本号

示例值:centos-6.5
IsPublic Boolean
InstanceId String
示例值:529cda4f-767b-4ccb-ae-f8c25db339
IsNpe Boolean

是否是网络增强型镜像

UserCategory String

镜像类别标识,标识镜像是普通镜像还是导入的镜像还是云市场镜像等。取值,常用的有common、import、copy

示例值:common
SysDisk Int
示例值:20
Progress String

任务进度

示例值:100
ImageSource String

镜像来源 ,枚举值:import copy share
extend system

示例值:share
CloudInitSupport Boolean

是否支持CloudInit

Ipv6Support Boolean

镜像是否支持ipv6

IsModifyType Boolean

镜像是否支持热升配标识

Architecture String
示例值:xx
FastBoot Boolean

是否预热

OriginalImageId String
示例值:7a29dd28-509f-4306-b10b-08ae5a66
IsCloudMarket Boolean

是否是市场镜像

RealImageId String

底层imageid 映射

示例值:31c78c89-98bd-4d5b-8ddf-7eff4602cc
OnlineExpansion Boolean

是否支持在线扩容

ImageMode String

主机启动方式:枚举值:uefi;legacy

示例值:legacy

请求示例

curl -X GET|POST
'http://kec.api.ksyun.com/?Action=DescribeImages&Version=2016-03-04'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/x-www-form-urlencoded'
-H 'host: kec.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'
-d 'ImageId=xxx&ImageType=xxx'

返回示例

JSON格式

{
"RequestId":"3ce9fdc9-dd6a-4685-acaf-9075018828002",
"ImagesSet":[
{
"ImageId":"31c78c89-98bd-4d5b-8ddf-7eff4622cc",
"InstantAccess":false,
"ContainerFormat":"ovf",
"SnapshotSet":[
{
"SnapshotId":"5432",
"DiskType":"xx",
"DiskSize":20,
"Type":"xx",
"VolumeType":"xx"
}
],
"AvailabilityZone":"xx",
"ExportingStatus":"sxs",
"ExportingFinishedTime":"66",
"Type":"CommonImage",
"Name":"ksyun_centos65_performance",
"ImageState":"active",
"CreationDate":"2018-07-17T20:48:25Z",
"Platform":"centos-6.5",
"IsPublic":false,
"InstanceId":"529cda4f-767b-4ccb-ae-f8c25db339",
"IsNpe":false,
"UserCategory":"common",
"SysDisk":20,
"Progress":"100",
"ImageSource":"share",
"CloudInitSupport":false,
"Ipv6Support":false,
"IsModifyType":false,
"Architecture":"xx",
"FastBoot":false,
"OriginalImageId":"7a29dd28-509f-4306-b10b-08ae5a66",
"IsCloudMarket":false,
"RealImageId":"31c78c89-98bd-4d5b-8ddf-7eff4602cc",
"OnlineExpansion":false
}
]
}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码
错误信息
Http状态码
描述
InternalErrorInternal Error400暂无
ImageIdInvalidParameterValueAn invalid or out-of-range value was supplied for the "ImageId" parameter.400“镜像ID”参数的取值无效或者超出有效范围
ServiceUnavailable{"RequestId":"e7ac5d05-79f1-4b7c-867d-b99ce8478587001","Error":{"Code":"ServiceUnavailable","Message":"I/O error on GET request for \"http://qdone.openstack.sdns.ksyun.com:6003/v2/images?property-_show_tasks\u003d1\u0026image_type\u003dsnapshot\u0026user_id\u003d297cc0ae94e741dfa342c32a0823a3cd\u0026sort_key\u003dcreated_at\u0026sort_dir\u003ddesc\u0026limit\u003d1000\u0026obscure\u003dtrue\u0026invisible\u003d0\": connect timed out"}}400
纯净模式常规模式

纯净模式

点击可全屏预览文档内容