云主机接口

创建云服务器

接口方法: POST

url参数

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

post body参数

名称类型是否必须描述
OrderIdString订单Id 如果传入orderId 则创建请求失败后需要用户自己撤销订单
PayTypeEnum没有OrderId时必须计费类型 PostPaid: 后付费 PrePay: 预付费
PeriodIntegerPrepay必须预付费周期 取值范围1~12或24
AutoRenewPeriodIntegerPrepay可选自动续费周期 取值范围1~12或0 默认是0 即不自动续订
TerminateMethodEnum预付费实例到期策略 可选 删除DELETE 或者 转按量PERSIST
InstanceNameString云服务器名,3-64字符,数字或者中划线组成,以字母开头
ImageIdString镜像id
SpecTypeString云主机规格码,需要注意类型,以 small2 规格为例,标准型 n1 为 nvm.n1.small2,标准型 n2 为 nvm.n2.small2,具体参考实例类型
PasswordString云服务器系统管理员密码,8-30个字符,须同时包含大写字母,小写字母,数值和特殊符号中的一种以及以上。对linux主机无效。
KeyPairNamesList<Object>linux主机秘钥列表,对 windows 主机无效
PlacementObject云主机位置信息
VirtualPrivateCloudObject云主机所在网络Id,vpc网络必填,classic网络非必填。
SecurityGroupIdsList<String>安全组 ID 列表 当前只支持一个 ID。 VPC 环境下云主机必填。
AssociatePublicIpAddressBoolean是否分配生命周期IP
InternetMaxBandwidthInteger生命周期IP带宽
NetworkChargeTypeEnum生命周期IP计费方式 按带宽BANDWIDTH 或按流量TRAFFIC
DescriptionString主机描述 一百字符以内
PersonalityList<Object>用户自定义数据 仅linux云服务器支持 当前只支持注入一个自定义数据文件 文件内容不超过16K
GroupIdstring置换群组id

KeyPairNames参数

名称类型是否必须描述
nameString密钥名称
fingerprintString密钥指纹

Placement参数

名称类型是否必须描述
ZoneIdString主机所在AZ,以华东1为例,可用区 A 为 cn-east-1a,可用区 B 为 cn-east-1b

VirtualPrivateCloud参数

名称类型是否必须描述
VpcIdString云主机所在网络Id
SubnetIdString新版VPC必须新版VPC子网Id

Personality参数

名称类型是否必须描述
PathString用户自定义数据注入主机的路径
ContentsString用户注入的内容 文本大小不大于16K

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
OrderIdString订单Id
InstancesList云主机列表
RequestIdString请求Id

请求示例

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

-d '{
    "PayType": "PrePay",
    "Period": "6",
    "AutoRenewPeriod": "6",
    "InstanceName": "test",
    "ImageId": "97f3fd8c-fb5a-11e7-8dee-3200174de000",
    "SpecType": "nvm.n1.small2",
    "KeyPairNames": [{"name":"ssh-key1","fingerprint":"37:8c:98:14:85:41:3f:78:ac:ca:6f:31:10:d8:4a:f5"}],
    "Placement": {
        "ZoneId": "cn-east-1a"
    },

    "VirtualPrivateCloud": {
        "VpcId": "9c7fc4a1-fb5b-11e7-a988-3200174de000",
        "SubnetId": "a6af71c0-fb5b-11e7-b619-3200174de000"
    },
    "SecurityGroupIds": ["b0d2ed3a-fb5b-11e7-a31c-3200174de000"],

    "AssociatePublicIpAddress": true,
    "InternetMaxBandwidth": 100,
    "NetworkChargeType": "BANDWIDTH",
    "Description": "this is a demo"
}
'

返回示例

{
    "Instances": ["08220b8f-fb5f-11e7-99b3-3200174de000"],
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626"
}

启动云服务器

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:StartInstance
VersionStringAPI版本号 当前版本 2017-12-14
InstanceIdString云服务器uuid

返回参数

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

请求示例

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

