列表 - cloudpods

请求参数

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字段

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]

以资源名称过滤列表

可选

status

array[string]

可选

以资源的状态过滤列表

project_id

string

可选

指定项目的名称或ID

project_ids

array[string]

可选

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

order_by_project

string

可选

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

project_organizations

array[string]

可选

filter by project organizations

system

string

可选

列表中包含标记为"系统资源"的资源

pending_delete

string

可选

是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像）

zone_id

string

可用区ID或名称

可选

示例值:

zone1

zone_ids

array[string]

可选

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

order_by_zone

string

按可用区名称排序

可选

loadbalancer_id

string

负载均衡名称

可选

order_by_loadbalancer

string

以负载均衡名称排序

可选

backend_group_id

string

可选

负载均衡后端组ID或名称

order_by_backend_group

string

可选

以负载均衡后端组名称排序

vpc_id

array[string]

可选

关联VPC(ID或Name)

external_access_mode

string

Vpc外网访问模式

可选

order_by_vpc

string

按VPC名称排序

可选

cloudregion_id

array[string]

区域名称或ID

可选

city

string

可选

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

order_by_region

string

按区域名称过滤

可选

order_by_city

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]

可选

列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band

Brand	Provider	说明
DStack	ZStack	滴滴云私有云

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

以云订阅名称排序

可选

group_id

string

可选

实例组（ID或Name）

order_by_group

string

按组名排序

可选

guest_template_id

string

主机镜像

可选

enabled

string

可选

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

hypervisor

string

可选

description: hypervisor

示例值:

kvm

brand

string

可选

desription: 平台

示例值:

OneCloud

返回响应

🟢200成功

application/json

Body

limit

integer <int64>

可选

offset

integer <int64>

可选

scalinggroups

array[object (ScalingGroupDetails) {79}]

可选

account

string

云账号名称

可选

示例值:

google-account

account_health_status

string

云账号监控状态

可选

account_id

string

云账号Id

可选

示例值:

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

account_read_only

boolean

可选

account_status

string

云账号状态

可选

backend_group

string

负载均衡后端组名称

可选

backend_group_id

string

负载均衡后端组ID

可选

brand

string

可选

description: 平台

示例值:

OneCloud

can_delete

boolean

可选

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

示例值:

true

can_update

boolean

可选

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

示例值:

true

cloud_env

string

云环境

可选

示例值:

public

cloudregion

string

区域的名称

可选

cloudregion_id

string

归属区域ID

可选

created_at

string <date-time>

资源创建时间

可选

delete_fail_reason

object (Error)

可选

deleted

boolean

资源是否被删除

可选

deleted_at

string <date-time>

资源删除时间

可选

description

string

资源描述信息

可选

desire_instance_number

integer <int64>

可选

DesireInstanceNumber represent the number of instances that should exist in the scaling group.
Scaling controller will monitor and ensure this in real time.
Scaling activities triggered by various policies will also modify this value.
This value should between MinInstanceNumber and MaxInstanceNumber

domain_id

string

域Id

可选

enabled

boolean

资源是否启用

可选

environment

string

可选

Environment

expansion_principle

string

可选

ExpansionPrinciple represent the principle when creating new instance to join in.

freezed

boolean

资源是否被冻结

可选

group

string

实例组名称

可选

group_id

string

实例组ID

可选

guest_template

string

主机模板名称

可选

guest_template_id

string

主机模板ID

可选

health_check_cycle

integer <int64>

可选

health_check_gov

integer <int64>

可选

health_check_mode

string

可选

hypervisor

string

可选

string

资源UUID

可选

instance_number

integer <int64>

可选

description: 实例数

示例值:

is_default_vpc

boolean

是否为经典网络

可选

is_emulated

boolean

可选

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

is_system

boolean

是否是系统资源

可选

loadbalancer

string

负载均衡名称

可选

loadbalancer_backend_port

integer <int64>

可选

loadbalancer_backend_weight

integer <int64>

可选

loadbalancer_id

string

负载均衡ID

可选

manager

string

云订阅名称

可选

示例值:

google-account

manager_domain

string

子订阅所在域名称

可选

示例值:

Default

manager_domain_id

string

子订阅所在域Id

可选

示例值:

default

manager_id

string

可选

VPC归属云订阅ID

manager_project

string

子订阅所在项目名称

可选

示例值:

system

manager_project_id

string

子订阅所在项目Id

