| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142 |
- basePath: /
- consumes:
- - application/json
- definitions:
- CloudeventDetails:
- properties:
- account:
- type: string
- x-go-name: Account
- action:
- type: string
- x-go-name: Action
- brand:
- type: string
- x-go-name: Brand
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- cloudprovider_id:
- type: string
- x-go-name: CloudproviderId
- created_at:
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- event_id:
- format: int64
- type: integer
- x-go-name: EventId
- manager:
- type: string
- x-go-name: Manager
- name:
- type: string
- x-go-name: Name
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- provider:
- type: string
- x-go-name: Provider
- request:
- type: object
- x-go-name: Request
- request_id:
- type: string
- x-go-name: RequestId
- resource_type:
- type: string
- x-go-name: ResourceType
- service:
- type: string
- x-go-name: Service
- success:
- type: boolean
- x-go-name: Success
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudevent
- EnabledStatusStandaloneResourceBaseUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- progress:
- format: float
- type: number
- x-go-name: Progress
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- EnabledStatusStandaloneResourceCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- disabled:
- description: 该资源是否被管理员*人为*禁用, 和enabled互斥
- type: boolean
- x-go-name: Disabled
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- enabled:
- description: 该资源是否被管理员*人为*启用或者禁用
- type: boolean
- x-go-name: Enabled
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- status:
- description: 用来存储资源的状态
- type: string
- x-go-name: Status
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- EnabledStatusStandaloneResourceDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- delete_fail_reason:
- $ref: '#/definitions/Error'
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- Error:
- properties:
- class:
- type: string
- x-go-name: Class
- code:
- format: int64
- type: integer
- x-go-name: Code
- details:
- type: string
- x-go-name: Details
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/httperrors
- GetDetailsStatusOutput:
- properties:
- status:
- description: 状态
- type: string
- x-go-name: Status
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- ModelBaseCreateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- ModelBaseUpdateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformDisableInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformEnableInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- STag:
- properties:
- key:
- description: 标签Kye
- type: string
- x-go-name: Key
- value:
- description: 标签Value
- type: string
- x-go-name: Value
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- TTagSet:
- items:
- $ref: '#/definitions/STag'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- TTagSetList:
- items:
- $ref: '#/definitions/TTagSet'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- host: '"127.0.0.1:8889"'
- info:
- contact:
- email: lizexi@yunion.cn
- name: Zexi Li
- description: Cloudprovider API
- license:
- name: Apache 2.0
- url: http://www.apache.org/licenses/LICENSE-2.0.html
- version: "1.0"
- paths:
- /cloudevents:
- get:
- description: 列表
- operationId: cloudevent_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如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或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和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')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: |-
- 列出指定云平台的资源,支持的云平台如下
- 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对象存储 |
- enum:
- - OneCloud
- - VMware
- - Aliyun
- - Qcloud
- - Azure
- - Aws
- - Huawei
- - OpenStack
- - Ucloud
- - ZStack
- - Google
- - Ctyun
- - S3
- - Ceph
- - Xsky
- in: query
- items:
- type: string
- name: providers
- type: array
- x-go-name: Providers
- - in: query
- items:
- type: string
- name: brands
- type: array
- x-go-name: Brands
- - description: |-
- 列出指定云环境的资源,支持云环境如下:
- CloudEnv | 说明 |
- -----------|--------|
- public | 公有云 |
- private | 私有云 |
- onpremise | 本地IDC |
- enum:
- - public
- - private
- - onpremise
- in: query
- name: cloud_env
- type: string
- x-go-name: CloudEnv
- - description: 以平台名称排序
- in: query
- name: order_by_provider
- pattern: asc|desc
- type: string
- x-go-name: OrderByProvider
- - description: 以平台品牌排序
- in: query
- name: order_by_brand
- pattern: asc|desc
- type: string
- x-go-name: OrderByBrand
- - description: 服务类型
- in: query
- items:
- type: string
- name: service
- type: array
- x-go-name: Service
- - description: 订阅
- in: query
- items:
- type: string
- name: manager
- type: array
- x-go-name: Manager
- - description: 账号
- in: query
- items:
- type: string
- name: account
- type: array
- x-go-name: Account
- - description: 操作类型
- in: query
- items:
- type: string
- name: action
- type: array
- x-go-name: Action
- - description: 资源类别
- in: query
- items:
- type: string
- name: resource_type
- type: array
- x-go-name: ResourceType
- - description: 执行状态
- in: query
- name: success
- type: boolean
- x-go-name: Success
- - description: 操作日志起始时间
- format: date-time
- in: query
- name: since
- type: string
- x-go-name: Since
- - description: 操作日志截止时间
- format: date-time
- in: query
- name: until
- type: string
- x-go-name: Until
- responses:
- "200":
- $ref: '#/responses/cloudevent_ListItemFilterOutput'
- summary: 云平台操作日志列表
- tags:
- - cloudevent
- post:
- description: 新建
- operationId: cloudevent_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- cloudevent:
- $ref: '#/definitions/ModelBaseCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudevent_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - cloudevent
- /cloudevents/{id}:
- delete:
- description: 删除
- operationId: cloudevent_CustomizeDelete
- parameters:
- - description: The Id or Name of cloudevent
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudevent_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - cloudevent
- get:
- description: 获取详情
- operationId: cloudevent_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of cloudevent
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudevent_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - cloudevent
- put:
- description: 更新
- operationId: cloudevent_ValidateUpdateData
- parameters:
- - description: The Id or Name of cloudevent
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudevent:
- $ref: '#/definitions/ModelBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudevent_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - cloudevent
- /cloudevents/distinct-field:
- get:
- description: 获取指定资源类的信息DistinctField
- operationId: cloudevent_GetPropertyDistinctField
- parameters:
- - in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - in: query
- items:
- type: string
- name: extra_field
- type: array
- x-go-name: ExtraField
- responses:
- "200":
- $ref: '#/responses/cloudevent_GetPropertyDistinctFieldOutput'
- summary: 获取指定资源类的信息DistinctField
- tags:
- - cloudevent
- /cloudproviders:
- get:
- description: 列表
- operationId: cloudprovider_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如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或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和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')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- responses:
- "200":
- $ref: '#/responses/cloudprovider_ListItemFilterOutput'
- summary: 列表
- tags:
- - cloudprovider
- post:
- description: 新建
- operationId: cloudprovider_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- cloudprovider:
- $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudprovider_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - cloudprovider
- /cloudproviders/{id}:
- delete:
- description: 删除
- operationId: cloudprovider_CustomizeDelete
- parameters:
- - description: The Id or Name of cloudprovider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudprovider_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - cloudprovider
- get:
- description: 获取详情
- operationId: cloudprovider_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of cloudprovider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudprovider_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - cloudprovider
- put:
- description: 更新
- operationId: cloudprovider_ValidateUpdateData
- parameters:
- - description: The Id or Name of cloudprovider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudprovider:
- $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudprovider_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - cloudprovider
- /cloudproviders/{id}/disable:
- post:
- description: 执行操作Disable
- operationId: cloudprovider_PerformDisable
- parameters:
- - description: The Id or Name of cloudprovider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudprovider:
- $ref: '#/definitions/PerformDisableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudprovider_PerformDisableOutput'
- summary: 禁用资源
- tags:
- - cloudprovider
- /cloudproviders/{id}/enable:
- post:
- description: 执行操作Enable
- operationId: cloudprovider_PerformEnable
- parameters:
- - description: The Id or Name of cloudprovider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudprovider:
- $ref: '#/definitions/PerformEnableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudprovider_PerformEnableOutput'
- summary: 启用资源
- tags:
- - cloudprovider
- /cloudproviders/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: cloudprovider_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of cloudprovider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudprovider_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - cloudprovider
- /cloudproviders/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: cloudprovider_GetDetailsStatus
- parameters:
- - description: The Id or Name of cloudprovider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudprovider_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - cloudprovider
- produces:
- - application/json
- responses:
- cloudevent_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- cloudevent:
- $ref: '#/definitions/CloudeventDetails'
- type: object
- cloudevent_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- cloudevent:
- $ref: '#/definitions/CloudeventDetails'
- type: object
- cloudevent_GetPropertyDistinctFieldOutput:
- description: ""
- cloudevent_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- cloudevents:
- items:
- $ref: '#/definitions/CloudeventDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- cloudevent_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- cloudevent:
- $ref: '#/definitions/CloudeventDetails'
- type: object
- cloudevent_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- cloudevent:
- $ref: '#/definitions/CloudeventDetails'
- type: object
- cloudprovider_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- cloudprovider:
- $ref: '#/definitions/EnabledStatusStandaloneResourceDetails'
- type: object
- cloudprovider_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- cloudprovider:
- $ref: '#/definitions/EnabledStatusStandaloneResourceDetails'
- type: object
- cloudprovider_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- cloudprovider:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- cloudprovider_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- cloudprovider:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- cloudprovider_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- cloudproviders:
- items:
- $ref: '#/definitions/EnabledStatusStandaloneResourceDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- cloudprovider_PerformDisableOutput:
- description: ""
- cloudprovider_PerformEnableOutput:
- description: ""
- cloudprovider_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- cloudprovider:
- $ref: '#/definitions/EnabledStatusStandaloneResourceDetails'
- type: object
- cloudprovider_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- cloudprovider:
- $ref: '#/definitions/EnabledStatusStandaloneResourceDetails'
- type: object
- schemes:
- - https
- - http
- securityDefinitions:
- keystone:
- in: header
- name: X-Auth-Token
- type: apiKey
- swagger: "2.0"
|