返回示例

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

停止云服务器

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:StopInstance
VersionStringAPI版本号 当前版本 2017-12-14
InstanceIdString云服务器uuid

返回参数

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

请求示例

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

返回示例

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

重启云服务器

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:RebootInstance
VersionStringAPI版本号 当前版本 2017-12-14
InstanceIdString云服务器uuid

返回参数

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

请求示例

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

返回示例

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

修改云服务器信息

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:ModifyInstanceAttribute
VersionStringAPI版本号 当前版本 2017-12-14
InstanceIdString云服务器uuid
DescriptionStringbase64编码的字符串 编码前长度<100

返回参数

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

请求示例

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

返回示例

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

修改云服务器规格

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:ModifyInstanceSpec
VersionStringAPI版本号 当前版本 2017-12-14
InstanceIdString云服务器uuid
SpecTypeString云主机规格码
InternetMaxBandwidthInteger云主机生命周期IP带宽
NetworkChargeTypeString云主机生命周期IP计费方式
OrderIdString变配订单Id 如果填写订单Id 则订单规格需要和上述参数中的规格相同

返回参数

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

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=ModifyInstanceSpec&Version=2017-12-14
InstanceId=08220b8f-fb5f-11e7-99b3-3200174de000&SpecType=nvm.n1.large8&InternetMaxBandwidth=100

返回示例

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

删除云服务器

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:DeleteInstance
VersionStringAPI版本号 当前版本 2017-12-14
InstanceIdString云服务器uuid 仅允许删除按量计费云主机

返回参数

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

请求示例

https://open.cn-east-1.163yun.com/nvm?Action=DeleteInstance&Version=2017-12-14
&InstanceId=08220b8f-fb5f-11e7-99b3-3200174de000

返回示例

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

删除云服务器列表

接口方法: POST

url参数

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

post body参数

名称类型是否必须描述
InstancesList待删除的云主机列表

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
MessageString仅返回http status code非200时有效 指示详细错误信息
UnDeletedInstancesString如果只有部分删除成功则返回未删除的云服务器列表
RequestIdString请求Id

请求示例

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

-d {
    "Instances": [  
        "28bde8ef-2952-4c04-8afd-355b5c5712d2",  
        "2181e850-8134-4335-ab64-86b6e0ca589f"  
    ]  
}

返回示例

// 全部删除成功
{
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626"
}

// 部分删除成功
{
    "Code": "RequestFailed",
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626",
    "UndeletedInstances": [
        "f1a15c5b-03a9-4bd4-beac-890fa556d913",
        "89e856ae-2a4a-4476-986a-2f94087c7b72"
    ]
}

查询操作日志

接口方法: GET

url参数

名称类型是否必须描述
ActionString固定值:DescribeInstanceActionLogs
VersionStringAPI版本号 当前版本 2017-12-14
InstanceIdString云服务器uuid
LastLogIdint由于日志记录是按照操作时间倒序输出 这里允许制定查询指定logId之前的日志 该参数不填则默认从最新一条日志开始
Limitint查询结果每页结果数量 默认20
Offsetint查询结果起始序号 默认0

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
RequestIdString请求Id
ActionLogsList<Object>操作记录 按操作时间逆序排列
TotalCountint操作记录数量

ActionLogs参数

名称类型描述
LogIdString日志记录id
CreateAtString操作日志时间
ActionTypeString操作内容
ActionResultString操作结果

请求示例

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

返回示例

{
    "ActionLogs": [
        {
            "ActionResult": "成功",
            "ActionType": "创建镜像",
            "CreateAt": "2018-05-14T13:46:08Z",
            "LogId": 223846
        },
        {
            "ActionResult": "成功",
            "ActionType": "停机",
            "CreateAt": "2018-05-14T13:45:34Z",
            "LogId": 223845
        },
        {
            "ActionResult": "成功",
            "ActionType": "创建",
            "CreateAt": "2018-04-26T14:52:39Z",
            "LogId": 222579
        }
    ],
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626",
    "TotalCount": 5
}