可选

示例值:

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

max_instance_number

integer <int64>

可选

metadata

object

标签

可选

min_instance_number

integer <int64>

可选

name

string

资源名称

可选

networks

array[object (ScalingGroupNetwork) {4}]

可选

description: 网络信息

pending_deleted

boolean

可选

资源是否处于回收站中

pending_deleted_at

string <date-time>

资源放入回收站时间

可选

progress

number <float>

操作进度0-100

可选

project

string

可选

资源归属项目的名称（向后兼容别名）
Deprecated

project_domain

string

可选

资源归属项目的域名称

project_id

string

可选

资源归属项目的ID(向后兼容别名）
Deprecated

project_metadata

object

可选

project_src

string

可选

云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过

示例值:

local

provider

string

云平台名称

可选

示例值:

Google

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

scaling_policy_number

integer <int64>

可选

description: 伸缩策略的数量

示例值:

shrink_principle

string

可选

ShrinkPrinciple represent the principle when removing instance from scaling group.

status

string

资源状态

可选

tenant

string

可选

资源归属项目的名称
alias:project

tenant_id

string

项目Id

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

vpc

string

Vpc Name

可选

vpc_ext_id

string

VPC外部Id

可选

vpc_id

string

VPC ID

可选

zone

string

可用区名称

可选

示例值:

北京一区

zone_ext_id

string

可选

纳管云的zoneId

zone_id

string

可用区ID

可选

total

integer <int64>

可选

示例

{
    "limit": 0,
    "offset": 0,
    "scalinggroups": [
        {
            "account": "google-account",
            "account_health_status": "string",
            "account_id": "4d3c8979-9dd0-439b-8d78-36fe1ab1666c",
            "account_read_only": true,
            "account_status": "string",
            "backend_group": "string",
            "backend_group_id": "string",
            "brand": "OneCloud",
            "can_delete": true,
            "can_update": true,
            "cloud_env": "public",
            "cloudregion": "string",
            "cloudregion_id": "string",
            "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",
            "desire_instance_number": 0,
            "domain_id": "string",
            "enabled": true,
            "environment": "string",
            "expansion_principle": "string",
            "freezed": true,
            "group": "string",
            "group_id": "string",
            "guest_template": "string",
            "guest_template_id": "string",
            "health_check_cycle": 0,
            "health_check_gov": 0,
            "health_check_mode": "string",
            "hypervisor": "string",
            "id": "string",
            "instance_number": 0,
            "is_default_vpc": true,
            "is_emulated": true,
            "is_system": true,
            "loadbalancer": "string",
            "loadbalancer_backend_port": 0,
            "loadbalancer_backend_weight": 0,
            "loadbalancer_id": "string",
            "manager": "google-account",
            "manager_domain": "Default",
            "manager_domain_id": "default",
            "manager_id": "string",
            "manager_project": "system",
            "manager_project_id": "4d3c8979-9dd0-439b-8d78-36fe1ab1666c",
            "max_instance_number": 0,
            "metadata": {
                "property1": "string",
                "property2": "string"
            },
            "min_instance_number": 0,
            "name": "string",
            "networks": [
                {
                    "guest_ip_end": "string",
                    "guest_ip_start": "string",
                    "id": "string",
                    "name": "string"
                }
            ],
            "pending_deleted": true,
            "pending_deleted_at": "2019-08-24T14:15:22Z",
            "progress": 0,
            "project": "string",
            "project_domain": "string",
            "project_id": "string",
            "project_metadata": {
                "property1": "string",
                "property2": "string"
            },
            "project_src": "local",
            "provider": "Google",
            "region": "Default",
            "region_ext_id": "59e7bc87-a6b3-4c39-8f02-c68e8243d4e4",
            "region_external_id": "ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4",
            "region_id": "default",
            "scaling_policy_number": 3,
            "shrink_principle": "string",
            "status": "string",
            "tenant": "string",
            "tenant_id": "string",
            "update_fail_reason": {
                "class": "string",
                "code": 0,
                "details": "string"
            },
            "update_version": 0,
            "updated_at": "2019-08-24T14:15:22Z",
            "vpc": "string",
            "vpc_ext_id": "string",
            "vpc_id": "string",
            "zone": "北京一区",
            "zone_ext_id": "string",
            "zone_id": "string"
        }
    ],
    "total": 0
}

列表

请求参数

示例代码

返回响应