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

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]

以资源名称过滤列表

可选

scope

string

可选

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

project_domain_id

string

可选

指定项目归属域名称或ID

project_domain_ids

array[string]

可选

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

order_by_domain

string

可选

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

type

string

可选

attribution

string

可选

返回响应

🟢200成功

application/json

Body

configs

array[object (ConfigDetails) {20}]

可选

attribution

string

可选

can_delete

boolean

可选

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

示例值:

true

can_update

boolean

可选

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

示例值:

true

content

object (SNotifyConfigContent)

可选

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

string

资源UUID

可选

is_emulated

boolean

可选

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

metadata

object

标签

可选

name

string

资源名称

可选

project_domain

string

可选

资源归属项目的域名称

type

string

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

limit

integer <int64>

可选

offset

integer <int64>

可选

total

integer <int64>

可选

示例

{
    "configs": [
        {
            "attribution": "string",
            "can_delete": true,
            "can_update": true,
            "content": {
                "AccessKeyId": "string",
                "AccessKeySecret": "string",
                "AccessToken": "string",
                "AgentId": "string",
                "AlertsCode": "string",
                "AppId": "string",
                "AppKey": "string",
                "AppSecret": "string",
                "CorpId": "string",
                "ErrorCode": "string",
                "Hostname": "string",
                "Hostport": 0,
                "Password": "string",
                "PhoneNumber": "string",
                "Secret": "string",
                "SenderAddress": "string",
                "ServiceUrl": "string",
                "Signature": "string",
                "SmsDriver": "string",
                "SslGlobal": true,
                "Username": "string",
                "VerifiyCode": "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",
            "domain_id": "string",
            "domain_src": "local",
            "id": "string",
            "is_emulated": true,
            "metadata": {
                "property1": "string",
                "property2": "string"
            },
            "name": "string",
            "project_domain": "string",
            "type": "string",
            "update_fail_reason": {
                "class": "string",
                "code": 0,
                "details": "string"
            },
            "update_version": 0,
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "limit": 0,
    "offset": 0,
    "total": 0
}

列表

请求参数

示例代码

返回响应