列出资源池下的UDhost实例-DescribeUDSetInstance

列出资源池下的UDhost实例

Request Parameters

Parameter nameTypeDescriptionRequired
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口No
HostIds.nstring资源池的短ID, 如果为空, 则返回当前Region所有符合条件的UHost实例,否则返回指定资源池上的所有UHost实例No
UHostIds.nstring专区主机的短ID, 如果为空, 则返回指定资源池的UHost实例,否则返回指定主机的实例信息No
Tagstring要查询的业务组名称No
Offsetint主机数据偏移量, 默认为0No
Limitint返回主机数据长度, 默认为20No

Response Elements

Parameter nameTypeDescriptionRequired
RetCodeint操作返回码Yes
Actionstring操作名称Yes
TotalCountint满足条件的总数No
UHostSetarray满足条件的私有专区主机列表No

UDSetInstanceSet

Parameter nameTypeDescriptionRequired
Zonestring可用区No
UHostIdstringUHost实例IDNo
HostIdstring资源池短IDNo
UHostTypestringNormal:标准机型,SSD:SSD机型No
OsTypestring操作系统类型: Liunx, WindowsNo
OsNamestring操作系统名称No
ImageIdstring镜像IdNo
BasicImageIdstring基础镜像IdNo
BasicImageNamestring基础镜像名称No
Tagstring业务组名称No
Remarkstring备注No
Namestring实例名称No
Statestring实例状态, 初始化:Initializing, 启动中:Starting, 运行中:Running, 关机中:Stopping,关机:Stopped, 安装失败:Install Fail, 重启中:Rebooting 重置密码中 迁移中No
ExpireTimeint到期时间No
CPUint虚拟CPU核数, 单位:个No
Memoryint内存大小, 单位:MBNo
DiskSetarray磁盘信息No
NetCapabilitystring正常:Normal;网络增强:EnhanceNo
IPSetarrayIP信息No
SubnetTypestring是否私有网络,Default,PrivateNo
NetworkStatestringConnected,NotConnectedNo
TimemachineFeaturestring是否开启数据方舟。Yes: 开启;No:未开启。No
BootDiskStatestring系统盘状态。在Initializing时主机不能创建镜像。No

UHostDiskSet

Parameter nameTypeDescriptionRequired
Typestring磁盘类型。系统盘: Boot,数据盘: Data,网络盘:UdiskNo
DiskIdstring磁盘IDNo
NameintUDisk名字(仅当磁盘是UDisk时返回)No
Driveint磁盘盘符No
Sizeint磁盘大小,单位: GBNo

UHostIPSet

Parameter nameTypeDescriptionRequired
Typestring国际: Internation,BGP: Bgp,内网: PrivateNo
IPIdstringIP资源ID (内网IP无对应的资源ID)No
IPstringIP地址No
BandwidthintIP对应的带宽, 单位: Mb (内网IP不显示带宽信息)No
Defaultstring是否默认的弹性网卡的信息。true: 是默认弹性网卡;其他值:不是。No

Request Example

https://api.ucloud.cn?Action=DescribeUDSetInstance
&Region=mBqVzITv
&HostIds.n=XhwutBWo
&UHostIds.n=dPplcWeS
&Tag=yoOOTstO
&Offset=9
&Limit=FMICfjGc
&ProjectId=nihbmJrX

Response Example

{
    "RetCode": 0,
    "Action": "DescribeUDSetInstanceResponse",
    "UHostSet": [
        {
            "UHostId": "udhost-xxx",
            "HostId": "udset-xxx",
            "Zone": "cn-bj2-02",
            "UHostType": "Normal",
            "OsType": "Linux",
            "OsName": "CentOS 6.5 64位",
            "ImageId": "7fe9a7ce-8414-400a-80c7-a5325419b0fb",
            "BasicImageId": "uimage-qegj3w",
            "BasicImageName": "CentOS 6.5 64位",
            "Tag": "Default",
            "Name": "test",
            "Remark": "",
            "State": "Running",
            "NetworkState": "Connected",
            "CreateTime": 1543333491,
            "CPU": 2,
            "Memory": 4096,
            "TotalDiskSpace": 20,
            "DiskSet": [
                {
                    "Type": "Boot",
                    "DiskId": "7fe9a7ce-8414-400a-80c7-a5325419b0fb",
                    "Drive": "vda",
                    "Size": 20
                },
                {
                    "Type": "Data",
                    "DiskId": "9f23a13e-c14c-43f9-a530-8d2c1993a186",
                    "Drive": "vdb",
                    "Size": 20
                }
            ],
            "NetCapability": "Normal",
            "TimemachineFeature": "no",
            "IPSet": [
                {
                    "Type": "Private",
                    "IP": "10.9.159.36",
                    "VPCId": "uvnet-xxx",
                    "SubnetId": "subnet-xxx"
                }
            ],
            "SubnetType": "Default",
            "BootDiskState": "Initializing"
        }
    ],
    "TotalCount": 1
}