宿主机/物理机列表

请求参数

Query 参数

limit

integer

查询限制量

可选

offset

integer

查询偏移量

可选

order_by

array[string]

可选

列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。

order

string

可选

列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。

示例值:

desc|asc

details

string

可选

列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。

string

模糊搜索所有字段

可选

filter

array[string]

可选

指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test')
支持的操作符如下：

操作符	参数个数	举例	说明
in	> 0	name.in("test", "good")	在给定数组中
notin	> 0	name.notin('test')	不在给定数组中
between	2	created_at.between('2019-12-10', '2020-01-02')	在两个值之间
ge	1	created_at.ge('2020-01-01')	大于或等于给定值
gt	1	created_at.gt('2020-01-01')	严格大于给定值
le	1	created_at.le('2020-01-01')	小于或等于给定值
lt	1	sync_seconds.lt(900)	严格大于给定值
like	> 0	name.like('%test%')	sql字符串匹配任意一个字符串
contains	> 0	name.contains('test')	包含任意一个给定字符串
startswith	> 0	name.startswith('test')	以任意一个给定字符串开头
endswith	> 0	name.endswith('test')	以任意一个给定字符串结尾
equals	> 0	name.equals('test')	等于任意一个给定值
notequals	1	name.notequals('test')	不等于给定值
isnull	0	name.isnull()	值为SQL的NULL
isnotnull	0	name.isnotnull()	值不为SQL的NULL
isempty	0	name.isempty('test')	值为空字符串
isnotempty	0	name.isnotempty('test')	值不是空字符串
isnullorempty	0	name.isnullorempty('test')	值为SQL的NULL或者空字符串

joint_filter

array[string]

可选

指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同，
和其他表关联的语法如下：
joint_resources.related_key(origin_key).filter_col.filter_ops(values)
其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为
关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值
举例：
guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')

filter_any

string

可选

如果filter_any为true，则查询所有filter的并集，否则为交集

field

array[string]

可选

返回结果只包含指定的字段

export_keys

string

可选

用于数据导出，指定导出的数据字段

show_fail_reason

string

可选

返回结果携带delete_fail_reason和update_fail_reason字段

summary_stats

string

可选

是否返回状态统计信息，默认为False

order_by_tag

string

通过标签排序

可选

without_user_meta

string

可选

deprecated
返回资源的标签不包含用户标签

with_user_meta

string

可选

返回包含用户标签的资源

with_cloud_meta

string

可选

返回包含外部标签的资源

with_any_meta

string

可选

返回包含任意标签的资源

with_meta

string

可选

返回列表数据中包含资源的标签数据（Metadata）

show_emulated

string

可选

显示所有的资源，包括模拟的资源

array[string]

以资源ID过滤列表

可选

name

array[string]

以资源名称过滤列表

可选

is_public

string

可选

以资源是否共享过滤列表

public_scope

string

可选

根据资源的共享范围过滤列表，可能值为：system, domain, project

status

array[string]

可选

以资源的状态过滤列表

enabled

string

可选

以资源是否启用/禁用过滤列表

external_id

string

以资源外部ID过滤

可选

vpc_id

array[string]

可选

关联VPC(ID或Name)

external_access_mode

string

Vpc外网访问模式

可选

order_by_vpc

string

按VPC名称排序

可选

wire_id

string

可选

二层网络(ID或Name)的资源

order_by_wire

string

以二层网络名称排序

可选

schedtag_id

string

可选

以关联的调度标签（ID或Name）过滤列表

order_by_schedtag

string

按调度标签名称排序

可选

order_by_resource_type

string

可选

按调度标签资源类型排序

storage_id

string

可选

存储（ID或Name）

storage_host_id

string

以host过滤

可选

string

可选

filter shared storage

local

string

可选

filter local storage

cloudregion_id

array[string]

区域名称或ID

可选

city

string

可选

过滤位于指定城市区域的资源

order_by_region

string

按区域名称过滤

可选

order_by_city

string

按城市过滤

可选

zone_id

string

可用区ID或名称

可选

示例值:

zone1

zone_ids

array[string]

可选

过滤处于多个指定可用区内的资源

order_by_zone

string

按可用区名称排序

可选

scope

string

可选

指定查询的权限范围，可能值为project, domain or system

project_domain_id

string

可选

指定项目归属域名称或ID

project_domain_ids

array[string]

可选

对具有域属性的资源，严格匹配域ID

order_by_domain

string

可选

按domain名称排序，可能值为asc|desc

