获取镜像列表-DescribeImage

获取指定数据中心镜像列表,用户可通过指定操作系统类型,镜像Id进行过滤。

Request Parameters

Parameter nameTypeDescriptionRequired
Regionstring地域,参见 地域和可用区列表Yes
Zonestring可用区,参见 可用区列表No
ImageTypestring镜像类型。标准镜像:Base,镜像市场:Business, 自定义镜像:Custom,默认返回所有类型No
OsTypestring操作系统类型:Linux, Windows 默认返回所有类型No
ImageIdstring镜像IdNo
Offsetint列表起始位置偏移量,默认为0No
Limitint返回数据长度,默认为20No
PriceSetint是否返回价格:1返回,0不返回;默认不返回No
ProjectIdstring项目编号(子帐号用) 请参考GetProjectList接口No

Response Elements

Parameter nameTypeDescriptionRequired
RetCodeint操作返回码Yes
Actionstring操作名称Yes
TotalCountint满足条件的镜像总数No
ImageSetarray镜像列表详见 UHostImageSetNo

UHostImageSet

Parameter nameTypeDescriptionRequired
ImageIdstring镜像IDNo
ImageNamestring镜像名称No
Zonestring可用区,参见 可用区列表 No
OsTypestring操作系统类型:Liunx,WindowsNo
OsNamestring操作系统名称No
ImageTypestring镜像类型 标准镜像:Base, 行业镜像:Business,自定义镜像:CustomNo
Featuresarray特殊状态标识, 目前只有[NetEnhnced](高包量机型)No
FuncTypestring行业镜像类型(仅行业镜像将返回这个值)No
IntegratedSoftwarestring集成软件名称(仅行业镜像将返回这个值)No
Vendorstring供应商(仅行业镜像将返回这个值)No
Linksstring介绍链接(仅行业镜像将返回这个值)No
Statestring镜像状态, 可用:Available,制作中:Making, 不可用:UnavailableNo
ImageDescriptionstring镜像描述No
CreateTimeint创建时间,格式为Unix时间戳No
ImageSizeint镜像大小No

Request Example

http(s)://api.ucloud.cn/?Action=DescribeImage
&Region=cn-bj2
&Zone=cn-bj2-04
&ImageType=Base
&OsType=Windows

Response Example

{
    "Action": "DescribeImageResponse",
    "TotalCount": 1,
    "RetCode": 0,
    "ImageSet": [
        {
            "Zone": "cn-bj2-04",
            "ImageDescription": "Windows Server 2008 R2 Datacenter 32-bit",
            "OsName": "Windows 2008 32 位",
            "ImageId": "0b560b1d-f3b1-43de-a492-08875d79211b",
            "State": "Available",
            "ImageName": " Windows 2008 32 位",
            "OsType": "Windows",
            "CreateTime": 1234567890,
            "ImageType": "Base"
        }
    ]
}