镜像接口

创建镜像

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:CreateImage
VersionStringAPI版本号 当前版本 2017-12-14
InstanceIdString云服务器uuid
ImageNameString新镜像名称 需要符合前端镜像名称规则
DescriptionString描述 一百字符以内 base64格式

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
RequestIdString请求Id
ImageIdString新创建的镜像Id

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=CreateImage&Version=2017-12-14
&InstanceId=92773b5f-b10e-4600-8f9b-91c0cb5579d3
&ImageName=test-new-api

返回示例

{
    "ImageId":"69479afd-6c7c-4a44-ad6c-bfc52595a989",
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626"
}

删除镜像

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:DeleteImage
VersionStringAPI版本号 当前版本 2017-12-14
ImageIdString镜像Id

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
RequestIdString请求Id

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=DeleteImage&Version=2017-12-14
&ImageId=a64e8f46-0f29-488a-a5a8-0a431d4ebaec

返回示例

{
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626"
}

查询镜像列表

接口方法: POST

url参数

名称类型是否必须描述
ActionString固定值:DescribeImages
VersionStringAPI版本号 当前版本 2017-12-14
Limitint查询结果每页结果数量 默认20
Offsetint查询结果起始序号 默认0

post body参数

名称类型是否必须描述
FilterObject查询条件

Filter参数

名称类型是否必须描述
ImageTypeList镜像类型 可选Private(私有镜像) Public(公共镜像) MarketPlace(第三方公共镜像) Shared(共享镜像) 精确匹配
OsTypeList镜像操作系统类型 可选windows和linux 精确匹配
ImageNameList镜像名称 模糊匹配
ImageIdList镜像Id 精确匹配

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
RequestIdString请求Id
ImagesList查询到的镜像信息列表
TotalCountint查询到的镜像数量

Images参数

名称类型描述
ImageIdString镜像Id
ImageNameString镜像名称
ImageTypeString镜像类型
TenantIdString镜像所属租户Id
OsTypeString镜像操作系统类型(windows/linux)
OsVersionString操作系统基础版本(例如Centos 7.3 )
DescriptionString镜像描述信息
DistributionString镜像发型版本 只对linux有效
StatusString镜像状态
CreateAtString镜像创建时间
PropertiesObject镜像属性 k-v对表示
ShareInfoList<Object>镜像共享信息 仅私有镜像有此字段

提示

针对自定义镜像,上述OsVersion默认为创建时父镜像的操作系统版本。 若您后期升级了内核,此信息可能不准确。

ShareInfo参数

名称类型描述
SharedAtString镜像共享时间
UserNameString接受共享镜像的用户名

镜像property说明

云主机镜像有些特殊属性通过properties字段返回,目前可能出现的property参数及value说明如下:

propertyvalue说明
safetytrue or false一般widows镜像使用 表示本镜像是否经过了安全加固
sriovtrue or false表示镜像是否支持网络增强 true表示镜像中增加了sriov网卡驱动
originString一般镜像市场镜像使用 表示镜像提供方
baseImageString一般镜像市场镜像使用 表示第三方镜像的基础镜像
localSystemDisktrue or false已废弃 原本用来表示镜像是否支持创建本地系统盘云主机 目前该选项已经转移到创建参数里
adminpasswdtrue or false已废弃 原本用来表示widows镜像是否可以设置初始admin密码 现在已经全部支持
distributionString已废弃 原本用来表示镜像的发行版本 目前镜像信息的Distribution已经有该作用 不需要单独设置一个属性

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=DescribeImages&Version=2017-12-14
&Limit=20
&Offset=0

-d '{"Filter": {"ImageName": ["test"], "OsType": ["linux"]}}

返回示例