providers

array[string]

可选

列出指定云平台的资源，支持的云平台如下

Provider	开始支持版本	平台
OneCloud	0.0	OneCloud内置私有云，包括KVM和裸金属管理
VMware	1.2	VMware vCenter
OpenStack	2.6	OpenStack M版本以上私有云
ZStack	2.10	ZStack私有云
Aliyun	2.0	阿里云
Aws	2.3	Amazon AWS
Azure	2.2	Microsoft Azure
Google	2.13	Google Cloud Platform
Qcloud	2.3	腾讯云
Huawei	2.5	华为公有云
Ucloud	2.7	UCLOUD
Ctyun	2.13	天翼云
S3	2.11	通用s3对象存储
Ceph	2.11	Ceph对象存储
Xsky	2.11	XSKY启明星辰Ceph对象存储

brands

array[string]

可选

cloud_env

string

可选

列出指定云环境的资源，支持云环境如下：

CloudEnv	说明
public	公有云
private	私有云
onpremise	本地IDC

order_by_provider

string

以平台名称排序

可选

order_by_brand

string

以平台品牌排序

可选

cloudprovider_id

array[string]

可选

列出关联指定云订阅(ID或Name)的资源

cloudaccount_id

array[string]

可选

列出关联指定云账号(ID或Name)的资源

is_managed

string

可选

过滤资源，是否为非OneCloud内置私有云管理的资源

order_by_account

string

以云账号名称排序

可选

order_by_manager

string

以云订阅名称排序

可选

usable

string

可选

filter by network usability of the resource

backupstorage_id

string

可选

备份存储（ID或Name）

order_by_backupstorage

string

以备份存储名称排序

可选

resource_type

string

可选

filter by ResourceType

any_mac

string

可选

filter by mac of any network interface

any_ip

array[string]

可选

filter by ip of any network interface

storage_not_attached

string

可选

filter storages not attached to this host

hypervisor

string

可选

filter by Hypervisor

is_empty

string

可选

filter host that is empty

baremetal

string

可选

filter host that is baremetal

rack

array[string]

机架

可选

slots

array[string]

机位

可选

access_mac

array[string]

管理口MAC

可选

access_ip

array[string]

管理口Ip地址

可选

array[string]

物理机序列号信息

可选

cpu_count

array[string]

CPU大小

可选

mem_size

array[string]

内存大小,单位Mb

可选

storage_type

array[string]

可选

存储类型(磁盘类型，sdd, rotate, hybrid)

host_storage_type

array[string]

宿主机绑定存储类型

可选

ipmi_ip

array[string]

IPMI地址

可选

host_status

array[string]

宿主机状态

可选

示例值:

online

host_type

array[string]

宿主机类型

可选

version

array[string]

可选

host服务软件版本

ovn_version

array[string]

OVN软件版本

可选

is_maintenance

string

是否处于维护状态

可选

is_import

string

是否为导入的宿主机

可选

enable_pxe_boot

string

是否允许PXE启动

可选

uuid

array[string]

主机UUID

可选

boot_mode

array[string]

可选

主机启动模式, 可能值位PXE和ISO

server_id_for_network

string

可选

虚拟机所在的二层网络

cpu_architecture

array[string]

可选

宿主机 cpu 架构

os_arch

array[string]

可选

order_by_server_count

string

按虚拟机数量排序

可选

order_by_storage

string

可选

按存储大小排序
enmu: asc,desc

order_by_storage_commit_rate

string

可选

按存储超分率排序
enmu: asc,desc

order_by_cpu_commit_rate

string

可选

按cpu超分率排序
enmu: asc,desc

order_by_mem_commit_rate

string

可选

按内存超分率排序
enmu: asc,desc

order_by_storage_used

string

可选

按本地存储分配大小排序
enmu: asc,desc

order_by_cpu_commit

string

可选

按cpu分配大小排序
enmu: asc,desc

order_by_mem_commit

string

可选

按内存分配大小排序
enmu: asc,desc

返回响应

🟢200成功

application/json

Body

hosts

array[object (HostDetails) {141}]

可选

GuestPinnedCpus

array[integer <int64>]

可选

IsolatedDeviceCount

integer <int64>

可选

isolated device count

IsolatedDeviceTypeCount

object

可选

access_ip

string

管理口Ip地址

可选

access_mac

string

管理口MAC

可选

account

string

云账号名称

可选

示例值:

google-account

account_health_status

string

云账号监控状态

可选

account_id

string

云账号Id