查询云服务器列表

接口方法: POST

url参数

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

post body参数

名称类型是否必须描述
FilterObject查询条件 可选 默认为空 为空则返回所有有权限查看的主机列表

Filter参数

名称类型是否必须描述
NameList主机名称列表 支持模糊匹配
InstanceIdList主机Id列表 精确匹配
PrivateIpList私有网IP列表 精确匹配
VpcIdListVPC网络Id列表 精确匹配
SubnetIdListVPC网络子网Id列表 精确匹配
ZoneIdListAZ列表 精确匹配

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
RequestIdString请求Id
InstancesList<Object>查询到的云服务器信息列表
TotalCountint查询到的云服务器总数量

Instances参数

名称类型描述
InstanceIdString云服务器uuid
InstanceNameString云服务器名称
InstanceTypeString云服务器操作系统类型
ImageObject云服务器所使用的镜像
SpecTypeString云服务器规格
PayTypeString云服务器计费类型
PrivateIpAddressesList<String>云服务器私有网IP地址
EipAddressString云服务器浮动公网IP地址
PlacementObject云服务器AZ信息
VirtualPrivateCloudObject云服务器网络信息
PublicIpAddressesList<String>云服务器生命周期公网IP地址
StatusString云服务器状态
LockReasonString如果非正常停服 如欠费等 显示停服原因
CreateAtString云服务器创建时间

Image参数

名称类型描述
ImageIdString镜像Id
ImageNameString镜像名称
ImageTypeString镜像类型 Public or Private
OsTypeString操作系统类型 windows or linux
OsVersionString操作系统版本
DistributionString操作系统发行版本

Placement参数

名称类型描述
ZoneIdString云服务器所在AZ名称

VirtualPrivateCloud参数

名称类型描述
VpcIdString云服务器所在VPC网络Id
SubnetIdString云服务器所在VPC子网Id

AttachVolumes参数

名称类型描述
DiskNameString磁盘名称
DiskTypeString磁盘类型
DiskSizeint磁盘大小
DiskIdint磁盘Id
CreateTimeString创建时间
StatusString磁盘状态
DeviceString磁盘挂载路径(仅linux有效)

NetworkInterfaces参数

名称类型描述
NetworkInterfaceIdString网卡Id

请求示例

https://${address}/nvm?Action=DescribeInstanceList&Version=2017-12-14&Limit=20&Offset=0 

-d '{"Filter": {"Name": ["test"], "ZoneId": ["cn-east-1a"]}}'

返回示例

{
    "Instances": [
        {
            "CreateAt": "2017-12-11T13:20:11Z", 
            "InstanceId": "ab1f801c-d3d1-4819-b57c-f46479b66d11", 
            "InstanceName": "test3", 
            "InstanceType": "linux", 
            "Image": {
                "Distribution": "ubuntu",
                "ImageId": "62faa9c9-5afe-4f0d-b073-e5e7eb468a83",
                "ImageName": "Ubuntu 16.04 64\u4f4d",
                "ImageType": "Public",
                "OsType": "linux",
                "OsVersion": "16.04"
            },
            "Placement": {
                "ZoneId": "cn-east-1a"
            }, 
            "PayType": "PostPaid", 
            "PrivateIpAddresses": [
                "10.18.192.40"
            ], 
            "SpecType": "nvm.n1.large8",
            "Status": "ACTIVE"
        }, 
        {
            "CreateAt": "2017-12-11T12:26:53Z", 
            "EipAddress": [
                "115.238.123.41"
            ], 
            "InstanceId": "03a64a87-9b92-464b-ae1e-1ac3b503b5e1", 
            "InstanceName": "test2", 
            "InstanceType": "linux", 
            "Image": {
                "Distribution": "ubuntu",
                "ImageId": "62faa9c9-5afe-4f0d-b073-e5e7eb468a83",
                "ImageName": "Ubuntu 16.04 64\u4f4d",
                "ImageType": "Public",
                "OsType": "linux",
                "OsVersion": "16.04"
            },
            "Placement": {
                "ZoneId": "cn-east-1a"
            }, 
            "PayType": "PostPaid", 
            "PrivateIpAddresses": [
                "10.18.192.39"
            ], 
            "SpecType": "nvm.n1.large8",
            "Status": "ACTIVE"
        }
    ], 
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626", 
    "TotalCount": 2
}

