mirror of
https://github.com/yunionio/cloudpods.git
synced 2026-07-01 23:04:20 +08:00
8912 lines
276 KiB
YAML
8912 lines
276 KiB
YAML
basePath: /
|
||
consumes:
|
||
- application/json
|
||
definitions:
|
||
ChangeOwnerCandidateDomainsOutput:
|
||
properties:
|
||
candidates:
|
||
items:
|
||
$ref: '#/definitions/SharedDomain'
|
||
type: array
|
||
x-go-name: Candidates
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
ConfigCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
attribution:
|
||
description: 'description: attribution'
|
||
enum:
|
||
- system
|
||
- domain
|
||
example: system
|
||
type: string
|
||
x-go-name: Attribution
|
||
content:
|
||
$ref: '#/definitions/SNotifyConfigContent'
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
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
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
type:
|
||
description: 'description: config type'
|
||
example: feishu
|
||
type: string
|
||
x-go-name: Type
|
||
required:
|
||
- name
|
||
- type
|
||
- content
|
||
- attribution
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ConfigDetails:
|
||
properties:
|
||
attribution:
|
||
type: string
|
||
x-go-name: Attribution
|
||
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
|
||
content:
|
||
$ref: '#/definitions/SNotifyConfigContent'
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
domain_src:
|
||
description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: DomainSrc
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
type:
|
||
type: string
|
||
x-go-name: Type
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ConfigManagerGetTypesInput:
|
||
properties:
|
||
domain_ids:
|
||
description: 'description: View the available notification channels for the
|
||
domains with these DomainIds'
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: DomainIds
|
||
operation:
|
||
description: 'description: Operation of reduce'
|
||
enum:
|
||
- union
|
||
- merge
|
||
type: string
|
||
x-go-name: Operation
|
||
receivers:
|
||
description: 'description: View the available notification channels for the
|
||
receivers'
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Receivers
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ConfigManagerGetTypesOutput:
|
||
properties:
|
||
types:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Types
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ConfigUpdateInput:
|
||
properties:
|
||
content:
|
||
$ref: '#/definitions/SNotifyConfigContent'
|
||
required:
|
||
- content
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ConfigValidateInput:
|
||
properties:
|
||
content:
|
||
$ref: '#/definitions/SNotifyConfigContent'
|
||
type:
|
||
description: 'description: config type'
|
||
example: feishu
|
||
type: string
|
||
x-go-name: Type
|
||
required:
|
||
- type
|
||
- content
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ConfigValidateOutput:
|
||
properties:
|
||
is_valid:
|
||
type: boolean
|
||
x-go-name: IsValid
|
||
message:
|
||
type: string
|
||
x-go-name: Message
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
EmailQueueCreateInput:
|
||
properties:
|
||
attachments:
|
||
items:
|
||
$ref: '#/definitions/SEmailAttachment'
|
||
type: array
|
||
x-go-name: Attachments
|
||
bcc:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Bcc
|
||
body:
|
||
type: string
|
||
x-go-name: Body
|
||
cc:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Cc
|
||
content:
|
||
description: 'swagger: ignore'
|
||
type: object
|
||
x-go-name: Content
|
||
dest:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: Dest
|
||
dest_bcc:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: DestBcc
|
||
dest_cc:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: DestCc
|
||
domain:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: Domain
|
||
domain_id:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: DomainId
|
||
project:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: Project
|
||
project_domain:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
project_domain_id:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
project_id:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: ProjectId
|
||
roles:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: Roles
|
||
session_id:
|
||
type: string
|
||
x-go-name: SessionId
|
||
subject:
|
||
type: string
|
||
x-go-name: Subject
|
||
to:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: To
|
||
user:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: User
|
||
user_id:
|
||
description: 'swagger: ignore'
|
||
type: string
|
||
x-go-name: UserId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
EmailQueueDetails:
|
||
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
|
||
content:
|
||
type: object
|
||
x-go-name: Content
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
dest:
|
||
type: string
|
||
x-go-name: Dest
|
||
dest_bcc:
|
||
type: string
|
||
x-go-name: DestBcc
|
||
dest_cc:
|
||
type: string
|
||
x-go-name: DestCc
|
||
domain:
|
||
type: string
|
||
x-go-name: Domain
|
||
domain_id:
|
||
type: string
|
||
x-go-name: DomainId
|
||
id:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Id
|
||
project:
|
||
type: string
|
||
x-go-name: Project
|
||
project_domain:
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
project_domain_id:
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
project_id:
|
||
type: string
|
||
x-go-name: ProjectId
|
||
recv_at:
|
||
format: date-time
|
||
type: string
|
||
x-go-name: RecvAt
|
||
results:
|
||
type: string
|
||
x-go-name: Results
|
||
roles:
|
||
type: string
|
||
x-go-name: Roles
|
||
sent_at:
|
||
format: date-time
|
||
type: string
|
||
x-go-name: SentAt
|
||
session_id:
|
||
type: string
|
||
x-go-name: SessionId
|
||
status:
|
||
type: string
|
||
x-go-name: Status
|
||
subject:
|
||
type: string
|
||
x-go-name: Subject
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
user:
|
||
type: string
|
||
x-go-name: User
|
||
user_id:
|
||
type: string
|
||
x-go-name: UserId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
EmailQueueSendInput:
|
||
properties:
|
||
sync:
|
||
type: boolean
|
||
x-go-name: Sync
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
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
|
||
FailedElem:
|
||
properties:
|
||
ContactType:
|
||
type: string
|
||
Reason:
|
||
type: string
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
GetDetailsStatusOutput:
|
||
properties:
|
||
status:
|
||
description: 状态
|
||
type: string
|
||
x-go-name: Status
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
Identification:
|
||
properties:
|
||
id:
|
||
example: 036fed49483b412888a760c2bc995caa
|
||
type: string
|
||
x-go-name: ID
|
||
name:
|
||
example: test
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
JoinResourceBaseCreateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
JointResourceBaseDetails:
|
||
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'
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
JointResourceBaseUpdateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
ModelBaseCreateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
ModelBaseDetails:
|
||
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'
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
ModelBaseUpdateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
NotificationCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
contact_type:
|
||
description: |-
|
||
description: contact type
|
||
required: ture
|
||
example: email
|
||
type: string
|
||
x-go-name: ContactType
|
||
contacts:
|
||
description: 'description: direct contact, admin privileges required'
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Contacts
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
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
|
||
ignore_nonexistent_receiver:
|
||
type: boolean
|
||
x-go-name: IgnoreNonexistentReceiver
|
||
is_emulated:
|
||
description: |-
|
||
资源是否为模拟资源
|
||
description: the resource is an emulated resource
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
message:
|
||
description: |-
|
||
description: message content or jsonobject
|
||
required: ture
|
||
type: string
|
||
x-go-name: Message
|
||
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
|
||
priority:
|
||
description: 'description: notification priority'
|
||
enum:
|
||
- fatal
|
||
- important
|
||
- nomal
|
||
example: normal
|
||
type: string
|
||
x-go-name: Priority
|
||
receivers:
|
||
description: 'description: ids or names of receiver'
|
||
example: '{"adfb720ccdd34c638346ea4fa7a713a8", "zhangsan"}'
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Receivers
|
||
robots:
|
||
description: 'description: robots'
|
||
example: feishu robot
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Robots
|
||
status:
|
||
description: 用来存储资源的状态
|
||
type: string
|
||
x-go-name: Status
|
||
tag:
|
||
description: 'description: notification tag'
|
||
example: alert
|
||
type: string
|
||
x-go-name: Tag
|
||
topic:
|
||
description: 'description: notification topic'
|
||
example: IMAGE_ACTIVE
|
||
type: string
|
||
x-go-name: Topic
|
||
required:
|
||
- name
|
||
- topic
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
NotificationDetails:
|
||
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
|
||
contact_type:
|
||
type: string
|
||
x-go-name: ContactType
|
||
content:
|
||
type: string
|
||
x-go-name: Content
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
event_id:
|
||
type: string
|
||
x-go-name: EventId
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
priority:
|
||
type: string
|
||
x-go-name: Priority
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
receive_details:
|
||
items:
|
||
$ref: '#/definitions/ReceiveDetail'
|
||
type: array
|
||
x-go-name: ReceiveDetails
|
||
received_at:
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ReceivedAt
|
||
send_times:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: SendTimes
|
||
status:
|
||
description: 资源状态
|
||
type: string
|
||
x-go-name: Status
|
||
title:
|
||
type: string
|
||
x-go-name: Title
|
||
topic_type:
|
||
type: string
|
||
x-go-name: TopicType
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
NotificationManagerEventNotifyInput:
|
||
properties:
|
||
Action:
|
||
$ref: '#/definitions/SAction'
|
||
CloudAccountName:
|
||
type: string
|
||
Event:
|
||
description: 'description: event trigger sending notification'
|
||
example: SERVER_DELETE
|
||
type: string
|
||
IsFailed:
|
||
$ref: '#/definitions/SResult'
|
||
ProjectDomainId:
|
||
description: 'description: domainId of the resource that triggered the event
|
||
notification'
|
||
example: default
|
||
type: string
|
||
ResourceType:
|
||
type: string
|
||
Result:
|
||
$ref: '#/definitions/SResult'
|
||
advance_days:
|
||
description: 'description: day left before the event'
|
||
example: 0
|
||
format: int64
|
||
type: integer
|
||
x-go-name: AdvanceDays
|
||
contact_type:
|
||
description: 'description: contact types'
|
||
example: email
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: ContactTypes
|
||
contacts:
|
||
description: 'description: direct contact, admin privileges required'
|
||
items:
|
||
$ref: '#/definitions/SContact'
|
||
type: array
|
||
x-go-name: Contacts
|
||
priority:
|
||
description: 'description: notification priority'
|
||
enum:
|
||
- fatal
|
||
- important
|
||
- nomal
|
||
example: normal
|
||
type: string
|
||
x-go-name: Priority
|
||
project_id:
|
||
description: 'description: projectId of the resource that triggered the event
|
||
notification'
|
||
example: f627e09f038645f08ce6880c8d9cb8fd
|
||
type: string
|
||
x-go-name: ProjectId
|
||
receiver_ids:
|
||
description: 'description: ids or names of receiver'
|
||
example: '{"adfb720ccdd34c638346ea4fa7a713a8"}'
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: ReceiverIds
|
||
resource_details:
|
||
description: |-
|
||
description: resource details
|
||
required: ture
|
||
type: object
|
||
x-go-name: ResourceDetails
|
||
required:
|
||
- Event
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
NotificationManagerEventNotifyOutput:
|
||
properties:
|
||
FailedList:
|
||
items:
|
||
$ref: '#/definitions/FailedElem'
|
||
type: array
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
PerformChangeDomainOwnerInput:
|
||
properties:
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformChangeProjectOwnerInput:
|
||
properties:
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
project_id:
|
||
description: 指定项目的名称或ID
|
||
type: string
|
||
x-go-name: ProjectId
|
||
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
|
||
PerformFreezeInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformPrivateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformPublicProjectInput:
|
||
properties:
|
||
scope:
|
||
description: 共享项目资源的共享范围,可能的值为:project, domain和system
|
||
pattern: project|domain|system
|
||
type: string
|
||
x-go-name: Scope
|
||
shared_domain_ids:
|
||
description: 如果共享范围为域,则在此列表中指定共享的目标域
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: SharedDomainIds
|
||
shared_project_ids:
|
||
description: 如果共享范围为项目,则在此列表中指定共享的目标项目
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: SharedProjectIds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformStatusInput:
|
||
properties:
|
||
host_id:
|
||
description: call from host id
|
||
type: string
|
||
x-go-name: HostId
|
||
power_states:
|
||
description: 电源状态
|
||
type: string
|
||
x-go-name: PowerStates
|
||
reason:
|
||
description: 更改状态的原因描述
|
||
type: string
|
||
x-go-name: Reason
|
||
status:
|
||
description: 更改的目标状态值
|
||
type: string
|
||
x-go-name: Status
|
||
required:
|
||
- status
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformUnfreezeInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
ProjectStatistic:
|
||
properties:
|
||
Count:
|
||
format: int64
|
||
type: integer
|
||
Id:
|
||
type: string
|
||
Name:
|
||
type: string
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PurgeSplitTableInput:
|
||
properties:
|
||
tables:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Tables
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
ReceiveDetail:
|
||
properties:
|
||
contact:
|
||
type: string
|
||
x-go-name: Contact
|
||
failed_reason:
|
||
type: string
|
||
x-go-name: FailedReason
|
||
receiver_id:
|
||
type: string
|
||
x-go-name: ReceiverId
|
||
receiver_name:
|
||
type: string
|
||
x-go-name: ReceiverName
|
||
receiver_type:
|
||
type: string
|
||
x-go-name: ReceiverType
|
||
send_by:
|
||
type: string
|
||
x-go-name: SendBy
|
||
sendAt:
|
||
format: date-time
|
||
type: string
|
||
x-go-name: SendAt
|
||
status:
|
||
type: string
|
||
x-go-name: Status
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ReceiverCreateInput:
|
||
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
|
||
email:
|
||
description: 'description: user email'
|
||
example: example@gmail.com
|
||
type: string
|
||
x-go-name: Email
|
||
enabled:
|
||
description: 该资源是否被管理员*人为*启用或者禁用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
enabled_contact_types:
|
||
description: 'description: enabled contact types for user'
|
||
example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}'
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: EnabledContactTypes
|
||
force_verified:
|
||
description: force verified if admin create the records
|
||
type: boolean
|
||
x-go-name: ForceVerified
|
||
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
|
||
international_mobile:
|
||
$ref: '#/definitions/SInternationalMobile'
|
||
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
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
status:
|
||
description: 用来存储资源的状态
|
||
type: string
|
||
x-go-name: Status
|
||
uid:
|
||
description: 'description: user id in keystone'
|
||
example: adfb720ccdd34c638346ea4fa7a713a8
|
||
type: string
|
||
x-go-name: UID
|
||
uname:
|
||
description: 'description: user name in keystone'
|
||
example: hello
|
||
type: string
|
||
x-go-name: UName
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ReceiverDetails:
|
||
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
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
domain_src:
|
||
description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: DomainSrc
|
||
email:
|
||
type: string
|
||
x-go-name: Email
|
||
enabled:
|
||
description: 资源是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
enabled_contact_types:
|
||
description: 'description: enabled contact types for user'
|
||
example: eamil, mobile, feishu, dingtalk, workwx
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: EnabledContactTypes
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
international_mobile:
|
||
$ref: '#/definitions/SInternationalMobile'
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
lang:
|
||
type: string
|
||
x-go-name: Lang
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
status:
|
||
description: 资源状态
|
||
type: string
|
||
x-go-name: Status
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
verified_infos:
|
||
description: 'description: verified info'
|
||
items:
|
||
$ref: '#/definitions/VerifiedInfo'
|
||
type: array
|
||
x-go-name: VerifiedInfos
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ReceiverEnableContactTypeInput:
|
||
properties:
|
||
enabled_contact_types:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: EnabledContactTypes
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ReceiverIntellijGetInput:
|
||
properties:
|
||
create_if_no:
|
||
description: 'description: create if receiver with UserId does not exist'
|
||
type: boolean
|
||
x-go-name: CreateIfNo
|
||
scope:
|
||
description: 'description: scope'
|
||
type: string
|
||
x-go-name: Scope
|
||
user_id:
|
||
description: 'description: user id in keystone'
|
||
type: string
|
||
x-go-name: UserId
|
||
required:
|
||
- user_id
|
||
- scope
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ReceiverTriggerVerifyInput:
|
||
properties:
|
||
contact_type:
|
||
description: 'description: contact type'
|
||
enum:
|
||
- email
|
||
- mobile
|
||
example: email
|
||
type: string
|
||
x-go-name: ContactType
|
||
required:
|
||
- contact_type
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ReceiverUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
email:
|
||
description: 'description: user email'
|
||
example: example@gmail.com
|
||
type: string
|
||
x-go-name: Email
|
||
enabled_contact_types:
|
||
description: 'description: enabled contacts for user'
|
||
example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}'
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: EnabledContactTypes
|
||
force_verified:
|
||
type: boolean
|
||
x-go-name: ForceVerified
|
||
international_mobile:
|
||
$ref: '#/definitions/SInternationalMobile'
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
ReceiverVerifyInput:
|
||
properties:
|
||
contact_type:
|
||
description: 'description: Contact type'
|
||
enum:
|
||
- email
|
||
- mobile
|
||
example: email
|
||
type: string
|
||
x-go-name: ContactType
|
||
token:
|
||
description: 'description: token user input'
|
||
example: "123456"
|
||
type: string
|
||
x-go-name: Token
|
||
required:
|
||
- contact_type
|
||
- token
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
RobotCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
address:
|
||
description: 'description: address'
|
||
example: http://helloworld.io/test/webhook
|
||
type: string
|
||
x-go-name: Address
|
||
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
|
||
is_public:
|
||
description: 是否共享
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
is_system:
|
||
description: 'description: indicate the resource is a system resource, which
|
||
is not visible to user'
|
||
type: boolean
|
||
x-go-name: IsSystem
|
||
lang:
|
||
description: 'description: Language preference'
|
||
example: zh_CN
|
||
type: string
|
||
x-go-name: Lang
|
||
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
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
project_id:
|
||
description: 指定项目的名称或ID
|
||
type: string
|
||
x-go-name: ProjectId
|
||
public_scope:
|
||
description: 共享范围
|
||
type: string
|
||
x-go-name: PublicScope
|
||
status:
|
||
description: 用来存储资源的状态
|
||
type: string
|
||
x-go-name: Status
|
||
type:
|
||
description: 'description: robot type'
|
||
enum:
|
||
- feishu
|
||
- dingtalk
|
||
- workwx
|
||
- webhook
|
||
example: webhook
|
||
type: string
|
||
x-go-name: Type
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
RobotDetails:
|
||
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
|
||
project:
|
||
description: |-
|
||
资源归属项目的名称(向后兼容别名)
|
||
Deprecated
|
||
type: string
|
||
x-go-name: Tenant
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
project_id:
|
||
description: |-
|
||
资源归属项目的ID(向后兼容别名)
|
||
Deprecated
|
||
type: string
|
||
x-go-name: TenantId
|
||
shared_domains:
|
||
description: 共享的域列表
|
||
items:
|
||
$ref: '#/definitions/SharedDomain'
|
||
type: array
|
||
x-go-name: SharedDomains
|
||
shared_projects:
|
||
description: 共享的项目列表
|
||
items:
|
||
$ref: '#/definitions/SharedProject'
|
||
type: array
|
||
x-go-name: SharedProjects
|
||
tenant:
|
||
description: |-
|
||
资源归属项目的名称
|
||
alias:project
|
||
type: string
|
||
x-go-name: Project
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
RobotUpdateInput:
|
||
properties:
|
||
address:
|
||
description: 'description: address'
|
||
example: http://helloworld.io/test/webhook
|
||
type: string
|
||
x-go-name: Address
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
lang:
|
||
description: 'description: Language preference'
|
||
example: en
|
||
type: string
|
||
x-go-name: Lang
|
||
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/notify
|
||
SAction:
|
||
type: string
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
SContact:
|
||
properties:
|
||
contact:
|
||
type: string
|
||
x-go-name: Contact
|
||
contact_type:
|
||
type: string
|
||
x-go-name: ContactType
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
SEmailAttachment:
|
||
properties:
|
||
content:
|
||
type: string
|
||
x-go-name: Base64Content
|
||
filename:
|
||
type: string
|
||
x-go-name: Filename
|
||
mime:
|
||
type: string
|
||
x-go-name: Mime
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
SInternationalMobile:
|
||
properties:
|
||
area_code:
|
||
description: 'description: area code of mobile'
|
||
example: "86"
|
||
type: string
|
||
x-go-name: AreaCode
|
||
mobile:
|
||
description: 'description: user mobile'
|
||
example: "17812345678"
|
||
type: string
|
||
x-go-name: Mobile
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
SNotifyConfigContent:
|
||
properties:
|
||
AccessKeyId:
|
||
description: sms
|
||
type: string
|
||
AccessKeySecret:
|
||
type: string
|
||
AccessToken:
|
||
type: string
|
||
AgentId:
|
||
description: workwx
|
||
type: string
|
||
AppId:
|
||
description: Lark
|
||
type: string
|
||
AppKey:
|
||
description: |-
|
||
dingtalk
|
||
AgentId string
|
||
AppSecret string
|
||
type: string
|
||
AppSecret:
|
||
type: string
|
||
CorpId:
|
||
type: string
|
||
Hostname:
|
||
description: Email
|
||
type: string
|
||
Hostport:
|
||
format: int64
|
||
type: integer
|
||
Password:
|
||
type: string
|
||
Secret:
|
||
type: string
|
||
SenderAddress:
|
||
type: string
|
||
ServiceUrl:
|
||
type: string
|
||
Signature:
|
||
type: string
|
||
SmsDriver:
|
||
type: string
|
||
SslGlobal:
|
||
type: boolean
|
||
Username:
|
||
type: string
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
SResult:
|
||
type: string
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
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
|
||
SharedDomain:
|
||
properties:
|
||
id:
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
SharedProject:
|
||
properties:
|
||
domain:
|
||
type: string
|
||
x-go-name: Domain
|
||
domain_id:
|
||
type: string
|
||
x-go-name: DomainId
|
||
id:
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
StandaloneAnonResourceBaseUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
StandaloneAnonResourceDetails:
|
||
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
|
||
StatusStandaloneResourceBaseUpdateInput:
|
||
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
|
||
StatusStatistic:
|
||
properties:
|
||
TotalCpuCount:
|
||
description: CPU总量
|
||
format: int64
|
||
type: integer
|
||
TotalDiskSizeMb:
|
||
description: 存储总量
|
||
format: int64
|
||
type: integer
|
||
TotalMemSizeMb:
|
||
description: 内存总量
|
||
format: int64
|
||
type: integer
|
||
status_info:
|
||
items:
|
||
$ref: '#/definitions/StatusStatisticStatusInfo'
|
||
type: array
|
||
x-go-name: StatusInfo
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
StatusStatisticStatusInfo:
|
||
properties:
|
||
Status:
|
||
type: string
|
||
pending_deleted_count:
|
||
description: |-
|
||
回收站数量
|
||
需要指定pending_delete=all
|
||
format: int64
|
||
type: integer
|
||
x-go-name: PendingDeletedCount
|
||
total_count:
|
||
description: 资源总数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: TotalCount
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
SubscriberChangeInput:
|
||
properties:
|
||
Receivers:
|
||
description: 'description: receivers which is required when the type is ''receiver''
|
||
will Subscribe TopicID'
|
||
items:
|
||
type: string
|
||
type: array
|
||
Robot:
|
||
description: 'description: Robot(Id or Name) which is required when the type
|
||
is ''robot'' will Subscribe TopicID'
|
||
type: string
|
||
Role:
|
||
description: 'description: Role(Id or Name) which is required when the type
|
||
is ''role'' will Subscribe TopicID'
|
||
type: string
|
||
RoleScope:
|
||
description: 'description: The scope of role subscribers'
|
||
enum:
|
||
- system
|
||
- domain
|
||
- project
|
||
type: string
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
SubscriberCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
DomainId:
|
||
description: 'description: domain id of resource'
|
||
example: 1e3824756bac4ac084e784ed297ec652
|
||
type: string
|
||
Receivers:
|
||
description: 'description: receivers which is required when the type is ''receiver''
|
||
will Subscribe TopicID'
|
||
items:
|
||
type: string
|
||
type: array
|
||
ResourceAttributionId:
|
||
description: 'description: project id or domain id of resource'
|
||
example: 1e3824756bac4ac084e784ed297ec652
|
||
type: string
|
||
ResourceAttributionName:
|
||
type: string
|
||
ResourceScope:
|
||
description: 'description: scope of resource'
|
||
enum:
|
||
- system
|
||
- domain
|
||
- project
|
||
type: string
|
||
Robot:
|
||
description: 'description: Robot(Id or Name) which is required when the type
|
||
is ''robot'' will Subscribe TopicID'
|
||
type: string
|
||
Role:
|
||
description: 'description: Role(Id or Name) which is required when the type
|
||
is ''role'' will Subscribe TopicID'
|
||
type: string
|
||
RoleScope:
|
||
description: 'description: The scope of role subscribers'
|
||
enum:
|
||
- system
|
||
- domain
|
||
- project
|
||
type: string
|
||
Scope:
|
||
description: 'description: scope'
|
||
enum:
|
||
- system
|
||
- domain
|
||
type: string
|
||
TopicID:
|
||
description: |-
|
||
description: Id of Topic
|
||
required
|
||
type: string
|
||
Type:
|
||
description: 'description: Type of subscriber'
|
||
enum:
|
||
- receiver
|
||
- robot
|
||
- role
|
||
type: string
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
is_emulated:
|
||
description: |-
|
||
资源是否为模拟资源
|
||
description: the resource is an emulated resource
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
SubscriberDetails:
|
||
properties:
|
||
Receivers:
|
||
description: 'description: receivers'
|
||
items:
|
||
$ref: '#/definitions/Identification'
|
||
type: array
|
||
Robot:
|
||
$ref: '#/definitions/Identification'
|
||
Role:
|
||
$ref: '#/definitions/Identification'
|
||
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
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
domain_id:
|
||
type: string
|
||
x-go-name: DomainId
|
||
enabled:
|
||
description: 资源是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
identification:
|
||
type: string
|
||
x-go-name: Identification
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
resource_attribution_id:
|
||
type: string
|
||
x-go-name: ResourceAttributionId
|
||
resource_attribution_name:
|
||
type: string
|
||
x-go-name: ResourceAttributionName
|
||
resource_scope:
|
||
type: string
|
||
x-go-name: ResourceScope
|
||
role_scope:
|
||
type: string
|
||
x-go-name: RoleScope
|
||
scope:
|
||
type: string
|
||
x-go-name: Scope
|
||
topic_id:
|
||
type: string
|
||
x-go-name: TopicId
|
||
type:
|
||
type: string
|
||
x-go-name: Type
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
SubscriberSetReceiverInput:
|
||
properties:
|
||
Receivers:
|
||
items:
|
||
type: string
|
||
type: array
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
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
|
||
TemplateCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
contact_type:
|
||
description: |-
|
||
description: Contact type, specifically, setting it to all means all contact type
|
||
require: true
|
||
example: email
|
||
type: string
|
||
x-go-name: ContactType
|
||
content:
|
||
description: 'description: Template content'
|
||
example: 镜像 {{.name}} 上传完成
|
||
type: string
|
||
x-go-name: Content
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
example:
|
||
description: 'description: Example for using this template'
|
||
example: '{"name": "centos7.6"}'
|
||
type: string
|
||
x-go-name: Example
|
||
is_emulated:
|
||
description: |-
|
||
资源是否为模拟资源
|
||
description: the resource is an emulated resource
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
lang:
|
||
description: 'description: Language'
|
||
enum:
|
||
- cn
|
||
- en
|
||
type: string
|
||
x-go-name: Lang
|
||
template_type:
|
||
description: 'description: Template type'
|
||
enum:
|
||
- title
|
||
- content
|
||
- remote
|
||
example: title
|
||
type: string
|
||
x-go-name: TemplateType
|
||
topic:
|
||
description: 'description: Template topic'
|
||
example: IMAGE_ACTIVE
|
||
type: string
|
||
x-go-name: Topic
|
||
required:
|
||
- topic
|
||
- content
|
||
- example
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
TemplateManagerSaveInput:
|
||
properties:
|
||
ContactType:
|
||
type: string
|
||
Force:
|
||
type: boolean
|
||
Templates:
|
||
items:
|
||
$ref: '#/definitions/TemplateCreateInput'
|
||
type: array
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
TemplateUpdateInput:
|
||
properties:
|
||
content:
|
||
description: 'description: template content'
|
||
example: 镜像 {{.name}} 上传完成
|
||
type: string
|
||
x-go-name: Content
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
example:
|
||
description: 'description: all example for using this template'
|
||
example: '{"name": "centos7.6"}'
|
||
type: string
|
||
x-go-name: Example
|
||
required:
|
||
- content
|
||
- example
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
TopicDetails:
|
||
properties:
|
||
actions:
|
||
format: uint32
|
||
type: integer
|
||
x-go-name: Actions
|
||
advance_days:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: AdvanceDays
|
||
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
|
||
content_cn:
|
||
type: string
|
||
x-go-name: ContentCn
|
||
content_en:
|
||
type: string
|
||
x-go-name: ContentEn
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
enabled:
|
||
description: 资源是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
resource_types:
|
||
description: 'description: resources managed'
|
||
example:
|
||
- server
|
||
- eip
|
||
- disk
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Resources
|
||
resources:
|
||
format: uint64
|
||
type: integer
|
||
x-go-name: Resources
|
||
results:
|
||
type: boolean
|
||
x-go-name: Results
|
||
status:
|
||
description: 资源状态
|
||
type: string
|
||
x-go-name: Status
|
||
title_cn:
|
||
type: string
|
||
x-go-name: TitleCn
|
||
title_en:
|
||
type: string
|
||
x-go-name: TitleEn
|
||
type:
|
||
type: string
|
||
x-go-name: Type
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
webconsole_disable:
|
||
type: boolean
|
||
x-go-name: WebconsoleDisable
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
VerifiedInfo:
|
||
properties:
|
||
ContactType:
|
||
type: string
|
||
Note:
|
||
type: string
|
||
Verified:
|
||
type: boolean
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
|
||
host: '"127.0.0.1:8889"'
|
||
info:
|
||
contact:
|
||
email: lizexi@yunion.cn
|
||
name: Zexi Li
|
||
description: Notify API
|
||
license:
|
||
name: Apache 2.0
|
||
url: http://www.apache.org/licenses/LICENSE-2.0.html
|
||
version: "1.0"
|
||
paths:
|
||
/configs:
|
||
get:
|
||
description: 列表
|
||
operationId: config_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
|
||
- $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: 指定查询的权限范围,可能值为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
|
||
- in: query
|
||
name: type
|
||
type: string
|
||
x-go-name: Type
|
||
- in: query
|
||
name: attribution
|
||
type: string
|
||
x-go-name: Attribution
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- config
|
||
post:
|
||
description: 新建
|
||
operationId: config_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/ConfigCreateInput'
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- config
|
||
/configs/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: config_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of config
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- config
|
||
get:
|
||
description: 获取详情
|
||
operationId: config_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of config
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- config
|
||
put:
|
||
description: 更新
|
||
operationId: config_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of config
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/ConfigUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- config
|
||
/configs/{id}/change-owner:
|
||
post:
|
||
description: 执行操作ChangeOwner
|
||
operationId: config_PerformChangeOwner
|
||
parameters:
|
||
- description: The Id or Name of config
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/PerformChangeDomainOwnerInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_PerformChangeOwnerOutput'
|
||
summary: 执行操作ChangeOwner
|
||
tags:
|
||
- config
|
||
/configs/{id}/change-owner-candidate-domains:
|
||
get:
|
||
description: 获取指定信息ChangeOwnerCandidateDomains
|
||
operationId: config_GetDetailsChangeOwnerCandidateDomains
|
||
parameters:
|
||
- description: The Id or Name of config
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_GetDetailsChangeOwnerCandidateDomainsOutput'
|
||
summary: 获取指定信息ChangeOwnerCandidateDomains
|
||
tags:
|
||
- config
|
||
/configs/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: config_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of config
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- config
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: config_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of config
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
config:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- config
|
||
/configs/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: config_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 config
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- config
|
||
/configs/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: config_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of config
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
config:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- config
|
||
/configs/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: config_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of config
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
config:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- config
|
||
/configs/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: config_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- config
|
||
/configs/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: config_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- config
|
||
/configs/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: config_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- config
|
||
/configs/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: config_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- config
|
||
/configs/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: config_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- config
|
||
/configs/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: config_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- config
|
||
/configs/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: config_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- config
|
||
/configs/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: config_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- config
|
||
/configs/validate:
|
||
post:
|
||
description: 执行操作Validate
|
||
operationId: config_PerformValidate
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/ConfigValidateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/config_PerformValidateOutput'
|
||
summary: 执行操作Validate
|
||
tags:
|
||
- config
|
||
/email_queue_statuses:
|
||
get:
|
||
description: 列表
|
||
operationId: email_queue_status_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
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_status_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- email_queue_status
|
||
post:
|
||
description: 新建
|
||
operationId: email_queue_status_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
email_queue_status:
|
||
$ref: '#/definitions/ModelBaseCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_status_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- email_queue_status
|
||
/email_queue_statuses/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: email_queue_status_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of email_queue_status
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_status_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- email_queue_status
|
||
get:
|
||
description: 获取详情
|
||
operationId: email_queue_status_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of email_queue_status
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_status_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- email_queue_status
|
||
put:
|
||
description: 更新
|
||
operationId: email_queue_status_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of email_queue_status
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
email_queue_status:
|
||
$ref: '#/definitions/ModelBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_status_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- email_queue_status
|
||
/email_queue_statuses/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: email_queue_status_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_status_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- email_queue_status
|
||
/email_queue_statuses/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: email_queue_status_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
email_queue_status:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_status_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- email_queue_status
|
||
/email_queue_statuses/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: email_queue_status_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_status_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- email_queue_status
|
||
/email_queue_statuses/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: email_queue_status_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_status_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- email_queue_status
|
||
/email_queues:
|
||
get:
|
||
description: 列表
|
||
operationId: email_queue_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
|
||
- in: query
|
||
items:
|
||
format: int64
|
||
type: integer
|
||
name: id
|
||
type: array
|
||
x-go-name: Id
|
||
- in: query
|
||
items:
|
||
type: string
|
||
name: to
|
||
type: array
|
||
x-go-name: To
|
||
- in: query
|
||
name: subject
|
||
type: string
|
||
x-go-name: Subject
|
||
- in: query
|
||
items:
|
||
type: string
|
||
name: session_id
|
||
type: array
|
||
x-go-name: SessionId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_ListItemFilterOutput'
|
||
summary: 宿主机/物理机列表
|
||
tags:
|
||
- email_queue
|
||
post:
|
||
description: 新建
|
||
operationId: email_queue_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
email_queue:
|
||
$ref: '#/definitions/EmailQueueCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- email_queue
|
||
/email_queues/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: email_queue_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of email_queue
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- email_queue
|
||
get:
|
||
description: 获取详情
|
||
operationId: email_queue_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of email_queue
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- email_queue
|
||
put:
|
||
description: 更新
|
||
operationId: email_queue_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of email_queue
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- email_queue
|
||
/email_queues/{id}/send:
|
||
post:
|
||
description: 执行操作Send
|
||
operationId: email_queue_PerformSend
|
||
parameters:
|
||
- description: The Id or Name of email_queue
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
email_queue:
|
||
$ref: '#/definitions/EmailQueueSendInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_PerformSendOutput'
|
||
summary: 执行操作Send
|
||
tags:
|
||
- email_queue
|
||
/email_queues/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: email_queue_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- email_queue
|
||
/email_queues/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: email_queue_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
email_queue:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- email_queue
|
||
/email_queues/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: email_queue_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- email_queue
|
||
/email_queues/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: email_queue_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/email_queue_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- email_queue
|
||
/events:
|
||
get:
|
||
description: 列表
|
||
operationId: event_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
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/event_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- event
|
||
post:
|
||
description: 新建
|
||
operationId: event_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
event:
|
||
$ref: '#/definitions/ModelBaseCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/event_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- event
|
||
/events/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: event_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of event
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/event_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- event
|
||
get:
|
||
description: 获取详情
|
||
operationId: event_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of event
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/event_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- event
|
||
put:
|
||
description: 更新
|
||
operationId: event_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of event
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/event_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- event
|
||
/events/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: event_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/event_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- event
|
||
/events/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: event_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
event:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/event_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- event
|
||
/events/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: event_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/event_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- event
|
||
/events/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: event_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/event_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- event
|
||
/notification_logs:
|
||
get:
|
||
description: 列表
|
||
operationId: notification_log_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
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_log_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- notification_log
|
||
post:
|
||
description: 新建
|
||
operationId: notification_log_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
notification_log:
|
||
$ref: '#/definitions/ModelBaseCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_log_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- notification_log
|
||
/notification_logs/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: notification_log_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of notification_log
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_log_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- notification_log
|
||
get:
|
||
description: 获取详情
|
||
operationId: notification_log_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of notification_log
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_log_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- notification_log
|
||
put:
|
||
description: 更新
|
||
operationId: notification_log_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of notification_log
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_log_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- notification_log
|
||
/notification_logs/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: notification_log_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_log_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- notification_log
|
||
/notification_logs/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: notification_log_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
notification_log:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_log_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- notification_log
|
||
/notification_logs/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: notification_log_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_log_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- notification_log
|
||
/notification_logs/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: notification_log_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_log_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- notification_log
|
||
/notifications:
|
||
get:
|
||
description: 列表
|
||
operationId: notification_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
|
||
- $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
|
||
- in: query
|
||
name: ContactType
|
||
type: string
|
||
- in: query
|
||
name: ReceiverId
|
||
type: string
|
||
- in: query
|
||
name: Tag
|
||
type: string
|
||
- in: query
|
||
name: TopicType
|
||
type: string
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_ListItemFilterOutput'
|
||
summary: 通知消息列表
|
||
tags:
|
||
- notification
|
||
post:
|
||
description: 新建
|
||
operationId: notification_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
notification:
|
||
$ref: '#/definitions/NotificationCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- notification
|
||
/notifications/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: notification_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of notification
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- notification
|
||
get:
|
||
description: 获取详情
|
||
operationId: notification_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of notification
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- notification
|
||
put:
|
||
description: 更新
|
||
operationId: notification_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of notification
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- notification
|
||
/notifications/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: notification_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of notification
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- notification
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: notification_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of notification
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
notification:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- notification
|
||
/notifications/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: notification_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 notification
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- notification
|
||
/notifications/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: notification_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of notification
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
notification:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- notification
|
||
/notifications/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: notification_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of notification
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
notification:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- notification
|
||
/notifications/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: notification_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of notification
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- notification
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: notification_PerformStatus
|
||
parameters:
|
||
- description: The Id or Name of notification
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- notification
|
||
/notifications/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: notification_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- notification
|
||
/notifications/event-notify:
|
||
post:
|
||
description: 执行操作EventNotify
|
||
operationId: notification_PerformEventNotify
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/NotificationManagerEventNotifyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_PerformEventNotifyOutput'
|
||
summary: 'TODO: support project and domain'
|
||
tags:
|
||
- notification
|
||
/notifications/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: notification_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- notification
|
||
/notifications/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: notification_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- notification
|
||
/notifications/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: notification_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- notification
|
||
/notifications/statistics:
|
||
get:
|
||
description: 获取指定资源类的信息Statistics
|
||
operationId: notification_GetPropertyStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_GetPropertyStatisticsOutput'
|
||
summary: 获取指定资源类的信息Statistics
|
||
tags:
|
||
- notification
|
||
/notifications/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: notification_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- notification
|
||
/notifications/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: notification_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/notification_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- notification
|
||
/receivers:
|
||
get:
|
||
description: 列表
|
||
operationId: receiver_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
|
||
- $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: 指定查询的权限范围,可能值为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: 以资源的状态过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: status
|
||
type: array
|
||
x-go-name: Status
|
||
- description: 以资源是否启用/禁用过滤列表
|
||
in: query
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
- in: query
|
||
name: uid
|
||
type: string
|
||
x-go-name: UID
|
||
- in: query
|
||
name: uname
|
||
type: string
|
||
x-go-name: UName
|
||
- in: query
|
||
name: enabled_contact_type
|
||
type: string
|
||
x-go-name: EnabledContactType
|
||
- in: query
|
||
name: verified_contact_type
|
||
type: string
|
||
x-go-name: VerifiedContactType
|
||
- in: query
|
||
name: project_domain_filter
|
||
type: boolean
|
||
x-go-name: ProjectDomainFilter
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- receiver
|
||
post:
|
||
description: 新建
|
||
operationId: receiver_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: receiver_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- receiver
|
||
get:
|
||
description: 获取详情
|
||
operationId: receiver_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- receiver
|
||
put:
|
||
description: 更新
|
||
operationId: receiver_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/change-owner:
|
||
post:
|
||
description: 执行操作ChangeOwner
|
||
operationId: receiver_PerformChangeOwner
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/PerformChangeDomainOwnerInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformChangeOwnerOutput'
|
||
summary: 执行操作ChangeOwner
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/change-owner-candidate-domains:
|
||
get:
|
||
description: 获取指定信息ChangeOwnerCandidateDomains
|
||
operationId: receiver_GetDetailsChangeOwnerCandidateDomains
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetDetailsChangeOwnerCandidateDomainsOutput'
|
||
summary: 获取指定信息ChangeOwnerCandidateDomains
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: receiver_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- receiver
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: receiver_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/disable:
|
||
post:
|
||
description: 执行操作Disable
|
||
operationId: receiver_PerformDisable
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/PerformDisableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformDisableOutput'
|
||
summary: 执行操作Disable
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/enable:
|
||
post:
|
||
description: 执行操作Enable
|
||
operationId: receiver_PerformEnable
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/PerformEnableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformEnableOutput'
|
||
summary: 执行操作Enable
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/enable-contact-type:
|
||
post:
|
||
description: 执行操作EnableContactType
|
||
operationId: receiver_PerformEnableContactType
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverEnableContactTypeInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformEnableContactTypeOutput'
|
||
summary: 执行操作EnableContactType
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/get-subscription:
|
||
post:
|
||
description: 执行操作GetSubscription
|
||
operationId: receiver_PerformGetSubscription
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverIntellijGetInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformGetSubscriptionOutput'
|
||
summary: 获取用户订阅
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: receiver_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 receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: receiver_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: receiver_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: receiver_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- receiver
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: receiver_PerformStatus
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/trigger-verify:
|
||
post:
|
||
description: 执行操作TriggerVerify
|
||
operationId: receiver_PerformTriggerVerify
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverTriggerVerifyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformTriggerVerifyOutput'
|
||
summary: 执行操作TriggerVerify
|
||
tags:
|
||
- receiver
|
||
/receivers/{id}/verify:
|
||
post:
|
||
description: 执行操作Verify
|
||
operationId: receiver_PerformVerify
|
||
parameters:
|
||
- description: The Id or Name of receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverVerifyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformVerifyOutput'
|
||
summary: 执行操作Verify
|
||
tags:
|
||
- receiver
|
||
/receivers/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: receiver_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- receiver
|
||
/receivers/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: receiver_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- receiver
|
||
/receivers/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: receiver_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- receiver
|
||
/receivers/get-types:
|
||
post:
|
||
description: 执行操作GetTypes
|
||
operationId: receiver_PerformGetTypes
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ConfigManagerGetTypesInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformGetTypesOutput'
|
||
summary: 执行操作GetTypes
|
||
tags:
|
||
- receiver
|
||
/receivers/intellij-get:
|
||
post:
|
||
description: 执行操作IntellijGet
|
||
operationId: receiver_PerformIntellijGet
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverIntellijGetInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformIntellijGetOutput'
|
||
summary: 执行操作IntellijGet
|
||
tags:
|
||
- receiver
|
||
/receivers/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: receiver_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- receiver
|
||
/receivers/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: receiver_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- receiver
|
||
/receivers/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: receiver_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- receiver
|
||
/receivers/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: receiver_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- receiver
|
||
/receivers/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: receiver_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/receiver_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- receiver
|
||
/robots:
|
||
get:
|
||
description: 列表
|
||
operationId: robot_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
|
||
- $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: 指定查询的权限范围,可能值为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: 指定项目的名称或ID
|
||
in: query
|
||
name: project_id
|
||
type: string
|
||
x-go-name: ProjectId
|
||
- description: 对具有项目属性的资源,严格匹配项目ID
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: project_ids
|
||
type: array
|
||
x-go-name: ProjectIds
|
||
- description: 按project名称排序,可能值为asc|desc
|
||
in: query
|
||
name: order_by_project
|
||
pattern: asc|desc
|
||
type: string
|
||
x-go-name: OrderByProject
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by project tags
|
||
in: query
|
||
name: project_tags
|
||
x-go-name: ProjectTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by no project tags
|
||
in: query
|
||
name: no_project_tags
|
||
x-go-name: NoProjectTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: |-
|
||
ignore
|
||
project tag fitlers imposed by policy
|
||
in: query
|
||
name: policy_project_tags
|
||
x-go-name: PolicyProjectTags
|
||
- description: 列表中包含标记为"系统资源"的资源
|
||
in: query
|
||
name: system
|
||
type: boolean
|
||
x-go-name: System
|
||
- description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
|
||
in: query
|
||
name: pending_delete
|
||
type: boolean
|
||
x-go-name: PendingDelete
|
||
- description: 以资源是否共享过滤列表
|
||
in: query
|
||
name: is_public
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
- description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
|
||
in: query
|
||
name: public_scope
|
||
type: string
|
||
x-go-name: PublicScope
|
||
- description: 以资源是否启用/禁用过滤列表
|
||
in: query
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
- description: 'description: robot type'
|
||
enum:
|
||
- feishu
|
||
- dingtalk
|
||
- workwx
|
||
- webhook
|
||
example: webhook
|
||
in: query
|
||
name: type
|
||
type: string
|
||
x-go-name: Type
|
||
- description: 'description: Language preference'
|
||
example: en
|
||
in: query
|
||
name: lang
|
||
type: string
|
||
x-go-name: Lang
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- robot
|
||
post:
|
||
description: 新建
|
||
operationId: robot_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
robot:
|
||
$ref: '#/definitions/RobotCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- robot
|
||
/robots/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: robot_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- robot
|
||
get:
|
||
description: 获取详情
|
||
operationId: robot_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- robot
|
||
put:
|
||
description: 更新
|
||
operationId: robot_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/RobotUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- robot
|
||
/robots/{id}/cancel-delete:
|
||
post:
|
||
description: 执行操作CancelDelete
|
||
operationId: robot_PerformCancelDelete
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformCancelDeleteOutput'
|
||
summary: 执行操作CancelDelete
|
||
tags:
|
||
- robot
|
||
/robots/{id}/change-owner:
|
||
post:
|
||
description: 执行操作ChangeOwner
|
||
operationId: robot_PerformChangeOwner
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/PerformChangeProjectOwnerInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformChangeOwnerOutput'
|
||
summary: 执行操作ChangeOwner
|
||
tags:
|
||
- robot
|
||
/robots/{id}/change-owner-candidate-domains:
|
||
get:
|
||
description: 获取指定信息ChangeOwnerCandidateDomains
|
||
operationId: robot_GetDetailsChangeOwnerCandidateDomains
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetDetailsChangeOwnerCandidateDomainsOutput'
|
||
summary: 获取指定信息ChangeOwnerCandidateDomains
|
||
tags:
|
||
- robot
|
||
/robots/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: robot_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- robot
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: robot_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- robot
|
||
/robots/{id}/disable:
|
||
post:
|
||
description: 执行操作Disable
|
||
operationId: robot_PerformDisable
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/PerformDisableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformDisableOutput'
|
||
summary: 执行操作Disable
|
||
tags:
|
||
- robot
|
||
/robots/{id}/enable:
|
||
post:
|
||
description: 执行操作Enable
|
||
operationId: robot_PerformEnable
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/PerformEnableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformEnableOutput'
|
||
summary: 执行操作Enable
|
||
tags:
|
||
- robot
|
||
/robots/{id}/freeze:
|
||
post:
|
||
description: 执行操作Freeze
|
||
operationId: robot_PerformFreeze
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/PerformFreezeInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformFreezeOutput'
|
||
summary: freezed update and perform action operation except for unfreeze
|
||
tags:
|
||
- robot
|
||
/robots/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: robot_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 robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- robot
|
||
/robots/{id}/private:
|
||
post:
|
||
description: 执行操作Private
|
||
operationId: robot_PerformPrivate
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/PerformPrivateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformPrivateOutput'
|
||
summary: 执行操作Private
|
||
tags:
|
||
- robot
|
||
/robots/{id}/public:
|
||
post:
|
||
description: 执行操作Public
|
||
operationId: robot_PerformPublic
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/PerformPublicProjectInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformPublicOutput'
|
||
summary: 执行操作Public
|
||
tags:
|
||
- robot
|
||
/robots/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: robot_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- robot
|
||
/robots/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: robot_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- robot
|
||
/robots/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: robot_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- robot
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: robot_PerformStatus
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- robot
|
||
/robots/{id}/unfreeze:
|
||
post:
|
||
description: 执行操作Unfreeze
|
||
operationId: robot_PerformUnfreeze
|
||
parameters:
|
||
- description: The Id or Name of robot
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/PerformUnfreezeInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformUnfreezeOutput'
|
||
summary: 执行操作Unfreeze
|
||
tags:
|
||
- robot
|
||
/robots/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: robot_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- robot
|
||
/robots/domain-statistics:
|
||
get:
|
||
description: 获取指定资源类的信息DomainStatistics
|
||
operationId: robot_GetPropertyDomainStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetPropertyDomainStatisticsOutput'
|
||
summary: 获取指定资源类的信息DomainStatistics
|
||
tags:
|
||
- robot
|
||
/robots/project-statistics:
|
||
get:
|
||
description: 获取指定资源类的信息ProjectStatistics
|
||
operationId: robot_GetPropertyProjectStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetPropertyProjectStatisticsOutput'
|
||
summary: 获取指定资源类的信息ProjectStatistics
|
||
tags:
|
||
- robot
|
||
/robots/project-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息ProjectTagValuePairs
|
||
operationId: robot_GetPropertyProjectTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetPropertyProjectTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息ProjectTagValuePairs
|
||
tags:
|
||
- robot
|
||
/robots/project-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息ProjectTagValueTree
|
||
operationId: robot_GetPropertyProjectTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetPropertyProjectTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息ProjectTagValueTree
|
||
tags:
|
||
- robot
|
||
/robots/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: robot_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- robot
|
||
/robots/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: robot_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- robot
|
||
/robots/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: robot_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- robot
|
||
/robots/statistics:
|
||
get:
|
||
description: 获取指定资源类的信息Statistics
|
||
operationId: robot_GetPropertyStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetPropertyStatisticsOutput'
|
||
summary: 获取指定资源类的信息Statistics
|
||
tags:
|
||
- robot
|
||
/robots/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: robot_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- robot
|
||
/robots/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: robot_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/robot_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- robot
|
||
/subscriber_receivers:
|
||
get:
|
||
description: 列表
|
||
operationId: subscriber_receiver_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
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_receiver_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- subscriber_receiver
|
||
post:
|
||
description: 新建
|
||
operationId: subscriber_receiver_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
subscriber_receiver:
|
||
$ref: '#/definitions/JoinResourceBaseCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_receiver_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- subscriber_receiver
|
||
/subscriber_receivers/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: subscriber_receiver_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of subscriber_receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_receiver_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- subscriber_receiver
|
||
get:
|
||
description: 获取详情
|
||
operationId: subscriber_receiver_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of subscriber_receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_receiver_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- subscriber_receiver
|
||
put:
|
||
description: 更新
|
||
operationId: subscriber_receiver_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of subscriber_receiver
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
subscriber_receiver:
|
||
$ref: '#/definitions/JointResourceBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_receiver_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- subscriber_receiver
|
||
/subscriber_receivers/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: subscriber_receiver_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_receiver_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- subscriber_receiver
|
||
/subscriber_receivers/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: subscriber_receiver_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
subscriber_receiver:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_receiver_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- subscriber_receiver
|
||
/subscriber_receivers/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: subscriber_receiver_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_receiver_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- subscriber_receiver
|
||
/subscriber_receivers/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: subscriber_receiver_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_receiver_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- subscriber_receiver
|
||
/subscribers:
|
||
get:
|
||
description: 列表
|
||
operationId: subscriber_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
|
||
- $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
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
- description: 'description: topic id'
|
||
in: query
|
||
name: TopicID
|
||
type: string
|
||
- description: 'description: scope of resource'
|
||
enum:
|
||
- system
|
||
- domain
|
||
- project
|
||
in: query
|
||
name: ResourceScope
|
||
type: string
|
||
- description: 'description: type'
|
||
enum:
|
||
- receiver
|
||
- robot
|
||
- role
|
||
in: query
|
||
name: Type
|
||
type: string
|
||
- description: 'description: scope'
|
||
enum:
|
||
- system
|
||
- domain
|
||
in: query
|
||
name: Scope
|
||
type: string
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- subscriber
|
||
post:
|
||
description: 新建
|
||
operationId: subscriber_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
subscriber:
|
||
$ref: '#/definitions/SubscriberCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- subscriber
|
||
/subscribers/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: subscriber_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- subscriber
|
||
get:
|
||
description: 获取详情
|
||
operationId: subscriber_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- subscriber
|
||
put:
|
||
description: 更新
|
||
operationId: subscriber_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
$ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- subscriber
|
||
/subscribers/{id}/change:
|
||
post:
|
||
description: 执行操作Change
|
||
operationId: subscriber_PerformChange
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
$ref: '#/definitions/SubscriberChangeInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_PerformChangeOutput'
|
||
summary: 执行操作Change
|
||
tags:
|
||
- subscriber
|
||
/subscribers/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: subscriber_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- subscriber
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: subscriber_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- subscriber
|
||
/subscribers/{id}/disable:
|
||
post:
|
||
description: 执行操作Disable
|
||
operationId: subscriber_PerformDisable
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_PerformDisableOutput'
|
||
summary: 执行操作Disable
|
||
tags:
|
||
- subscriber
|
||
/subscribers/{id}/enable:
|
||
post:
|
||
description: 执行操作Enable
|
||
operationId: subscriber_PerformEnable
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_PerformEnableOutput'
|
||
summary: 执行操作Enable
|
||
tags:
|
||
- subscriber
|
||
/subscribers/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: subscriber_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 subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- subscriber
|
||
/subscribers/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: subscriber_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- subscriber
|
||
/subscribers/{id}/set-receiver:
|
||
post:
|
||
description: 执行操作SetReceiver
|
||
operationId: subscriber_PerformSetReceiver
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
$ref: '#/definitions/SubscriberSetReceiverInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_PerformSetReceiverOutput'
|
||
summary: 执行操作SetReceiver
|
||
tags:
|
||
- subscriber
|
||
/subscribers/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: subscriber_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of subscriber
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- subscriber
|
||
/subscribers/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: subscriber_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- subscriber
|
||
/subscribers/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: subscriber_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- subscriber
|
||
/subscribers/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: subscriber_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- subscriber
|
||
/subscribers/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: subscriber_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- subscriber
|
||
/subscribers/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: subscriber_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- subscriber
|
||
/subscribers/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: subscriber_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/subscriber_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- subscriber
|
||
/templates:
|
||
get:
|
||
description: 列表
|
||
operationId: template_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
|
||
- $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: |-
|
||
description: Contact type, specifically, setting it to all means all contact type
|
||
require: true
|
||
example: email
|
||
in: query
|
||
name: contact_type
|
||
type: string
|
||
x-go-name: ContactType
|
||
- description: 'description: Template type'
|
||
enum:
|
||
- title
|
||
- content
|
||
- remote
|
||
example: title
|
||
in: query
|
||
name: template_type
|
||
type: string
|
||
x-go-name: TemplateType
|
||
- description: 'description: template topic'
|
||
example: IMAGE_ACTIVE
|
||
in: query
|
||
name: topic
|
||
required: true
|
||
type: string
|
||
x-go-name: Topic
|
||
- description: 'description: Language'
|
||
enum:
|
||
- cn
|
||
- en
|
||
in: query
|
||
name: lang
|
||
type: string
|
||
x-go-name: Lang
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- template
|
||
post:
|
||
description: 新建
|
||
operationId: template_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
template:
|
||
$ref: '#/definitions/TemplateCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- template
|
||
/templates/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: template_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of template
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- template
|
||
get:
|
||
description: 获取详情
|
||
operationId: template_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of template
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- template
|
||
put:
|
||
description: 更新
|
||
operationId: template_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of template
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
template:
|
||
$ref: '#/definitions/TemplateUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- template
|
||
/templates/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: template_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of template
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- template
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: template_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of template
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
template:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- template
|
||
/templates/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: template_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 template
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- template
|
||
/templates/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: template_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of template
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
template:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- template
|
||
/templates/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: template_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of template
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
template:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- template
|
||
/templates/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: template_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- template
|
||
/templates/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: template_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
template:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- template
|
||
/templates/save:
|
||
post:
|
||
description: 执行操作Save
|
||
operationId: template_PerformSave
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
template:
|
||
$ref: '#/definitions/TemplateManagerSaveInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_PerformSaveOutput'
|
||
summary: 执行操作Save
|
||
tags:
|
||
- template
|
||
/templates/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: template_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- template
|
||
/templates/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: template_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- template
|
||
/templates/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: template_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- template
|
||
/templates/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: template_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/template_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- template
|
||
/topics:
|
||
get:
|
||
description: 列表
|
||
operationId: topic_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
|
||
- $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
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- topic
|
||
post:
|
||
description: 新建
|
||
operationId: topic_ValidateCreateData
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- topic
|
||
/topics/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: topic_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- topic
|
||
get:
|
||
description: 获取详情
|
||
operationId: topic_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- topic
|
||
put:
|
||
description: 更新
|
||
operationId: topic_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- topic
|
||
/topics/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: topic_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- topic
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: topic_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
topic:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- topic
|
||
/topics/{id}/disable:
|
||
post:
|
||
description: 执行操作Disable
|
||
operationId: topic_PerformDisable
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
topic:
|
||
$ref: '#/definitions/PerformDisableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_PerformDisableOutput'
|
||
summary: 禁用资源
|
||
tags:
|
||
- topic
|
||
/topics/{id}/enable:
|
||
post:
|
||
description: 执行操作Enable
|
||
operationId: topic_PerformEnable
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
topic:
|
||
$ref: '#/definitions/PerformEnableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_PerformEnableOutput'
|
||
summary: 启用资源
|
||
tags:
|
||
- topic
|
||
/topics/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: topic_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 topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- topic
|
||
/topics/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: topic_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
topic:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- topic
|
||
/topics/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: topic_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
topic:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- topic
|
||
/topics/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: topic_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- topic
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: topic_PerformStatus
|
||
parameters:
|
||
- description: The Id or Name of topic
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
topic:
|
||
$ref: '#/definitions/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- topic
|
||
/topics/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: topic_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- topic
|
||
/topics/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: topic_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
topic:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- topic
|
||
/topics/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: topic_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- topic
|
||
/topics/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: topic_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- topic
|
||
/topics/statistics:
|
||
get:
|
||
description: 获取指定资源类的信息Statistics
|
||
operationId: topic_GetPropertyStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_GetPropertyStatisticsOutput'
|
||
summary: 获取指定资源类的信息Statistics
|
||
tags:
|
||
- topic
|
||
/topics/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: topic_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- topic
|
||
/topics/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: topic_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/topic_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- topic
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
config_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/ConfigDetails'
|
||
type: object
|
||
config_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/ConfigDetails'
|
||
type: object
|
||
config_GetDetailsChangeOwnerCandidateDomainsOutput:
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/ChangeOwnerCandidateDomainsOutput'
|
||
type: object
|
||
config_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
config:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
config_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
config:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
config_GetPropertyDistinctFieldOutput: {}
|
||
config_GetPropertyDomainTagValuePairsOutput: {}
|
||
config_GetPropertyDomainTagValueTreeOutput: {}
|
||
config_GetPropertySplitableExportOutput: {}
|
||
config_GetPropertySplitableOutput: {}
|
||
config_GetPropertyTagValuePairsOutput: {}
|
||
config_GetPropertyTagValueTreeOutput: {}
|
||
config_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
configs:
|
||
items:
|
||
$ref: '#/definitions/ConfigDetails'
|
||
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
|
||
config_PerformChangeOwnerOutput: {}
|
||
config_PerformClassMetadataOutput: {}
|
||
config_PerformPurgeSplitableOutput: {}
|
||
config_PerformSetClassMetadataOutput: {}
|
||
config_PerformSetUserMetadataOutput: {}
|
||
config_PerformValidateOutput:
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/ConfigValidateOutput'
|
||
type: object
|
||
config_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/ConfigDetails'
|
||
type: object
|
||
config_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
config:
|
||
$ref: '#/definitions/ConfigDetails'
|
||
type: object
|
||
email_queue_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
email_queue:
|
||
$ref: '#/definitions/EmailQueueDetails'
|
||
type: object
|
||
email_queue_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
email_queue:
|
||
$ref: '#/definitions/EmailQueueDetails'
|
||
type: object
|
||
email_queue_GetPropertyDistinctFieldOutput: {}
|
||
email_queue_GetPropertySplitableExportOutput: {}
|
||
email_queue_GetPropertySplitableOutput: {}
|
||
email_queue_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
email_queues:
|
||
items:
|
||
$ref: '#/definitions/EmailQueueDetails'
|
||
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
|
||
email_queue_PerformPurgeSplitableOutput: {}
|
||
email_queue_PerformSendOutput: {}
|
||
email_queue_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
email_queue:
|
||
$ref: '#/definitions/EmailQueueDetails'
|
||
type: object
|
||
email_queue_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
email_queue:
|
||
$ref: '#/definitions/EmailQueueDetails'
|
||
type: object
|
||
email_queue_status_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
email_queue_status:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
email_queue_status_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
email_queue_status:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
email_queue_status_GetPropertyDistinctFieldOutput: {}
|
||
email_queue_status_GetPropertySplitableExportOutput: {}
|
||
email_queue_status_GetPropertySplitableOutput: {}
|
||
email_queue_status_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
email_queue_statuses:
|
||
items:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
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
|
||
email_queue_status_PerformPurgeSplitableOutput: {}
|
||
email_queue_status_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
email_queue_status:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
email_queue_status_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
email_queue_status:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
event_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
event:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
event_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
event:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
event_GetPropertyDistinctFieldOutput: {}
|
||
event_GetPropertySplitableExportOutput: {}
|
||
event_GetPropertySplitableOutput: {}
|
||
event_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
events:
|
||
items:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
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
|
||
event_PerformPurgeSplitableOutput: {}
|
||
event_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
event:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
event_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
event:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
notification_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/NotificationDetails'
|
||
type: object
|
||
notification_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/NotificationDetails'
|
||
type: object
|
||
notification_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
notification:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
notification_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
notification:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
notification_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
notification_GetPropertyDistinctFieldOutput: {}
|
||
notification_GetPropertySplitableExportOutput: {}
|
||
notification_GetPropertySplitableOutput: {}
|
||
notification_GetPropertyStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/StatusStatistic'
|
||
type: object
|
||
notification_GetPropertyTagValuePairsOutput: {}
|
||
notification_GetPropertyTagValueTreeOutput: {}
|
||
notification_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
notifications:
|
||
items:
|
||
$ref: '#/definitions/NotificationDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
notification_PerformClassMetadataOutput: {}
|
||
notification_PerformEventNotifyOutput:
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/NotificationManagerEventNotifyOutput'
|
||
type: object
|
||
notification_PerformPurgeSplitableOutput: {}
|
||
notification_PerformSetClassMetadataOutput: {}
|
||
notification_PerformSetUserMetadataOutput: {}
|
||
notification_PerformStatusOutput: {}
|
||
notification_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/NotificationDetails'
|
||
type: object
|
||
notification_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
notification:
|
||
$ref: '#/definitions/NotificationDetails'
|
||
type: object
|
||
notification_log_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
notification_log:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
notification_log_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
notification_log:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
notification_log_GetPropertyDistinctFieldOutput: {}
|
||
notification_log_GetPropertySplitableExportOutput: {}
|
||
notification_log_GetPropertySplitableOutput: {}
|
||
notification_log_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
notification_logs:
|
||
items:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
notification_log_PerformPurgeSplitableOutput: {}
|
||
notification_log_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
notification_log:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
notification_log_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
notification_log:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
receiver_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverDetails'
|
||
type: object
|
||
receiver_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverDetails'
|
||
type: object
|
||
receiver_GetDetailsChangeOwnerCandidateDomainsOutput:
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ChangeOwnerCandidateDomainsOutput'
|
||
type: object
|
||
receiver_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
receiver_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
receiver_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
receiver_GetPropertyDistinctFieldOutput: {}
|
||
receiver_GetPropertyDomainTagValuePairsOutput: {}
|
||
receiver_GetPropertyDomainTagValueTreeOutput: {}
|
||
receiver_GetPropertySplitableExportOutput: {}
|
||
receiver_GetPropertySplitableOutput: {}
|
||
receiver_GetPropertyTagValuePairsOutput: {}
|
||
receiver_GetPropertyTagValueTreeOutput: {}
|
||
receiver_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
receivers:
|
||
items:
|
||
$ref: '#/definitions/ReceiverDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
receiver_PerformChangeOwnerOutput: {}
|
||
receiver_PerformClassMetadataOutput: {}
|
||
receiver_PerformDisableOutput: {}
|
||
receiver_PerformEnableContactTypeOutput: {}
|
||
receiver_PerformEnableOutput: {}
|
||
receiver_PerformGetSubscriptionOutput: {}
|
||
receiver_PerformGetTypesOutput:
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ConfigManagerGetTypesOutput'
|
||
type: object
|
||
receiver_PerformIntellijGetOutput: {}
|
||
receiver_PerformPurgeSplitableOutput: {}
|
||
receiver_PerformSetClassMetadataOutput: {}
|
||
receiver_PerformSetUserMetadataOutput: {}
|
||
receiver_PerformStatusOutput: {}
|
||
receiver_PerformTriggerVerifyOutput: {}
|
||
receiver_PerformVerifyOutput: {}
|
||
receiver_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverDetails'
|
||
type: object
|
||
receiver_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
receiver:
|
||
$ref: '#/definitions/ReceiverDetails'
|
||
type: object
|
||
robot_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/RobotDetails'
|
||
type: object
|
||
robot_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/RobotDetails'
|
||
type: object
|
||
robot_GetDetailsChangeOwnerCandidateDomainsOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/ChangeOwnerCandidateDomainsOutput'
|
||
type: object
|
||
robot_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
robot_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
robot_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
robot_GetPropertyDistinctFieldOutput: {}
|
||
robot_GetPropertyDomainStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
items:
|
||
$ref: '#/definitions/ProjectStatistic'
|
||
type: array
|
||
x-go-name: Output
|
||
type: object
|
||
robot_GetPropertyProjectStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
items:
|
||
$ref: '#/definitions/ProjectStatistic'
|
||
type: array
|
||
x-go-name: Output
|
||
type: object
|
||
robot_GetPropertyProjectTagValuePairsOutput: {}
|
||
robot_GetPropertyProjectTagValueTreeOutput: {}
|
||
robot_GetPropertySplitableExportOutput: {}
|
||
robot_GetPropertySplitableOutput: {}
|
||
robot_GetPropertyStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/StatusStatistic'
|
||
type: object
|
||
robot_GetPropertyTagValuePairsOutput: {}
|
||
robot_GetPropertyTagValueTreeOutput: {}
|
||
robot_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
robots:
|
||
items:
|
||
$ref: '#/definitions/RobotDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
robot_PerformCancelDeleteOutput: {}
|
||
robot_PerformChangeOwnerOutput: {}
|
||
robot_PerformClassMetadataOutput: {}
|
||
robot_PerformDisableOutput: {}
|
||
robot_PerformEnableOutput: {}
|
||
robot_PerformFreezeOutput: {}
|
||
robot_PerformPrivateOutput: {}
|
||
robot_PerformPublicOutput: {}
|
||
robot_PerformPurgeSplitableOutput: {}
|
||
robot_PerformSetClassMetadataOutput: {}
|
||
robot_PerformSetUserMetadataOutput: {}
|
||
robot_PerformStatusOutput: {}
|
||
robot_PerformUnfreezeOutput: {}
|
||
robot_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/RobotDetails'
|
||
type: object
|
||
robot_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
robot:
|
||
$ref: '#/definitions/RobotDetails'
|
||
type: object
|
||
subscriber_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
$ref: '#/definitions/SubscriberDetails'
|
||
type: object
|
||
subscriber_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
$ref: '#/definitions/SubscriberDetails'
|
||
type: object
|
||
subscriber_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
subscriber_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
subscriber_GetPropertyDistinctFieldOutput: {}
|
||
subscriber_GetPropertySplitableExportOutput: {}
|
||
subscriber_GetPropertySplitableOutput: {}
|
||
subscriber_GetPropertyTagValuePairsOutput: {}
|
||
subscriber_GetPropertyTagValueTreeOutput: {}
|
||
subscriber_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
subscribers:
|
||
items:
|
||
$ref: '#/definitions/SubscriberDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
subscriber_PerformChangeOutput: {}
|
||
subscriber_PerformClassMetadataOutput: {}
|
||
subscriber_PerformDisableOutput: {}
|
||
subscriber_PerformEnableOutput: {}
|
||
subscriber_PerformPurgeSplitableOutput: {}
|
||
subscriber_PerformSetClassMetadataOutput: {}
|
||
subscriber_PerformSetReceiverOutput: {}
|
||
subscriber_PerformSetUserMetadataOutput: {}
|
||
subscriber_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
$ref: '#/definitions/SubscriberDetails'
|
||
type: object
|
||
subscriber_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
subscriber:
|
||
$ref: '#/definitions/SubscriberDetails'
|
||
type: object
|
||
subscriber_receiver_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
subscriber_receiver:
|
||
$ref: '#/definitions/JointResourceBaseDetails'
|
||
type: object
|
||
subscriber_receiver_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
subscriber_receiver:
|
||
$ref: '#/definitions/JointResourceBaseDetails'
|
||
type: object
|
||
subscriber_receiver_GetPropertyDistinctFieldOutput: {}
|
||
subscriber_receiver_GetPropertySplitableExportOutput: {}
|
||
subscriber_receiver_GetPropertySplitableOutput: {}
|
||
subscriber_receiver_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
subscriber_receivers:
|
||
items:
|
||
$ref: '#/definitions/JointResourceBaseDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
subscriber_receiver_PerformPurgeSplitableOutput: {}
|
||
subscriber_receiver_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
subscriber_receiver:
|
||
$ref: '#/definitions/JointResourceBaseDetails'
|
||
type: object
|
||
subscriber_receiver_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
subscriber_receiver:
|
||
$ref: '#/definitions/JointResourceBaseDetails'
|
||
type: object
|
||
template_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
template:
|
||
$ref: '#/definitions/StandaloneAnonResourceDetails'
|
||
type: object
|
||
template_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
template:
|
||
$ref: '#/definitions/StandaloneAnonResourceDetails'
|
||
type: object
|
||
template_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
template:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
template_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
template:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
template_GetPropertyDistinctFieldOutput: {}
|
||
template_GetPropertySplitableExportOutput: {}
|
||
template_GetPropertySplitableOutput: {}
|
||
template_GetPropertyTagValuePairsOutput: {}
|
||
template_GetPropertyTagValueTreeOutput: {}
|
||
template_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
templates:
|
||
items:
|
||
$ref: '#/definitions/StandaloneAnonResourceDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
template_PerformClassMetadataOutput: {}
|
||
template_PerformPurgeSplitableOutput: {}
|
||
template_PerformSaveOutput: {}
|
||
template_PerformSetClassMetadataOutput: {}
|
||
template_PerformSetUserMetadataOutput: {}
|
||
template_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
template:
|
||
$ref: '#/definitions/StandaloneAnonResourceDetails'
|
||
type: object
|
||
template_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
template:
|
||
$ref: '#/definitions/StandaloneAnonResourceDetails'
|
||
type: object
|
||
topic_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
topic:
|
||
$ref: '#/definitions/TopicDetails'
|
||
type: object
|
||
topic_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
topic:
|
||
$ref: '#/definitions/TopicDetails'
|
||
type: object
|
||
topic_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
topic:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
topic_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
topic:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
topic_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
topic:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
topic_GetPropertyDistinctFieldOutput: {}
|
||
topic_GetPropertySplitableExportOutput: {}
|
||
topic_GetPropertySplitableOutput: {}
|
||
topic_GetPropertyStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
topic:
|
||
$ref: '#/definitions/StatusStatistic'
|
||
type: object
|
||
topic_GetPropertyTagValuePairsOutput: {}
|
||
topic_GetPropertyTagValueTreeOutput: {}
|
||
topic_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
topics:
|
||
items:
|
||
$ref: '#/definitions/TopicDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
topic_PerformClassMetadataOutput: {}
|
||
topic_PerformDisableOutput: {}
|
||
topic_PerformEnableOutput: {}
|
||
topic_PerformPurgeSplitableOutput: {}
|
||
topic_PerformSetClassMetadataOutput: {}
|
||
topic_PerformSetUserMetadataOutput: {}
|
||
topic_PerformStatusOutput: {}
|
||
topic_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
topic:
|
||
$ref: '#/definitions/TopicDetails'
|
||
type: object
|
||
topic_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
topic:
|
||
$ref: '#/definitions/TopicDetails'
|
||
type: object
|
||
schemes:
|
||
- https
|
||
- http
|
||
securityDefinitions:
|
||
keystone:
|
||
in: header
|
||
name: X-Auth-Token
|
||
type: apiKey
|
||
swagger: "2.0"
|