可选

示例值:

4d3c8979-9dd0-439b-8d78-36fe1ab1666c

account_read_only

boolean

可选

account_status

string

云账号状态

可选

actual_storage_used

integer <int64>

实际已使用存储大小

可选

allow_health_check

boolean

可选

允许开启宿主机健康检查

auto_migrate_on_host_down

boolean

可选

auto_migrate_on_host_shutdown

boolean

可选

auto_renew

boolean

是否自动续费

可选

backup_guests

integer <int64>

主备云主机数量

可选

示例值:

billing_cycle

string

计费周期

可选

billing_type

string

可选

计费类型, 按量、包年包月

示例值:

postpaid

boot_mode

string

可选

主机启动模式, 可能值为PXE和ISO

brand

string

云平台品牌

可选

示例值:

Google

can_delete

boolean

可选

资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因

示例值:

true

can_prepare

boolean

可选

can_update

boolean

可选

资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因

示例值:

true

cloud_env

string

云环境

可选

示例值:

public

cloudregion

string

区域的名称

可选

cloudregion_id

string

可用区的区域ID

可选

cpu_architecture

string

CPU架构

可选

cpu_cache

integer <int64>

可选

CPU缓存大小,单位KB

cpu_cmtbound

number <float>

CPU超分比

可选

cpu_commit

integer <int64>

CPU超分比

可选

cpu_commit_bound

number <float>

CPU超售比

可选

cpu_commit_rate

number <double>

CPU超分率

可选

cpu_count

integer <int64>

CPU核数

可选

cpu_desc

string

CPU描述信息

可选

cpu_mhz

integer <int64>

CPU频率

可选

cpu_microcode

string

可选

CPUMicrocode

cpu_reserved

integer <int64>

预留CPU大小

可选

created_at

string <date-time>

资源创建时间

可选

delete_fail_reason

object (Error)

可选

deleted

boolean

资源是否被删除

可选

deleted_at

string <date-time>

资源删除时间

可选

description

string

资源描述信息

可选

domain_id

string

域Id

可选

domain_src

string

可选

归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来

示例值:

local

enable_health_check

boolean

可选

health check enabled by host agent online

enable_numa_allocate

boolean

可选

enable_pxe_boot

boolean

是否允许PXE启动

可选

enabled

boolean

资源是否启用

可选

environment

string

可选

Environment

expired_at

string <date-time>

过期时间

可选

external_id

string

可选

云上Id, 对应云上资源自身Id

guests

integer <int64>

云主机数量

可选

示例值:

host_files

array[string]

可选

host_status

string

宿主机状态

可选

示例值:

online

host_type

string

宿主机类型

可选

hostname

string

可选

string

资源UUID

可选

imported_at

string <date-time>

资源导入时间

可选

ipmi_info

object

IPMI详情

可选

ipmi_ip

string

IPMI地址

可选

is_baremetal

boolean

可选

is_emulated

boolean

可选

是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数

is_import

boolean

是否为导入的宿主机

可选

is_maintenance

boolean

是否处于维护状态

可选

is_prepaid_recycle

boolean

可选

is_public

boolean

是否共享

可选

manager

string

云订阅名称

可选

示例值:

google-account

manager_domain

string

子订阅所在域名称

可选

示例值:

Default

manager_domain_id

string

子订阅所在域Id

可选

示例值:

default

manager_id

string

云订阅ID

可选

manager_project

string

子订阅所在项目名称

可选

示例值:

system

manager_project_id

string

子订阅所在项目Id

可选

示例值:

4d3c8979-9dd0-439b-8d78-36fe1ab1666c

manager_uri

string

管理地址

可选

mem_cmtbound

number <float>

内存超分比

可选

mem_commit

integer <int64>

内存超分比

可选

mem_commit_bound

number <float>

内存超售比

可选

mem_commit_rate

number <double>

内存超分率

可选

mem_reserved

integer <int64>

预留内存大小

可选

mem_size

integer <int64>

内存大小,单位Mb

可选

metadata

object

标签

可选

name

string

资源名称

可选

nic_count

integer <int64>

网卡数量

可选

nic_info

array[object (SNic) {24}]

网卡详情

可选

node_count

integer

物理CPU颗数

可选

nonsystem_guests

integer <int64>

非系统云主机数量

可选

示例值:

other_guests

integer <int64>

其他状态云主机数量

可选

示例值:

ovn_mapped_ip_addr

string

可选

IPv4地址，作为私有云vpc访问外网时的网关

