获取主机信息-DescribeUHostInstance

获取主机或主机列表信息,并可根据数据中心,主机ID等参数进行过滤。

Request Parameters

Parameter nameTypeDescriptionRequired
Regionstring地域。 参见 地域和可用区列表Yes
Zonestring可用区。参见 可用区列表No
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口No
UHostIds.Nstring【数组】UHost主机的资源ID,例如UHostIds.0代表希望获取信息 的主机1,UHostIds.1代表主机2。 如果不传入,则返回当前Region 所有符合条件的UHost实例。No
Tagstring要查询的业务组名称No
Offsetint列表起始位置偏移量,默认为0No
Limitint返回数据长度,默认为20,最大100No
IsolationGroupstring硬件隔离组id。通过硬件隔离组筛选主机。No
VPCIdstringvpc id。通过VPC筛选主机。北京一地域无效。No
SubnetIdstring子网id。通过子网筛选主机。北京一地域无效。No

Response Elements

Parameter nameTypeDescriptionRequired
RetCodeint返回码Yes
Actionstring操作名称Yes
TotalCountintUHostInstance总数No
UHostSetarray云主机实例列表,每项参数可见下面 UHostInstanceSetNo

UHostInstanceSet

Parameter nameTypeDescriptionRequired
Zonestring可用区。参见 可用区列表No
UHostIdstringUHost实例IDNo
UHostTypestring【建议不再使用】云主机机型(旧)。参考云主机机型说明No
MachineTypestring云主机机型(新)。参考云主机机型说明No
StorageTypestring【建议不再使用】主机磁盘类型。 枚举值为:
> LocalDisk,本地磁盘;
> UDisk 云盘。\\只要有一块磁盘为本地盘,即返回LocalDisk。
No
ImageIdstring【建议不再使用】主机的系统盘ID。No
BasicImageIdstring基础镜像ID(指当前自定义镜像的来源镜像)No
BasicImageNamestring基础镜像名称(指当前自定义镜像的来源镜像)No
Tagstring业务组名称No
Remarkstring备注No
NamestringUHost实例名称No
Statestring实例状态,枚举值:
>初始化: Initializing;
>启动中: Starting; \\> 运行中: Running; \\> 关机中: Stopping;
>关机: Stopped
>安装失败: Install Fail;
>重启中: Rebooting
No
CreateTimeint创建时间,格式为Unix时间戳No
ChargeTypestring计费模式,枚举值为: Year,按年付费; Month,按月付费; Dynamic,按需付费(需开启权限); No
ExpireTimeint到期时间,格式为Unix时间戳No
CPUint虚拟CPU核数,单位: 个No
Memoryint内存大小,单位: MBNo
AutoRenewstring是否自动续费,自动续费:“Yes”,不自动续费:“No”No
DiskSetarray磁盘信息见 UHostDiskSetNo
IPSetarray详细信息见 UHostIPSetNo
NetCapabilitystring网络增强。Normal: 无;Super: 网络增强1.0; Ultra: 网络增强2.0No
NetworkStatestring【建议不再使用】网络状态。 连接:Connected, 断开:NotConnectedNo
TimemachineFeaturestring【建议不再使用】数据方舟模式。枚举值:
> Yes: 开启方舟;
> no,未开启方舟
No
HotplugFeaturebooltrue: 开启热升级; false,未开启热升级No
SubnetTypestring【建议不再使用】仅北京A的云主机会返回此字段。基础网络模式:Default;子网模式:PrivateNo
OsNamestring创建主机的最初来源镜像的操作系统名称(若直接通过基础镜像创建,此处返回和BasicImageName一致)No
OsTypestring操作系统类别。返回"Linux"或者"Windows"No
HostTypestring【建议不再使用】主机系列:N2,表示系列2;N1,表示系列1No
LifeCyclestring主机的生命周期类型。目前仅支持Normal:普通;No
GPUintGPU个数No
BootDiskStatestring系统盘状态 Normal表示初始化完成;Initializing表示在初始化。仍在初始化的系统盘无法制作镜像。No
TotalDiskSpaceint总的数据盘存储空间。No
IsolationGroupstring隔离组id,不在隔离组则返回""No

UHostDiskSet

Parameter nameTypeDescriptionRequired
DiskTypestring磁盘类型。请参考磁盘类型Yes
IsBootstring是否是系统盘。枚举值:
> True,是系统盘
> False,是数据盘(默认)。Disks数组中有且只能有一块盘是系统盘。
Yes
Encryptedbooltrue: 加密盘 false:非加密盘No
Typestring【建议不再使用】磁盘类型。系统盘: Boot,数据盘: Data,网络盘:UdiskNo
DiskIdstring磁盘IDNo
NamestringUDisk名字(仅当磁盘是UDisk时返回)No
Drivestring磁盘盘符No
Sizeint磁盘大小,单位: GBNo
BackupTypestring备份方案。若开通了数据方舟,则为DataArkNo

UHostIPSet

Parameter nameTypeDescriptionRequired
Defaultstring【暂未支持】是否为默认网卡。True: 是默认网卡;其他值:不是。Yes
Macstring当前网卡的Mac。Yes
Weightint当前EIP的权重。权重最大的为当前的出口IP。Yes
Typestring国际: Internation,BGP: Bgp,内网: PrivateNo
IPIdstring外网IP资源ID 。(内网IP无对应的资源ID)No
IPstringIP地址No
BandwidthintIP对应的带宽, 单位: Mb (内网IP不显示带宽信息)No
VPCIdstringIP地址对应的VPC ID。(北京一不支持,字段返回为空)No
SubnetIdstringIP地址对应的子网 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
}