查询云服务器详细信息

所属服务

nvm

Action

DescribeInstance

Version

2017-12-14

Method

GET

描述

同步接口

请求参数

query

参数名称说明参数类型是否必填备注
InstanceId云服务器uuidstring
ActionDescribeInstancestring
Version2017-12-14string

返回参数

参数名称说明参数类型是否必填备注
Code仅返回http status code非200时有效 指示错误类型string
Message仅返回http status code非200时有效 指示详细错误信息string
RequestId请求Idstring
InstanceId云服务器uuidstring
InstanceName云服务器名称string
DnsRecordSetId云服务器DNS资源记录集Idstring
DnsZoneId云服务器DNS域Idstring
ReverseRecordSetId云服务器DNS反解资源记录集Idstring
ReverseZoneId云服务器DNS反解域Idstring
InstanceType云服务器操作系统类型string
SpecType云服务器规格string
Image云服务器所使用的镜像object详细信息见下表
PayType云服务器计费类型string
PrivateIpAddresses云服务器私有网IP地址array
EipAddress云服务器浮动公网IP地址string
KeyPairNameslinux云服务器秘钥列表array
Placement云服务器AZ信息object详细信息见下表
VirtualPrivateCloud云服务器网络信息object详细信息见下表
PublicIpAddresses云服务器生命周期公网IP地址array
NetworkChargeType云服务器生命周期公网IP计费类型string
InternetMaxBandwidth云服务器生命周期公网IP最大带宽string
Description云服务器描述信息string
Status云服务器状态string
LockReason如果非正常停服 如欠费等 显示停服原因string
CreateAt云服务器创建时间string
UpdateAt云服务器更新时间string
AttachVolumes云服务器挂载磁盘信息array详细信息见下表
NetworkInterfaces云服务器网卡信息array详细信息见下表

NetworkInterfaces

参数名称说明参数类型是否必填备注
NetworkInterfaceId网卡Idstring
Type类型(仅有主网卡primary)string
PrivateIpAddress云服务器私有网IP地址(主IP)string
EipAddress云服务器浮动公网IP地址(主IP绑定的弹性IP)string
SecondaryPrivateIpAddresses辅助IP集合array详细信息见下表

SecondaryPrivateIpAddresses

参数名称说明参数类型是否必填备注
SecondaryPrivateIpAddress辅助IP私有网地址string
EipAddress辅IP绑定的公网IPstring
CreateAt辅IP创建时间string
UpdateAt辅IP更新时间string

AttachVolumes

参数名称说明参数类型是否必填备注
DiskName磁盘名称string
DiskType磁盘类型string
DiskSize磁盘大小string
DiskId磁盘Idstring
CreateTime创建时间string
Status磁盘状态string
Device磁盘挂载路径(仅linux有效)string

VirtualPrivateCloud

参数名称说明参数类型是否必填备注
VpcId云服务器所在VPC网络Idstring
SubnetId云服务器所在VPC子网Idstring

Placement

参数名称说明参数类型是否必填备注
ZoneId云服务器所在AZ名称string
ResourcePoolId云服务器所在资源池Idstring
ResourcePoolName云服务器所在资源名称string
Distributor资源池所属组织string

Image

参数名称说明参数类型是否必填备注
ImageId镜像Idstring
ImageName镜像名称string
ImageType镜像类型 Public or Privatestring
OsType操作系统类型 windows or linuxstring
OsVersion操作系统版本string
Distribution操作系统发行版本string

状态码

错误码(Code)错误提示(Message)http status code说明
RequestFailed请求失败400null
UnauthorizedOperation子帐号未授权403null
NoSuchInstance没有这个主机404null

