镜像接口

创建镜像

接口方法: GET

url参数

名称	类型	是否必须	描述
Action	String	是	固定值：CreateImage
Version	String	是	API版本号当前版本 2017-12-14
InstanceId	String	是	云服务器uuid
ImageName	String	是	新镜像名称需要符合前端镜像名称规则
Description	String	否	描述一百字符以内 base64格式

返回参数

名称	类型	描述
Code	String	仅返回http status code非200时有效指示错误类型
Message	String	仅返回http status code非200时有效指示详细错误信息
RequestId	String	请求Id
ImageId	String	新创建的镜像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参数

名称	类型	是否必须	描述
Action	String	是	固定值：DeleteImage
Version	String	是	API版本号当前版本 2017-12-14
ImageId	String	是	镜像Id

返回参数

名称	类型	描述
Code	String	仅返回http status code非200时有效指示错误类型
Message	String	仅返回http status code非200时有效指示详细错误信息
RequestId	String	请求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参数

名称	类型	是否必须	描述
Action	String	是	固定值：DescribeImages
Version	String	是	API版本号当前版本 2017-12-14
Limit	int	否	查询结果每页结果数量默认20
Offset	int	否	查询结果起始序号默认0

post body参数

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

Filter参数

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

返回参数

名称	类型	描述
Code	String	仅返回http status code非200时有效指示错误类型
Message	String	仅返回http status code非200时有效指示详细错误信息
RequestId	String	请求Id
Images	List	查询到的镜像信息列表
TotalCount	int	查询到的镜像数量

Images参数

名称	类型	描述
ImageId	String	镜像Id
ImageName	String	镜像名称
ImageType	String	镜像类型
TenantId	String	镜像所属租户Id
OsType	String	镜像操作系统类型（windows/linux）
OsVersion	String	操作系统基础版本(例如Centos 7.3 ）
Description	String	镜像描述信息
Distribution	String	镜像发型版本只对linux有效
Status	String	镜像状态
CreateAt	String	镜像创建时间
Properties	Object	镜像属性 k-v对表示
ShareInfo	List<Object>	镜像共享信息仅私有镜像有此字段

提示

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

ShareInfo参数

名称	类型	描述
SharedAt	String	镜像共享时间
UserName	String	接受共享镜像的用户名

镜像property说明

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

property	value	说明
safety	true or false	一般widows镜像使用表示本镜像是否经过了安全加固
sriov	true or false	表示镜像是否支持网络增强 true表示镜像中增加了sriov网卡驱动
origin	String	一般镜像市场镜像使用表示镜像提供方
baseImage	String	一般镜像市场镜像使用表示第三方镜像的基础镜像
localSystemDisk	true or false	已废弃原本用来表示镜像是否支持创建本地系统盘云主机目前该选项已经转移到创建参数里
adminpasswd	true or false	已废弃原本用来表示widows镜像是否可以设置初始admin密码现在已经全部支持
distribution	String	已废弃原本用来表示镜像的发行版本目前镜像信息的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参数

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

返回参数

名称	类型	描述
Code	String	仅返回http status code非200时有效指示错误类型
Message	String	仅返回http status code非200时有效指示详细错误信息
RequestId	String	请求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参数

名称	类型	是否必须	描述
Action	String	是	固定值：ModifyImageAttribute
Version	String	是	API版本号当前版本 2017-12-14
ImageId	String	是	自定义镜像uuid
ImageName	String	否	自定义镜像名称
Description	String	否	base64编码的字符串编码前长度<100

返回参数

名称	类型	描述
Code	String	仅返回http status code非200时有效指示错误类型
Message	String	仅返回http status code非200时有效指示详细错误信息
RequestId	String	请求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参数

名称	类型	是否必须	描述
Action	String	是	固定值：ShareImage
Version	String	是	API版本号当前版本 2017-12-14
ImageId	String	是	要共享的镜像Id
UserName	String	是	镜像共享给的用户名

返回参数

名称	类型	描述
Code	String	仅返回http status code非200时有效指示错误类型
Message	String	仅返回http status code非200时有效指示详细错误信息
RequestId	String	请求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参数

名称	类型	是否必须	描述
Action	String	是	固定值：UnshareImage
Version	String	是	API版本号当前版本 2017-12-14
ImageId	String	是	要共享的镜像Id
UserName	String	是	取消镜像共享的用户名

返回参数

名称	类型	描述
Code	String	仅返回http status code非200时有效指示错误类型
Message	String	仅返回http status code非200时有效指示详细错误信息
RequestId	String	请求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参数

名称	类型	是否必须	描述
Action	String	是	固定值：DescribeShareImageQuota
Version	String	是	API版本号当前版本 2017-12-14
ImageId	String	是	镜像Id

返回参数

名称	类型	描述
Code	String	仅返回http status code非200时有效指示错误类型
Message	String	仅返回http status code非200时有效指示详细错误信息
ShareImageQuota	int	镜像共享quota 默认50
ImageMemberCount	int	本镜像已经共享的用户数量
RequestId	String	请求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参数

名称	类型	是否必须	描述
Action	String	是	固定值：DescribeImageQuota
Version	String	是	API版本号当前版本 2017-12-14

返回参数

名称	类型	描述
Code	String	仅返回http status code非200时有效指示错误类型
Message	String	仅返回http status code非200时有效指示详细错误信息
ImageQuota	int	镜像quota 默认20
ImageUsage	int	已经创建的镜像数量（不包括被共享的镜像）
RequestId	String	请求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"
}

热门搜索

数据分析及可视化

数据研发

数据治理

数据服务化

计算服务

网络服务

数据库

消息

存储与 CDN

管理与监控

其他

镜像接口

创建镜像

接口方法: GET

url参数

返回参数

请求示例

返回示例

删除镜像

接口方法: GET

url参数

返回参数

请求示例

返回示例

查询镜像列表

接口方法: POST

url参数

post body参数

返回参数

提示

镜像property说明

请求示例

返回示例

从镜像重建云主机

接口方法: GET

url参数

返回参数

请求示例

返回示例

修改自定义镜像信息

接口方法: GET

url参数

返回参数

请求示例

返回示例

共享镜像

接口方法: GET

url参数

返回参数

请求示例

返回示例

取消镜像共享

接口方法: GET

url参数

返回参数

请求示例

返回示例

查询镜像共享配额

接口方法: GET

url参数

返回参数

请求示例

返回示例

查询镜像配额

接口方法: GET

url参数

返回参数

请求示例

返回示例