获取主机信息-DescribeUHostInstance
获取主机或主机列表信息,并可根据数据中心,主机ID等参数进行过滤。
Request Parameters
Parameter name | Type | Description | Required |
Region | string | 地域。 参见 地域和可用区列表 | Yes |
Zone | string | 可用区。参见 可用区列表 | No |
ProjectId | string | 项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口 | No |
UHostIds.N | string | 【数组】UHost主机的资源ID,例如UHostIds.0代表希望获取信息 的主机1,UHostIds.1代表主机2。 如果不传入,则返回当前Region 所有符合条件的UHost实例。 | No |
Tag | string | 要查询的业务组名称 | No |
Offset | int | 列表起始位置偏移量,默认为0 | No |
Limit | int | 返回数据长度,默认为20,最大100 | No |
IsolationGroup | string | 硬件隔离组id。通过硬件隔离组筛选主机。 | No |
VPCId | string | vpc id。通过VPC筛选主机。北京一地域无效。 | No |
SubnetId | string | 子网id。通过子网筛选主机。北京一地域无效。 | No |
Response Elements
Parameter name | Type | Description | Required |
RetCode | int | 返回码 | Yes |
Action | string | 操作名称 | Yes |
TotalCount | int | UHostInstance总数 | No |
UHostSet | array | 云主机实例列表,每项参数可见下面 UHostInstanceSet | No |
UHostInstanceSet
Parameter name | Type | Description | Required |
Zone | string | 可用区。参见 可用区列表 | No |
UHostId | string | UHost实例ID | No |
UHostType | string | 【建议不再使用】云主机机型(旧)。参考云主机机型说明。 | No |
MachineType | string | 云主机机型(新)。参考云主机机型说明。 | No |
StorageType | string | 【建议不再使用】主机磁盘类型。 枚举值为: > LocalDisk,本地磁盘; > UDisk 云盘。\\只要有一块磁盘为本地盘,即返回LocalDisk。 | No |
ImageId | string | 【建议不再使用】主机的系统盘ID。 | No |
BasicImageId | string | 基础镜像ID(指当前自定义镜像的来源镜像) | No |
BasicImageName | string | 基础镜像名称(指当前自定义镜像的来源镜像) | No |
Tag | string | 业务组名称 | No |
Remark | string | 备注 | No |
Name | string | UHost实例名称 | No |
State | string | 实例状态,枚举值: >初始化: Initializing; >启动中: Starting; \\> 运行中: Running; \\> 关机中: Stopping; >关机: Stopped >安装失败: Install Fail; >重启中: Rebooting | No |
CreateTime | int | 创建时间,格式为Unix时间戳 | No |
ChargeType | string | 计费模式,枚举值为: Year,按年付费; Month,按月付费; Dynamic,按需付费(需开启权限); | No |
ExpireTime | int | 到期时间,格式为Unix时间戳 | No |
CPU | int | 虚拟CPU核数,单位: 个 | No |
Memory | int | 内存大小,单位: MB | No |
AutoRenew | string | 是否自动续费,自动续费:“Yes”,不自动续费:“No” | No |
DiskSet | array | 磁盘信息见 UHostDiskSet | No |
IPSet | array | 详细信息见 UHostIPSet | No |
NetCapability | string | 网络增强。Normal: 无;Super: 网络增强1.0; Ultra: 网络增强2.0 | No |
NetworkState | string | 【建议不再使用】网络状态。 连接:Connected, 断开:NotConnected | No |
TimemachineFeature | string | 【建议不再使用】数据方舟模式。枚举值: > Yes: 开启方舟; > no,未开启方舟 | No |
HotplugFeature | bool | true: 开启热升级; false,未开启热升级 | No |
SubnetType | string | 【建议不再使用】仅北京A的云主机会返回此字段。基础网络模式:Default;子网模式:Private | No |
OsName | string | 创建主机的最初来源镜像的操作系统名称(若直接通过基础镜像创建,此处返回和BasicImageName一致) | No |
OsType | string | 操作系统类别。返回"Linux"或者"Windows" | No |
HostType | string | 【建议不再使用】主机系列:N2,表示系列2;N1,表示系列1 | No |
LifeCycle | string | 主机的生命周期类型。目前仅支持Normal:普通; | No |
GPU | int | GPU个数 | No |
BootDiskState | string | 系统盘状态 Normal表示初始化完成;Initializing表示在初始化。仍在初始化的系统盘无法制作镜像。 | No |
TotalDiskSpace | int | 总的数据盘存储空间。 | No |
IsolationGroup | string | 隔离组id,不在隔离组则返回"" | No |
UHostDiskSet
Parameter name | Type | Description | Required |
DiskType | string | 磁盘类型。请参考磁盘类型。 | Yes |
IsBoot | string | 是否是系统盘。枚举值: > True,是系统盘 > False,是数据盘(默认)。Disks数组中有且只能有一块盘是系统盘。 | Yes |
Encrypted | bool | true: 加密盘 false:非加密盘 | No |
Type | string | 【建议不再使用】磁盘类型。系统盘: Boot,数据盘: Data,网络盘:Udisk | No |
DiskId | string | 磁盘ID | No |
Name | string | UDisk名字(仅当磁盘是UDisk时返回) | No |
Drive | string | 磁盘盘符 | No |
Size | int | 磁盘大小,单位: GB | No |
BackupType | string | 备份方案。若开通了数据方舟,则为DataArk | No |
UHostIPSet
Parameter name | Type | Description | Required |
Default | string | 【暂未支持】是否为默认网卡。True: 是默认网卡;其他值:不是。 | Yes |
Mac | string | 当前网卡的Mac。 | Yes |
Weight | int | 当前EIP的权重。权重最大的为当前的出口IP。 | Yes |
Type | string | 国际: Internation,BGP: Bgp,内网: Private | No |
IPId | string | 外网IP资源ID 。(内网IP无对应的资源ID) | No |
IP | string | IP地址 | No |
Bandwidth | int | IP对应的带宽, 单位: Mb (内网IP不显示带宽信息) | No |
VPCId | string | IP地址对应的VPC ID。(北京一不支持,字段返回为空) | No |
SubnetId | string | IP地址对应的子网 ID。(北京一不支持,字段返回为空) | No |
Request Example
https://api.ucloud.cn/?Action=DescribeUHostInstance &Region=cn-bj2 &Zone=cn-bj2-04 &ProjectId=org-xxx &Offset=0 &Limit=20 &UHostIds.0=uhost-xxx &IsolationGroup=lvbanUiO &VPCId=SNCWNQEL &SubnetId=nWauQBws
Response Example
{ "RetCode": 0, "Action": "DescribeUHostInstanceResponse", "UHostSet": [ { "UHostId": "uhost-xxx", "Zone": "cn-bj2-04", "LifeCycle": "Normal", "OsName": "CentOS 6.5 64位", "ImageId": "xxx", "BasicImageId": "uimage-xxx", "BasicImageName": "1", "Tag": "Default", "Name": "UHost", "Remark": "", "State": "Running", "NetworkState": "Connected", "HostType": "N2", "StorageType": "LocalDisk", "TotalDiskSpace": 20, "DiskSet": [ { "DiskId": "xxx", "Drive": "vda", "Size": 20, "Encrypted": "No", "Type": "Boot" }, { "DiskId": "xxx", "Drive": "vdb", "Size": 20, "Encrypted": "No", "Type": "Data" } ], "NetCapability": "Normal", "IPSet": [ { "Type": "Private", "IP": "10.19.xxx.xxx", "Mac": "xxx", "VPCId": "uvnet-xxx", "SubnetId": "subnet-xxxx" } ], "SubnetType": "Default", "ChargeType": "Month", "ExpireTime": 1532483542, "AutoRenew": "Yes", "UHostType": "Normal", "OsType": "Linux", "CreateTime": 1529891542, "CPU": 4, "GPU": 0, "Memory": 8192, "TimemachineFeature": "no", "HotplugFeature": false, "NetCapFeature": true, "BootDiskState": "Normal" } ], "TotalCount": 1 }