Files
cloudpods/docs/parameters/common.yaml
2019-09-16 14:50:29 +08:00

144 lines
3.1 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
offset:
name: offset
in: query
type: integer
default: 0
description: 查询偏移量
limit:
name: limit
in: query
type: integer
default: 20
description: 查询限制量
admin:
name: admin
in: query
type: boolean
default: false
description: obsolete, equivalent to scope=system
scope:
name: scope
in: query
type: string
default: project
description: specify query scope, either project, domain or system
search:
name: search
in: query
type: string
description: 模糊查询, 对结果中任意字符串字段进行包含该字符串的过滤
billing_type:
name: billing_type
in: query
type: string
enum: [postpaid, prepaid]
description: 指定计费类型
provider:
name: provider
in: query
type: string
description: 根据平台过滤
account:
name: account
in: query
type: string
description: 根据账号过滤
cloudaccount:
name: account
in: query
type: string
description: 根据账号过滤
cloudprovider:
name: cloudprovider
in: query
type: string
description: 根据账号子订阅过滤
brand:
name: brand
in: query
type: string
description: 根据品牌过滤
zone:
name: zone
in: query
type: string
description: 过滤可用区底下的资源
wire:
name: wire
in: query
type: string
description: 过滤连接此二层网络的资源
network:
name: network
in: query
type: string
description: 过滤关联词网络的资源
vpc:
name: vpc
in: query
type: string
description: 过滤连接此VPC的资源
region:
name: region
in: query
type: string
description: 过滤此区域底下的资源
cloud_env:
name: cloud_env
in: query
type: string
enum: [public,private,onpremise]
description: 根据云环境过滤资源
city:
name: city
in: query
type: string
description: 根据城市过滤资源
cloudregion:
name: cloudregion
in: query
type: string
description: 根据区域过滤列表
pending_delete:
name: pending_delete
in: query
type: string
default: true
enum: [true,false,all]
description: 默认不显示回收站资源true则只显示回收站资源all则显示所有资源含不再回收站和在回收站的资源支持实例,磁盘,镜像过滤
override_pending_delete:
name: override_pending_delete
in: query
type: boolean
description: 从回收站删除资源时需要指定此参数为true, 回收站资源到期会自动释放。到期清理时间由服务参数PendingDeleteExpireSeconds确定。默认是259200秒3天
name:
name: name
in: body
type: string
description: 更新资源的名称
description:
name: description
in: body
type: string
description: 更新资源的描述
public_cloud:
name: public_cloud
in: query
type: boolean
description: 过滤公有云资源
private_cloud:
name: private_cloud
in: query
type: boolean
description: 过滤公有云资源
is_on_premise:
name: is_on_premise
in: query
type: boolean
description: 过滤本地IDC资源
is_managed:
name: is_managed
in: query
type: boolean
description: 过滤通过云账号导入进来的资源