ovn_version

string

OVN软件版本

可选

page_size_kb

integer <int64>

页大小

可选

pending_deleted_guests

integer <int64>

回收站中云主机数量

可选

示例值:

prepare_fail_reason

string

可选

progress

number <float>

操作进度0-100

可选

project_domain

string

可选

资源归属项目的域名称

provider

string

云平台名称

可选

示例值:

Google

public_ip

string

公网Ip地址

可选

public_scope

string

默认共享范围

可选

public_src

string

可选

共享设置的来源, local: 本地设置, cloud: 从云上同步过来

示例值:

local

rack

string

机架

可选

ready_guests

integer <int64>

关机状态云主机数量

可选

示例值:

real_external_id

string

可选

region

string

区域的名称

可选

示例值:

Default

region_ext_id

string

纳管云区域的Id

可选

示例值:

59e7bc87-a6b3-4c39-8f02-c68e8243d4e4

region_external_id

string

可选

纳管云区域的组合Id(平台+Id)

示例值:

ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4

region_id

string

区域的Id

可选

示例值:

default

reserved_resource_for_gpu

object (IsolatedDeviceReservedResourceInput)

可选

resource_type

string

可选

running_guests

integer <int64>

运行状态云主机数量

可选

示例值:

schedtags

array[object (SchedtagShortDescDetails) {4}]

可选

server

string

可选

server_id

string

可选

server_ips

string

可选

server_pending_deleted

boolean

可选

shared_domains

array[object (SharedDomain) {2}]

共享的域列表

可选

shared_projects

array[object (SharedProject) {4}]

共享的项目列表

可选

slots

string

机位

可选

string

物理机序列号信息

可选

source

string

可选

资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目

spec

object

可选

status

string

资源状态

可选

storage

integer <int64>

存储大小

可选

storage_commit_rate

number <double>

存储超分率

可选

storage_driver

string

存储驱动类型

可选

storage_free

integer <int64>

可用存储大小

可选

storage_info

object

存储详情

可选

storage_size

integer <int64>

存储大小,单位Mb

可选

storage_type

string

存储类型

可选

storage_used

integer <int64>

已使用存储大小

可选

storage_virtual

integer <int64>

虚拟存储大小

可选

storage_waste

integer <int64>

可选

浪费存储大小(异常磁盘存储大小)

sys_error

string

可选

host init error info

sys_info

object

系统信息

可选

sys_warn

string

可选

host init warnning

uefi_info

object

UEFI详情

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

uuid

string

主机UUID

可选

version

string

可选

host服务软件版本

zone

string

可用区名称

可选

示例值:

北京一区

zone_ext_id

string

可选

纳管云的zoneId

zone_id

string

可选

limit

integer <int64>

可选

offset

integer <int64>

可选

total

integer <int64>

可选

示例