请求示例

curl -X GET -H "X-Product-Id:0777ccfb14c84bb18cd819f92b9d7b24" -H "Content-Type:application/json" -H "X-Request-Id:TEST-REQUEST-ID" -H "X-163-AcceG0" -H "X-163-DebugMode:true" 'http://127.0.0.1:8188/nvm?Version=2017-12-14&Action=DescribeInstance&InstanceId=b4d5e41b-ef74-45a7-ab6d-9cb779b4049f'

返回示例

{
    "AttachVolumes": [], 
    "BreakdownStrategy": "None", 
    "CreateAt": "2019-02-18T09:00:51Z", 
    "Description "EipAddress": "60.191.82.189", 
    "Image": {
        "Distribution": "ubuntu", 
        "ImageId": "17da624b-04a2-4c1e-944e-815fd236d479", 
        "ImageName": "Ubuntu 14.04", 
        "ImageType": "Public", 
        "OsType": "linux", 
        "OsVersion": "14.04"
    }, 
    "InstanceId": "b4d5e41b-ef74-45a7-ab6d-9cb779b4049f", 
    "InstanceName": "testb", 
    "InstanceType": "linux", 
    "KeyPairNames": [
        "hyq-ci1"
    ], 
    "NetworkInterfaces": [
        {
	"NetworkInterfaceId": "54c408ae-17a2-4bf8-90ca-e8e26ea0496b", 
	"Type": "primary", 
	"PrivateIpAddress": "172.30.10.206", 
	"EipAddress": "60.191.82.189", 
  	"SecondaryPrivateIpAddresses": [
                {
		"SecondaryPrivateIpAddress": "172.30.10.202", 
		"EipAddress": "60.191.82.188", 
                "CreateAt": "2019-02-20T03:13:20Z", 
                "UpdateAt": "2019-02-20T03:13:20Z"
                }
            ], 
            
        }
    ], 
    "PayType": "PostPaid", 
    "Placement": {
        "ZoneId": "cn-east-1b"
    }, 
    "PrivateIpAddresses": [
        "172.30.10.206"
    ], 
    "RequestId": "TEST-REQUEST-ID", 
    "SecurityGroupIds": [
        "cf78a1be-d0da-4ff3-b5fa-5607ca209fb0"
    ], 
    "SpecType": "nvm.n2.small2", 
    "Status": "SHUTOFF", 
    "UpdateAt": "2019-02-20T03:04:59Z", 
    "VirtualPrivateCloud": {
        "SubnetId": "fb68cd77-1fc9-4c96-974e-7c6c5af7e855", 
        "VpcId": "5ff7584a-6e47-43a2-a498-a0258354516c"
    }
}

查询规格列表

接口方法: GET

url参数

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

返回参数

名称类型描述
CodeString仅返回http status code非200时有效 指示错误类型
MessageString仅返回http status code非200时有效 指示详细错误信息
FlavorsList<Object>规格信息列表
RequestIdString请求Id

Flavors参数

名称类型描述
FlavorIdString规格Id
SpecTypeString规格码
Vcpuintcpu数量
Memoryint内存大小 GB
Diskint系统盘大小 GB
Seriesint系列码
Typeint机型码
SupportOsList<String>规格支持的操作系统类型

请求示例

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

返回示例

{
    "RequestId": "d2025d02-7922-11e8-a014-f48e3886a626"
    "Flavors": [
        {
            "FlavorId": "32680009",
            "SpecType": "nvm.e2.large8",
            "Vcpu": 4,
            "Memory": 8192,
            "Disk": 80,
            "Series": 2,
            "Type": 4,
            "SupportOs": ["linux"]
        },
        {
            "FlavorId": "32680010",
            "SpecType": "nvm.e2.large8",
            "Vcpu": 4,
            "Memory": 8192,
            "Disk": 100,
            "Series": 2,
            "Type": 4,
            "SupportOs": ["linux"]
        },
    ]
}