{
    "Images": [
        {
            "CreateAt": "2017-03-27T06:35:32Z", 
            "Description": "",
            "Distribution": "ubuntu",
            "ImageId": "3c388532-1a8a-4d36-9c52-d4e0e08c3579",
            "ImageName": "test-image-2",
            "ImageType": "Private",
            "OsType": "linux",
            "OsVersion": "Centos 7.3",
            "Properties": {
                "distribution": "ubuntu"
            },
            "Status": "ACTIVE",
            "ShareInfo": [
                {
                    "SharedAt": "2017-03-27T06:35:32Z",
                    "UserName": "QATest1"
                },
                {
                    "SharedAt": "2017-04-20T09:25:02Z",
                    "UserName": "QATest2"
                }
            ]
            "TenantId": "4575f0f1063b484982bad09ddc5736c6"
        },
        {
            "CreateAt": "2017-03-27T06:35:32Z", 
            "Description": "",
            "Distribution": "ubuntu",
            "ImageId": "d73d6be2-8ca2-46e6-8a8a-ac95ff966034",
            "ImageName": "test-snap-image-sync",
            "ImageType": "Private",
            "OsType": "linux",
            "OsVersion": "Centos 7.3",
            "Properties": {
                "distribution": "ubuntu"
            },
            "Status": "ACTIVE",
            "ShareInfo": [
                {
                    "SharedAt": "2017-03-27T06:35:32Z",
                    "UserName": "QATest1"
                }
            ]
            "TenantId": "4575f0f1063b484982bad09ddc5736c6"
        }
    ],
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626",
    "TotalCount": 2
}

从镜像重建云主机

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:RebuildInstance
VersionStringAPI版本号 当前版本 2017-12-14
InstanceIdString云服务器uuid
ImageIdString镜像id 要求和当前云主机操作系统是同种类型 并支持当前主机的规格

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
RequestIdString请求Id

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=RebuildInstance&Version=2017-12-14
&InstanceId=92773b5f-b10e-4600-8f9b-91c0cb5579d3
&ImageId=92773b5f-b10e-4600-8f9b-91c0cb5579d3

返回示例

{
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626"
}

修改自定义镜像信息

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:ModifyImageAttribute
VersionStringAPI版本号 当前版本 2017-12-14
ImageIdString自定义镜像uuid
ImageNameString自定义镜像名称
DescriptionStringbase64编码的字符串 编码前长度<100

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
RequestIdString请求Id

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=ModifyImageAttribute&Version=2017-12-14
&ImageId=92773b5f-b10e-4600-8f9b-91c0cb5579d3
&Description=dGVzdCBuZXcgb3BlbmFwaQ==

返回示例

{
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626"
}

共享镜像

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:ShareImage
VersionStringAPI版本号 当前版本 2017-12-14
ImageIdString要共享的镜像Id
UserNameString镜像共享给的用户名

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
RequestIdString请求Id

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=ShareImage&Version=2017-12-14
&ImageId=28bde8ef-2952-4c04-8afd-355b5c5712d2&UserName=user1

返回示例

{
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626"
}

取消镜像共享

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:UnshareImage
VersionStringAPI版本号 当前版本 2017-12-14
ImageIdString要共享的镜像Id
UserNameString取消镜像共享的用户名

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
RequestIdString请求Id

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=UnshareImage&Version=2017-12-14
&ImageId=28bde8ef-2952-4c04-8afd-355b5c5712d2&UserName=user1

返回示例

{
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626"
}

查询镜像共享配额

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:DescribeShareImageQuota
VersionStringAPI版本号 当前版本 2017-12-14
ImageIdString镜像Id

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
ShareImageQuotaint镜像共享quota 默认50
ImageMemberCountint本镜像已经共享的用户数量
RequestIdString请求Id

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=DescribeShareImageQuota&Version=2017-12-14&ImageId=6d092bff-147d-4d69-9e68-439ddc6fdc30

返回示例

{
"ImageMemberCount":0,
"RequestId":"a9fa613b-afe8-474d-9c94-beff7a48be9c",
"ShareImageQuota":50}
}

查询镜像配额

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:DescribeImageQuota
VersionStringAPI版本号 当前版本 2017-12-14

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
ImageQuotaint镜像quota 默认20
ImageUsageint已经创建的镜像数量(不包括被共享的镜像)
RequestIdString请求Id

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=DescribeImageQuota&Version=2017-12-14

返回示例

{
    "ImageQuota": 100, 
    "ImageUsage": 9, 
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626"
}