{
    "hosts": [
        {
            "GuestPinnedCpus": [
                0
            ],
            "IsolatedDeviceCount": 0,
            "IsolatedDeviceTypeCount": {
                "property1": 0,
                "property2": 0
            },
            "access_ip": "string",
            "access_mac": "string",
            "account": "google-account",
            "account_health_status": "string",
            "account_id": "4d3c8979-9dd0-439b-8d78-36fe1ab1666c",
            "account_read_only": true,
            "account_status": "string",
            "actual_storage_used": 0,
            "allow_health_check": true,
            "auto_migrate_on_host_down": true,
            "auto_migrate_on_host_shutdown": true,
            "auto_renew": true,
            "backup_guests": 10,
            "billing_cycle": "string",
            "billing_type": "postpaid",
            "boot_mode": "string",
            "brand": "Google",
            "can_delete": true,
            "can_prepare": true,
            "can_update": true,
            "cloud_env": "public",
            "cloudregion": "string",
            "cloudregion_id": "string",
            "cpu_architecture": "string",
            "cpu_cache": 0,
            "cpu_cmtbound": 0,
            "cpu_commit": 0,
            "cpu_commit_bound": 0,
            "cpu_commit_rate": 0,
            "cpu_count": 0,
            "cpu_desc": "string",
            "cpu_mhz": 0,
            "cpu_microcode": "string",
            "cpu_reserved": 0,
            "created_at": "2019-08-24T14:15:22Z",
            "delete_fail_reason": {
                "class": "string",
                "code": 0,
                "details": "string"
            },
            "deleted": true,
            "deleted_at": "2019-08-24T14:15:22Z",
            "description": "string",
            "domain_id": "string",
            "domain_src": "local",
            "enable_health_check": true,
            "enable_numa_allocate": true,
            "enable_pxe_boot": true,
            "enabled": true,
            "environment": "string",
            "expired_at": "2019-08-24T14:15:22Z",
            "external_id": "string",
            "guests": 10,
            "host_files": [
                "string"
            ],
            "host_status": "online",
            "host_type": "string",
            "hostname": "string",
            "id": "string",
            "imported_at": "2019-08-24T14:15:22Z",
            "ipmi_info": {},
            "ipmi_ip": "string",
            "is_baremetal": true,
            "is_emulated": true,
            "is_import": true,
            "is_maintenance": true,
            "is_prepaid_recycle": true,
            "is_public": true,
            "manager": "google-account",
            "manager_domain": "Default",
            "manager_domain_id": "default",
            "manager_id": "string",
            "manager_project": "system",
            "manager_project_id": "4d3c8979-9dd0-439b-8d78-36fe1ab1666c",
            "manager_uri": "string",
            "mem_cmtbound": 0,
            "mem_commit": 0,
            "mem_commit_bound": 0,
            "mem_commit_rate": 0,
            "mem_reserved": 0,
            "mem_size": 0,
            "metadata": {
                "property1": "string",
                "property2": "string"
            },
            "name": "string",
            "nic_count": 0,
            "nic_info": [
                {
                    "bandwidth": 0,
                    "bridge": "string",
                    "dns": "string",
                    "domain": "string",
                    "gateway": "string",
                    "gateway6": "string",
                    "index": 0,
                    "interface": "string",
                    "ip_addr": "string",
                    "ip6_addr": "string",
                    "link_up": true,
                    "mac": "string",
                    "masklen": 0,
                    "masklen6": 0,
                    "mtu": 0,
                    "net": "string",
                    "net_id": "string",
                    "nic_type": "string",
                    "ntp": "string",
                    "rate": 0,
                    "routes": [
                        [
                            "string"
                        ]
                    ],
                    "vlan_id": 0,
                    "wire": "string",
                    "wire_id": "string"
                }
            ],
            "node_count": 0,
            "nonsystem_guests": 0,
            "other_guests": 2,
            "ovn_mapped_ip_addr": "string",
            "ovn_version": "string",
            "page_size_kb": 0,
            "pending_deleted_guests": 2,
            "prepare_fail_reason": "string",
            "progress": 0,
            "project_domain": "string",
            "provider": "Google",
            "public_ip": "string",
            "public_scope": "string",
            "public_src": "local",
            "rack": "string",
            "ready_guests": 2,
            "real_external_id": "string",
            "region": "Default",
            "region_ext_id": "59e7bc87-a6b3-4c39-8f02-c68e8243d4e4",
            "region_external_id": "ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4",
            "region_id": "default",
            "reserved_resource_for_gpu": {
                "reserved_cpu": 0,
                "reserved_memory": 0,
                "reserved_storage": 0
            },
            "resource_type": "string",
            "running_guests": 2,
            "schedtags": [
                {
                    "default": "string",
                    "id": "string",
                    "name": "string",
                    "res_name": "string"
                }
            ],
            "server": "string",
            "server_id": "string",
            "server_ips": "string",
            "server_pending_deleted": true,
            "shared_domains": [
                {
                    "id": "string",
                    "name": "string"
                }
            ],
            "shared_projects": [
                {
                    "domain": "string",
                    "domain_id": "string",
                    "id": "string",
                    "name": "string"
                }
            ],
            "slots": "string",
            "sn": "string",
            "source": "string",
            "spec": {},
            "status": "string",
            "storage": 0,
            "storage_commit_rate": 0,
            "storage_driver": "string",
            "storage_free": 0,
            "storage_info": {},
            "storage_size": 0,
            "storage_type": "string",
            "storage_used": 0,
            "storage_virtual": 0,
            "storage_waste": 0,
            "sys_error": "string",
            "sys_info": {},
            "sys_warn": "string",
            "uefi_info": {},
            "update_fail_reason": {
                "class": "string",
                "code": 0,
                "details": "string"
            },
            "update_version": 0,
            "updated_at": "2019-08-24T14:15:22Z",
            "uuid": "string",
            "version": "string",
            "zone": "北京一区",
            "zone_ext_id": "string",
            "zone_id": "string"
        }
    ],
    "limit": 0,
    "offset": 0,
    "total": 0
}

宿主机/物理机列表

请求参数

示例代码

返回响应