opensource/cloudpods
3
0
Fork 0
mirror of https://github.com/yunionio/cloudpods.git synced 2026-08-28 19:45:07 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
cloudpods/docs/swagger/swagger_notify.yaml
T
屈轩 4c32b50e67 fix(docs): update api doc (#24289)
2026-02-09 19:18:33 +08:00

8103 lines
324 KiB
YAML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
basePath: /
consumes:
- application/json
definitions:
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
org_node_md5:
description: 用以组织架构变更通知其他服务权限变更
type: string
x-go-name: OrgNodeMd5
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
more_datails:
additionalProperties:
type: string
type: object
x-go-name: MoreDetails
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
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
more_details:
type: object
x-go-name: MoreDetails
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:
contact_type:
type: string
x-go-name: ContactType
reason:
type: string
x-go-name: Reason
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
org_node_md5:
description: 用以组织架构变更通知其他服务权限变更
type: string
x-go-name: OrgNodeMd5
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
NotificationManagerContactNotifyInput:
properties:
body:
type: string
x-go-name: Body
contact_type:
description: 'description: contact types'
example: email
items:
type: string
type: array
x-go-name: ContactTypes
receiver_ids:
description: 'description: ids or names of receiver'
example: '{"adfb720ccdd34c638346ea4fa7a713a8"}'
items:
type: string
type: array
x-go-name: ReceiverIds
robot_ids:
description: 'description: ids of robot'
example: '{"adfb720ccdd34c638346ea4fa7a713a8"}'
items:
type: string
type: array
x-go-name: RobotIds
role_ids:
items:
type: string
type: array
x-go-name: RoleIds
subject:
type: string
x-go-name: Subject
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
NotificationManagerEventNotifyInput:
properties:
action:
$ref: '#/definitions/SAction'
advance_days:
description: 'description: day left before the event'
example: 0
format: int64
type: integer
x-go-name: AdvanceDays
cloud_account_name:
type: string
x-go-name: CloudAccountName
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
event:
description: 'description: event trigger sending notification'
example: SERVER_DELETE
type: string
x-go-name: Event
is_failed:
$ref: '#/definitions/SResult'
priority:
description: 'description: notification priority'
enum:
- fatal
- important
- nomal
example: normal
type: string
x-go-name: Priority
project_domain_id:
description: 'description: domainId of the resource that triggered the event notification'
example: default
type: string
x-go-name: ProjectDomainId
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
resource_type:
type: string
x-go-name: ResourceType
result:
$ref: '#/definitions/SResult'
robot_ids:
description: 消息机器人列表
items:
type: string
type: array
x-go-name: RobotIds
required:
- event
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
NotificationManagerEventNotifyOutput:
properties:
failed_list:
items:
$ref: '#/definitions/FailedElem'
type: array
x-go-name: FailedList
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
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
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
is_system:
description: 'description: indicate the resource is a system resource, which is not visible to user'
type: boolean
x-go-name: IsSystem
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
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
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
freezed:
description: 资源是否被冻结
type: boolean
x-go-name: Freezed
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
is_system:
description: 是否是系统资源
type: boolean
x-go-name: IsSystem
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
org_node_md5:
description: 用以组织架构变更通知其他服务权限变更
type: string
x-go-name: OrgNodeMd5
pending_deleted:
description: 资源是否处于回收站中
type: boolean
x-go-name: PendingDeleted
pending_deleted_at:
description: 资源放入回收站时间
format: date-time
type: string
x-go-name: PendingDeletedAt
progress:
description: 操作进度0-100
format: float
type: number
x-go-name: Progress
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
project_metadata:
additionalProperties:
type: string
type: object
x-go-name: ProjectMetadata
project_src:
description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过'
example: local
type: string
x-go-name: ProjectSrc
status:
description: 资源状态
type: string
x-go-name: Status
tenant:
description: |-
资源归属项目的名称
alias:project
type: string
x-go-name: Project
tenant_id:
description: 项目Id
type: string
x-go-name: ProjectId
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
ReceiverGetSubscriptionOptions:
properties:
id:
type: string
x-go-name: Id
show_disabled:
type: boolean
x-go-name: ShowDisabled
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
progress:
format: float
type: number
x-go-name: Progress
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
ResourceBaseCreateInput:
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis
ResourceBaseDetails:
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
ResourceBaseUpdateInput:
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis
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
body:
type: object
x-go-name: Body
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
header:
type: object
x-go-name: Header
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
msg_key:
type: string
x-go-name: MsgKey
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
secret_key:
type: string
x-go-name: SecretKey
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
use_template:
$ref: '#/definitions/TriState'
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
project_metadata:
additionalProperties:
type: string
type: object
x-go-name: ProjectMetadata
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
body:
type: object
x-go-name: Body
description:
description: 资源描述
type: string
x-go-name: Description
header:
type: object
x-go-name: Header
lang:
description: 'description: Language preference'
example: en
type: string
x-go-name: Lang
msg_key:
type: string
x-go-name: MsgKey
name:
description: 资源名称
type: string
x-go-name: Name
progress:
format: float
type: number
x-go-name: Progress
secret_key:
type: string
x-go-name: SecretKey
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:
access_key_id:
type: string
x-go-name: AccessKeyId
access_key_secret:
type: string
x-go-name: AccessKeySecret
access_token:
type: string
x-go-name: AccessToken
access_token_expire_time:
format: date-time
type: string
x-go-name: AccessTokenExpireTime
agent_id:
description: workwx
type: string
x-go-name: AgentId
alerts_code:
type: string
x-go-name: AlertsCode
app_id:
description: Lark
type: string
x-go-name: AppId
app_key:
description: |-
dingtalk
AgentId string
AppSecret string
type: string
x-go-name: AppKey
app_secret:
type: string
x-go-name: AppSecret
corp_id:
type: string
x-go-name: CorpId
error_code:
type: string
x-go-name: ErrorCode
hostname:
description: Email
type: string
x-go-name: Hostname
hostport:
format: int64
type: integer
x-go-name: Hostport
password:
type: string
x-go-name: Password
phone_number:
type: string
x-go-name: PhoneNumber
secret:
type: string
x-go-name: Secret
sender_address:
type: string
x-go-name: SenderAddress
service_url:
type: string
x-go-name: ServiceUrl
signature:
type: string
x-go-name: Signature
sms_driver:
type: string
x-go-name: SmsDriver
ssl_global:
type: boolean
x-go-name: SslGlobal
username:
type: string
x-go-name: Username
verifiy_code:
description: sms
type: string
x-go-name: VerifiyCode
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
STopicCreateInput:
properties:
__meta__:
additionalProperties:
type: string
description: 标签列表,最多支持20个
example:
user:rd: op
type: object
x-go-name: Metadata
actions:
items:
type: string
type: array
x-go-name: Actions
advance_days:
items:
format: int64
type: integer
type: array
x-go-name: AdvanceDays
content_cn:
type: string
x-go-name: ContentCn
content_en:
type: string
x-go-name: ContentEn
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
group_keys:
$ref: '#/definitions/STopicGroupKeys'
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
resources:
items:
type: string
type: array
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
webconsole_disable:
type: boolean
x-go-name: WebconsoleDisable
required:
- name
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
STopicGroupKeys:
items:
type: string
type: array
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
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
SubscriberChangeInput:
properties:
group_times:
description: minutes
format: uint32
type: integer
x-go-name: GroupTimes
receivers:
description: 'description: receivers which is required when the type is ''receiver'' will Subscribe TopicID'
items:
type: string
type: array
x-go-name: Receivers
robot:
description: 'description: Robot(Id or Name) which is required when the type is ''robot'' will Subscribe TopicID'
type: string
x-go-name: Robot
role:
description: 'description: Role(Id or Name) which is required when the type is ''role'' will Subscribe TopicID'
type: string
x-go-name: Role
role_scope:
description: 'description: The scope of role subscribers'
enum:
- system
- domain
- project
type: string
x-go-name: RoleScope
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
description:
description: 资源描述
example: test create network
type: string
x-go-name: Description
domain_id:
description: 'description: domain id of resource'
example: 1e3824756bac4ac084e784ed297ec652
type: string
x-go-name: DomainId
dry_run:
default: false
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
type: boolean
x-go-name: DryRun
group_times:
description: minutes
format: uint32
type: integer
x-go-name: GroupTimes
is_emulated:
description: |-
资源是否为模拟资源
description: the resource is an emulated resource
type: boolean
x-go-name: IsEmulated
receivers:
description: 'description: receivers which is required when the type is ''receiver'' will Subscribe TopicID'
items:
type: string
type: array
x-go-name: Receivers
resource_attribution_id:
description: 'description: project id or domain id of resource'
example: 1e3824756bac4ac084e784ed297ec652
type: string
x-go-name: ResourceAttributionId
resource_attribution_name:
type: string
x-go-name: ResourceAttributionName
resource_scope:
description: 'description: scope of resource'
enum:
- system
- domain
- project
type: string
x-go-name: ResourceScope
robot:
description: 'description: Robot(Id or Name) which is required when the type is ''robot'' will Subscribe TopicID'
type: string
x-go-name: Robot
role:
description: 'description: Role(Id or Name) which is required when the type is ''role'' will Subscribe TopicID'
type: string
x-go-name: Role
role_scope:
description: 'description: The scope of role subscribers'
enum:
- system
- domain
- project
type: string
x-go-name: RoleScope
scope:
description: 'description: scope'
enum:
- system
- domain
type: string
x-go-name: Scope
topic_id:
description: |-
description: Id of Topic
required
type: string
x-go-name: TopicID
type:
description: 'description: Type of subscriber'
enum:
- receiver
- robot
- role
type: string
x-go-name: Type
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
SubscriberDetails:
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:
type: string
x-go-name: DomainId
enabled:
description: 资源是否启用
type: boolean
x-go-name: Enabled
group_times:
description: minutes
format: uint32
type: integer
x-go-name: GroupTimes
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
org_node_md5:
description: 用以组织架构变更通知其他服务权限变更
type: string
x-go-name: OrgNodeMd5
receivers:
description: 'description: receivers'
items:
$ref: '#/definitions/Identification'
type: array
x-go-name: Receivers
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
robot:
$ref: '#/definitions/Identification'
role:
$ref: '#/definitions/Identification'
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
x-go-name: Receivers
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:
contact_type:
type: string
x-go-name: ContactType
force:
type: boolean
x-go-name: Force
templates:
items:
$ref: '#/definitions/TemplateCreateInput'
type: array
x-go-name: Templates
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:
items:
type: string
type: array
x-go-name: Actions
advance_days:
items:
format: int64
type: integer
type: array
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
group_keys:
$ref: '#/definitions/STopicGroupKeys'
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
org_node_md5:
description: 用以组织架构变更通知其他服务权限变更
type: string
x-go-name: OrgNodeMd5
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
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
TopicUpdateInput:
properties:
actions:
items:
type: string
type: array
x-go-name: Actions
advance_days:
items:
format: int64
type: integer
type: array
x-go-name: AdvanceDays
content_cn:
type: string
x-go-name: ContentCn
content_en:
type: string
x-go-name: ContentEn
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
resources:
items:
type: string
type: array
x-go-name: Resources
title_cn:
type: string
x-go-name: TitleCn
title_en:
type: string
x-go-name: TitleEn
webconsole_disable:
type: boolean
x-go-name: WebconsoleDisable
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
TriState:
type: string
x-go-package: yunion.io/x/pkg/tristate
VerifiedInfo:
properties:
contact_type:
type: string
x-go-name: ContactType
note:
type: string
x-go-name: Note
verified:
type: boolean
x-go-name: Verified
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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
name: tags
x-go-name: Tags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还包含这些标签，OR的关系）
in: query
name: obj_tags
x-go-name: ObjTags
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（不包含这些标签）
in: query
name: no_tags
x-go-name: NoTags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
in: query
name: no_obj_tags
x-go-name: NoObjTags
- description: 通过标签排序
in: query
name: order_by_tag
type: string
x-go-name: OrderByTag
- description: |-
deprecated
返回资源的标签不包含用户标签
in: query
name: without_user_meta
type: boolean
x-go-name: WithoutUserMeta
- description: 返回包含用户标签的资源
in: query
name: with_user_meta
type: boolean
x-go-name: WithUserMeta
- description: 返回包含外部标签的资源
in: query
name: with_cloud_meta
type: boolean
x-go-name: WithCloudMeta
- description: 返回包含任意标签的资源
in: query
name: with_any_meta
type: boolean
x-go-name: WithAnyMeta
- description: 返回列表数据中包含资源的标签数据（Metadata）
in: query
name: with_meta
type: boolean
x-go-name: WithMeta
- description: 显示所有的资源，包括模拟的资源
in: query
name: show_emulated
type: boolean
x-go-name: ShowEmulated
- description: 以资源ID过滤列表
in: query
items:
type: string
name: id
type: array
x-go-name: Ids
- description: 以资源名称过滤列表
in: query
items:
type: string
name: name
type: array
x-go-name: Names
- description: 指定查询的权限范围，可能值为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: 更改项目
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/capability:
get:
description: 获取指定资源类的信息Capability
operationId: config_GetPropertyCapability
responses:
"200":
$ref: '#/responses/config_GetPropertyCapabilityOutput'
summary: 获取指定资源类的信息Capability
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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
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_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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- in: query
items:
type: string
name: id
type: array
x-go-name: Id
- description: Id []int `json:"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
/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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- in: query
items:
type: string
name: id
type: array
x-go-name: Id
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
/notification_groups:
get:
description: 列表
operationId: notification_group_ListItemFilter
parameters:
- default: 20
description: 查询限制量
format: int64
in: query
name: limit
type: integer
x-go-name: Limit
- default: 0
description: 查询偏移量
format: int64
in: query
name: offset
type: integer
x-go-name: Offset
- description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。
in: query
items:
type: string
name: order_by
type: array
x-go-name: OrderBy
- description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。
example: desc|asc
in: query
name: order
type: string
x-go-name: Order
- description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。
in: query
name: details
type: boolean
x-go-name: Details
- description: 模糊搜索所有字段
in: query
name: search
type: string
x-go-name: Search
- description: |-
指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test')
支持的操作符如下：
操作符 | 参数个数 | 举例 | 说明 |
---------------|----------|------------------------------------------------|-----------------------------|
in | > 0 | name.in("test", "good") | 在给定数组中 |
notin | > 0 | name.notin('test') | 不在给定数组中 |
between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
equals | > 0 | name.equals('test') | 等于任意一个给定值 |
notequals | 1 | name.notequals('test') | 不等于给定值 |
isnull | 0 | name.isnull() | 值为SQL的NULL |
isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
isempty | 0 | name.isempty('test') | 值为空字符串 |
isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
in: query
items:
type: string
name: filter
type: array
x-go-name: Filter
- description: |-
指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同，
和其他表关联的语法如下：
joint_resources.related_key(origin_key).filter_col.filter_ops(values)
其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为
关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值
举例：
guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
in: query
items:
type: string
name: joint_filter
type: array
x-go-name: JointFilter
- description: 如果filter_any为true，则查询所有filter的并集，否则为交集
in: query
name: filter_any
type: boolean
x-go-name: FilterAny
- description: 返回结果只包含指定的字段
in: query
items:
type: string
name: field
type: array
x-go-name: Field
- description: 用于数据导出，指定导出的数据字段
in: query
name: export_keys
type: string
x-go-name: ExportKeys
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
in: query
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
responses:
"200":
$ref: '#/responses/notification_group_ListItemFilterOutput'
summary: 列表
tags:
- notification_group
post:
description: 新建
operationId: notification_group_ValidateCreateData
parameters:
- in: body
name: body
schema:
properties:
count:
default: 1
format: int64
type: integer
x-go-name: Count
notification_group:
$ref: '#/definitions/ModelBaseCreateInput'
type: object
x-go-name: Body
responses:
"200":
$ref: '#/responses/notification_group_ValidateCreateDataOutput'
summary: 新建
tags:
- notification_group
/notification_groups/{id}:
delete:
description: 删除
operationId: notification_group_CustomizeDelete
parameters:
- description: The Id or Name of notification_group
in: path
name: id
required: true
type: string
x-go-name: Id
responses:
"200":
$ref: '#/responses/notification_group_CustomizeDeleteOutput'
summary: 删除
tags:
- notification_group
get:
description: 获取详情
operationId: notification_group_FetchCustomizeColumns
parameters:
- description: The Id or Name of notification_group
in: path
name: id
required: true
type: string
x-go-name: Id
responses:
"200":
$ref: '#/responses/notification_group_FetchCustomizeColumnsOutput'
summary: 获取详情
tags:
- notification_group
put:
description: 更新
operationId: notification_group_ValidateUpdateData
parameters:
- description: The Id or Name of notification_group
in: path
name: id
required: true
type: string
x-go-name: Id
- in: body
name: body
schema:
properties:
notification_group:
$ref: '#/definitions/ModelBaseUpdateInput'
type: object
x-go-name: Body
responses:
"200":
$ref: '#/responses/notification_group_ValidateUpdateDataOutput'
summary: 更新
tags:
- notification_group
/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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- in: query
items:
type: string
name: id
type: array
x-go-name: Id
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
/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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
name: tags
x-go-name: Tags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还包含这些标签，OR的关系）
in: query
name: obj_tags
x-go-name: ObjTags
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（不包含这些标签）
in: query
name: no_tags
x-go-name: NoTags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
in: query
name: no_obj_tags
x-go-name: NoObjTags
- description: 通过标签排序
in: query
name: order_by_tag
type: string
x-go-name: OrderByTag
- description: |-
deprecated
返回资源的标签不包含用户标签
in: query
name: without_user_meta
type: boolean
x-go-name: WithoutUserMeta
- description: 返回包含用户标签的资源
in: query
name: with_user_meta
type: boolean
x-go-name: WithUserMeta
- description: 返回包含外部标签的资源
in: query
name: with_cloud_meta
type: boolean
x-go-name: WithCloudMeta
- description: 返回包含任意标签的资源
in: query
name: with_any_meta
type: boolean
x-go-name: WithAnyMeta
- description: 返回列表数据中包含资源的标签数据（Metadata）
in: query
name: with_meta
type: boolean
x-go-name: WithMeta
- description: 显示所有的资源，包括模拟的资源
in: query
name: show_emulated
type: boolean
x-go-name: ShowEmulated
- description: 以资源ID过滤列表
in: query
items:
type: string
name: id
type: array
x-go-name: Ids
- description: 以资源名称过滤列表
in: query
items:
type: string
name: name
type: array
x-go-name: Names
- description: 以资源的状态过滤列表
in: query
items:
type: string
name: status
type: array
x-go-name: Status
- in: query
name: contact_type
type: string
x-go-name: ContactType
- in: query
name: receiver_id
type: string
x-go-name: ReceiverId
- in: query
name: tag
type: string
x-go-name: Tag
- in: query
name: topic_type
type: string
x-go-name: TopicType
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}/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}/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
/notifications/contact-notify:
post:
description: 执行操作ContactNotify
operationId: notification_PerformContactNotify
parameters:
- in: body
name: body
schema:
properties:
notification:
$ref: '#/definitions/NotificationManagerContactNotifyInput'
type: object
x-go-name: Body
responses:
"200":
$ref: '#/responses/notification_PerformContactNotifyOutput'
summary: 执行操作ContactNotify
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
/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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
name: tags
x-go-name: Tags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还包含这些标签，OR的关系）
in: query
name: obj_tags
x-go-name: ObjTags
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（不包含这些标签）
in: query
name: no_tags
x-go-name: NoTags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
in: query
name: no_obj_tags
x-go-name: NoObjTags
- description: 通过标签排序
in: query
name: order_by_tag
type: string
x-go-name: OrderByTag
- description: |-
deprecated
返回资源的标签不包含用户标签
in: query
name: without_user_meta
type: boolean
x-go-name: WithoutUserMeta
- description: 返回包含用户标签的资源
in: query
name: with_user_meta
type: boolean
x-go-name: WithUserMeta
- description: 返回包含外部标签的资源
in: query
name: with_cloud_meta
type: boolean
x-go-name: WithCloudMeta
- description: 返回包含任意标签的资源
in: query
name: with_any_meta
type: boolean
x-go-name: WithAnyMeta
- description: 返回列表数据中包含资源的标签数据（Metadata）
in: query
name: with_meta
type: boolean
x-go-name: WithMeta
- description: 显示所有的资源，包括模拟的资源
in: query
name: show_emulated
type: boolean
x-go-name: ShowEmulated
- description: 以资源ID过滤列表
in: query
items:
type: string
name: id
type: array
x-go-name: Ids
- description: 以资源名称过滤列表
in: query
items:
type: string
name: name
type: array
x-go-name: Names
- description: 以资源的状态过滤列表
in: query
items:
type: string
name: status
type: array
x-go-name: Status
- description: 指定查询的权限范围，可能值为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
- description: filter by project organizations
in: query
items:
type: string
name: project_organizations
type: array
x-go-name: ProjectOrganizations
- $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: 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/PerformChangeProjectOwnerInput'
type: object
x-go-name: Body
responses:
"200":
$ref: '#/responses/receiver_PerformChangeOwnerOutput'
summary: 更改项目
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/ReceiverGetSubscriptionOptions'
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}/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
/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/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/role-contact-type:
get:
description: 获取指定资源类的信息RoleContactType
operationId: receiver_GetPropertyRoleContactType
parameters:
- in: query
items:
type: string
name: role_ids
type: array
x-go-name: RoleIds
- in: query
name: scope
type: string
x-go-name: Scope
- in: query
name: project_domain_id
type: string
x-go-name: ProjectDomainId
- in: query
name: project_id
type: string
x-go-name: ProjectId
responses:
"200":
$ref: '#/responses/receiver_GetPropertyRoleContactTypeOutput'
summary: 获取指定资源类的信息RoleContactType
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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
name: tags
x-go-name: Tags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还包含这些标签，OR的关系）
in: query
name: obj_tags
x-go-name: ObjTags
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（不包含这些标签）
in: query
name: no_tags
x-go-name: NoTags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
in: query
name: no_obj_tags
x-go-name: NoObjTags
- description: 通过标签排序
in: query
name: order_by_tag
type: string
x-go-name: OrderByTag
- description: |-
deprecated
返回资源的标签不包含用户标签
in: query
name: without_user_meta
type: boolean
x-go-name: WithoutUserMeta
- description: 返回包含用户标签的资源
in: query
name: with_user_meta
type: boolean
x-go-name: WithUserMeta
- description: 返回包含外部标签的资源
in: query
name: with_cloud_meta
type: boolean
x-go-name: WithCloudMeta
- description: 返回包含任意标签的资源
in: query
name: with_any_meta
type: boolean
x-go-name: WithAnyMeta
- description: 返回列表数据中包含资源的标签数据（Metadata）
in: query
name: with_meta
type: boolean
x-go-name: WithMeta
- description: 显示所有的资源，包括模拟的资源
in: query
name: show_emulated
type: boolean
x-go-name: ShowEmulated
- description: 以资源ID过滤列表
in: query
items:
type: string
name: id
type: array
x-go-name: Ids
- description: 以资源名称过滤列表
in: query
items:
type: string
name: name
type: array
x-go-name: Names
- description: 以资源的状态过滤列表
in: query
items:
type: string
name: status
type: array
x-go-name: Status
- description: 指定查询的权限范围，可能值为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
- description: filter by project organizations
in: query
items:
type: string
name: project_organizations
type: array
x-go-name: ProjectOrganizations
- $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}/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: 更改项目
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}/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}/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
/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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
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
/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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
name: tags
x-go-name: Tags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还包含这些标签，OR的关系）
in: query
name: obj_tags
x-go-name: ObjTags
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（不包含这些标签）
in: query
name: no_tags
x-go-name: NoTags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
in: query
name: no_obj_tags
x-go-name: NoObjTags
- description: 通过标签排序
in: query
name: order_by_tag
type: string
x-go-name: OrderByTag
- description: |-
deprecated
返回资源的标签不包含用户标签
in: query
name: without_user_meta
type: boolean
x-go-name: WithoutUserMeta
- description: 返回包含用户标签的资源
in: query
name: with_user_meta
type: boolean
x-go-name: WithUserMeta
- description: 返回包含外部标签的资源
in: query
name: with_cloud_meta
type: boolean
x-go-name: WithCloudMeta
- description: 返回包含任意标签的资源
in: query
name: with_any_meta
type: boolean
x-go-name: WithAnyMeta
- description: 返回列表数据中包含资源的标签数据（Metadata）
in: query
name: with_meta
type: boolean
x-go-name: WithMeta
- description: 显示所有的资源，包括模拟的资源
in: query
name: show_emulated
type: boolean
x-go-name: ShowEmulated
- description: 以资源ID过滤列表
in: query
items:
type: string
name: id
type: array
x-go-name: Ids
- description: 以资源是否启用/禁用过滤列表
in: query
name: enabled
type: boolean
x-go-name: Enabled
- description: 'description: topic id'
in: query
name: topic_id
type: string
x-go-name: TopicID
- description: 'description: scope of resource'
enum:
- system
- domain
- project
in: query
name: resource_scope
type: string
x-go-name: ResourceScope
- description: 'description: type'
enum:
- receiver
- robot
- role
in: query
name: type
type: string
x-go-name: Type
- description: 'description: scope'
enum:
- system
- domain
in: query
name: scope
type: string
x-go-name: Scope
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}/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-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
/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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
name: tags
x-go-name: Tags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还包含这些标签，OR的关系）
in: query
name: obj_tags
x-go-name: ObjTags
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（不包含这些标签）
in: query
name: no_tags
x-go-name: NoTags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
in: query
name: no_obj_tags
x-go-name: NoObjTags
- description: 通过标签排序
in: query
name: order_by_tag
type: string
x-go-name: OrderByTag
- description: |-
deprecated
返回资源的标签不包含用户标签
in: query
name: without_user_meta
type: boolean
x-go-name: WithoutUserMeta
- description: 返回包含用户标签的资源
in: query
name: with_user_meta
type: boolean
x-go-name: WithUserMeta
- description: 返回包含外部标签的资源
in: query
name: with_cloud_meta
type: boolean
x-go-name: WithCloudMeta
- description: 返回包含任意标签的资源
in: query
name: with_any_meta
type: boolean
x-go-name: WithAnyMeta
- description: 返回列表数据中包含资源的标签数据（Metadata）
in: query
name: with_meta
type: boolean
x-go-name: WithMeta
- description: 显示所有的资源，包括模拟的资源
in: query
name: show_emulated
type: boolean
x-go-name: ShowEmulated
- description: 以资源ID过滤列表
in: query
items:
type: string
name: id
type: array
x-go-name: Ids
- description: |-
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}/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/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
/topic_actions:
get:
description: 列表
operationId: topic_action_ListItemFilter
parameters:
- default: 20
description: 查询限制量
format: int64
in: query
name: limit
type: integer
x-go-name: Limit
- default: 0
description: 查询偏移量
format: int64
in: query
name: offset
type: integer
x-go-name: Offset
- description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。
in: query
items:
type: string
name: order_by
type: array
x-go-name: OrderBy
- description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。
example: desc|asc
in: query
name: order
type: string
x-go-name: Order
- description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。
in: query
name: details
type: boolean
x-go-name: Details
- description: 模糊搜索所有字段
in: query
name: search
type: string
x-go-name: Search
- description: |-
指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test')
支持的操作符如下：
操作符 | 参数个数 | 举例 | 说明 |
---------------|----------|------------------------------------------------|-----------------------------|
in | > 0 | name.in("test", "good") | 在给定数组中 |
notin | > 0 | name.notin('test') | 不在给定数组中 |
between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
equals | > 0 | name.equals('test') | 等于任意一个给定值 |
notequals | 1 | name.notequals('test') | 不等于给定值 |
isnull | 0 | name.isnull() | 值为SQL的NULL |
isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
isempty | 0 | name.isempty('test') | 值为空字符串 |
isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
in: query
items:
type: string
name: filter
type: array
x-go-name: Filter
- description: |-
指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同，
和其他表关联的语法如下：
joint_resources.related_key(origin_key).filter_col.filter_ops(values)
其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为
关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值
举例：
guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
in: query
items:
type: string
name: joint_filter
type: array
x-go-name: JointFilter
- description: 如果filter_any为true，则查询所有filter的并集，否则为交集
in: query
name: filter_any
type: boolean
x-go-name: FilterAny
- description: 返回结果只包含指定的字段
in: query
items:
type: string
name: field
type: array
x-go-name: Field
- description: 用于数据导出，指定导出的数据字段
in: query
name: export_keys
type: string
x-go-name: ExportKeys
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
in: query
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
responses:
"200":
$ref: '#/responses/topic_action_ListItemFilterOutput'
summary: 列表
tags:
- topic_action
post:
description: 新建
operationId: topic_action_ValidateCreateData
parameters:
- in: body
name: body
schema:
properties:
count:
default: 1
format: int64
type: integer
x-go-name: Count
topic_action:
$ref: '#/definitions/ResourceBaseCreateInput'
type: object
x-go-name: Body
responses:
"200":
$ref: '#/responses/topic_action_ValidateCreateDataOutput'
summary: 新建
tags:
- topic_action
/topic_actions/{id}:
delete:
description: 删除
operationId: topic_action_CustomizeDelete
parameters:
- description: The Id or Name of topic_action
in: path
name: id
required: true
type: string
x-go-name: Id
responses:
"200":
$ref: '#/responses/topic_action_CustomizeDeleteOutput'
summary: 删除
tags:
- topic_action
get:
description: 获取详情
operationId: topic_action_FetchCustomizeColumns
parameters:
- description: The Id or Name of topic_action
in: path
name: id
required: true
type: string
x-go-name: Id
responses:
"200":
$ref: '#/responses/topic_action_FetchCustomizeColumnsOutput'
summary: 获取详情
tags:
- topic_action
put:
description: 更新
operationId: topic_action_ValidateUpdateData
parameters:
- description: The Id or Name of topic_action
in: path
name: id
required: true
type: string
x-go-name: Id
- in: body
name: body
schema:
properties:
topic_action:
$ref: '#/definitions/ResourceBaseUpdateInput'
type: object
x-go-name: Body
responses:
"200":
$ref: '#/responses/topic_action_ValidateUpdateDataOutput'
summary: 更新
tags:
- topic_action
/topic_resources:
get:
description: 列表
operationId: topic_resource_ListItemFilter
parameters:
- default: 20
description: 查询限制量
format: int64
in: query
name: limit
type: integer
x-go-name: Limit
- default: 0
description: 查询偏移量
format: int64
in: query
name: offset
type: integer
x-go-name: Offset
- description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。
in: query
items:
type: string
name: order_by
type: array
x-go-name: OrderBy
- description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。
example: desc|asc
in: query
name: order
type: string
x-go-name: Order
- description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。
in: query
name: details
type: boolean
x-go-name: Details
- description: 模糊搜索所有字段
in: query
name: search
type: string
x-go-name: Search
- description: |-
指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test')
支持的操作符如下：
操作符 | 参数个数 | 举例 | 说明 |
---------------|----------|------------------------------------------------|-----------------------------|
in | > 0 | name.in("test", "good") | 在给定数组中 |
notin | > 0 | name.notin('test') | 不在给定数组中 |
between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
equals | > 0 | name.equals('test') | 等于任意一个给定值 |
notequals | 1 | name.notequals('test') | 不等于给定值 |
isnull | 0 | name.isnull() | 值为SQL的NULL |
isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
isempty | 0 | name.isempty('test') | 值为空字符串 |
isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
in: query
items:
type: string
name: filter
type: array
x-go-name: Filter
- description: |-
指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同，
和其他表关联的语法如下：
joint_resources.related_key(origin_key).filter_col.filter_ops(values)
其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为
关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值
举例：
guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
in: query
items:
type: string
name: joint_filter
type: array
x-go-name: JointFilter
- description: 如果filter_any为true，则查询所有filter的并集，否则为交集
in: query
name: filter_any
type: boolean
x-go-name: FilterAny
- description: 返回结果只包含指定的字段
in: query
items:
type: string
name: field
type: array
x-go-name: Field
- description: 用于数据导出，指定导出的数据字段
in: query
name: export_keys
type: string
x-go-name: ExportKeys
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
in: query
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
responses:
"200":
$ref: '#/responses/topic_resource_ListItemFilterOutput'
summary: 列表
tags:
- topic_resource
post:
description: 新建
operationId: topic_resource_ValidateCreateData
parameters:
- in: body
name: body
schema:
properties:
count:
default: 1
format: int64
type: integer
x-go-name: Count
topic_resource:
$ref: '#/definitions/ResourceBaseCreateInput'
type: object
x-go-name: Body
responses:
"200":
$ref: '#/responses/topic_resource_ValidateCreateDataOutput'
summary: 新建
tags:
- topic_resource
/topic_resources/{id}:
delete:
description: 删除
operationId: topic_resource_CustomizeDelete
parameters:
- description: The Id or Name of topic_resource
in: path
name: id
required: true
type: string
x-go-name: Id
responses:
"200":
$ref: '#/responses/topic_resource_CustomizeDeleteOutput'
summary: 删除
tags:
- topic_resource
get:
description: 获取详情
operationId: topic_resource_FetchCustomizeColumns
parameters:
- description: The Id or Name of topic_resource
in: path
name: id
required: true
type: string
x-go-name: Id
responses:
"200":
$ref: '#/responses/topic_resource_FetchCustomizeColumnsOutput'
summary: 获取详情
tags:
- topic_resource
put:
description: 更新
operationId: topic_resource_ValidateUpdateData
parameters:
- description: The Id or Name of topic_resource
in: path
name: id
required: true
type: string
x-go-name: Id
- in: body
name: body
schema:
properties:
topic_resource:
$ref: '#/definitions/ResourceBaseUpdateInput'
type: object
x-go-name: Body
responses:
"200":
$ref: '#/responses/topic_resource_ValidateUpdateDataOutput'
summary: 更新
tags:
- topic_resource
/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
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
name: tags
x-go-name: Tags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还包含这些标签，OR的关系）
in: query
name: obj_tags
x-go-name: ObjTags
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（不包含这些标签）
in: query
name: no_tags
x-go-name: NoTags
- $ref: '#/definitions/TTagSetList'
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
in: query
name: no_obj_tags
x-go-name: NoObjTags
- description: 通过标签排序
in: query
name: order_by_tag
type: string
x-go-name: OrderByTag
- description: |-
deprecated
返回资源的标签不包含用户标签
in: query
name: without_user_meta
type: boolean
x-go-name: WithoutUserMeta
- description: 返回包含用户标签的资源
in: query
name: with_user_meta
type: boolean
x-go-name: WithUserMeta
- description: 返回包含外部标签的资源
in: query
name: with_cloud_meta
type: boolean
x-go-name: WithCloudMeta
- description: 返回包含任意标签的资源
in: query
name: with_any_meta
type: boolean
x-go-name: WithAnyMeta
- description: 返回列表数据中包含资源的标签数据（Metadata）
in: query
name: with_meta
type: boolean
x-go-name: WithMeta
- description: 显示所有的资源，包括模拟的资源
in: query
name: show_emulated
type: boolean
x-go-name: ShowEmulated
- description: 以资源ID过滤列表
in: query
items:
type: string
name: id
type: array
x-go-name: Ids
- description: 以资源名称过滤列表
in: query
items:
type: string
name: name
type: array
x-go-name: Names
- description: 以资源是否启用/禁用过滤列表
in: query
name: enabled
type: boolean
x-go-name: Enabled
responses:
"200":
$ref: '#/responses/topic_ListItemFilterOutput'
summary: 列表
tags:
- topic
post:
description: 新建
operationId: topic_ValidateCreateData
parameters:
- in: body
name: body
schema:
properties:
count:
default: 1
format: int64
type: integer
x-go-name: Count
topic:
$ref: '#/definitions/STopicCreateInput'
type: object
x-go-name: Body
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
- in: body
name: body
schema:
properties:
topic:
$ref: '#/definitions/TopicUpdateInput'
type: object
x-go-name: Body
responses:
"200":
$ref: '#/responses/topic_ValidateUpdateDataOutput'
summary: 更新
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}/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
produces:
- application/json
responses:
config_CustomizeDeleteOutput:
description: ""
schema:
properties:
config:
$ref: '#/definitions/ConfigDetails'
type: object
config_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
config:
$ref: '#/definitions/ConfigDetails'
type: object
config_GetDetailsMetadataOutput:
description: ""
schema:
properties:
config:
additionalProperties:
type: string
type: object
x-go-name: Output
type: object
config_GetPropertyCapabilityOutput:
description: ""
config_ListItemFilterOutput:
description: ""
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:
description: ""
config_PerformValidateOutput:
description: ""
schema:
properties:
config:
$ref: '#/definitions/ConfigValidateOutput'
type: object
config_ValidateCreateDataOutput:
description: ""
schema:
properties:
config:
$ref: '#/definitions/ConfigDetails'
type: object
config_ValidateUpdateDataOutput:
description: ""
schema:
properties:
config:
$ref: '#/definitions/ConfigDetails'
type: object
email_queue_CustomizeDeleteOutput:
description: ""
schema:
properties:
email_queue:
$ref: '#/definitions/EmailQueueDetails'
type: object
email_queue_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
email_queue:
$ref: '#/definitions/EmailQueueDetails'
type: object
email_queue_ListItemFilterOutput:
description: ""
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_PerformSendOutput:
description: ""
email_queue_ValidateCreateDataOutput:
description: ""
schema:
properties:
email_queue:
$ref: '#/definitions/EmailQueueDetails'
type: object
email_queue_ValidateUpdateDataOutput:
description: ""
schema:
properties:
email_queue:
$ref: '#/definitions/EmailQueueDetails'
type: object
email_queue_status_CustomizeDeleteOutput:
description: ""
schema:
properties:
email_queue_status:
$ref: '#/definitions/ModelBaseDetails'
type: object
email_queue_status_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
email_queue_status:
$ref: '#/definitions/ModelBaseDetails'
type: object
email_queue_status_ListItemFilterOutput:
description: ""
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_ValidateCreateDataOutput:
description: ""
schema:
properties:
email_queue_status:
$ref: '#/definitions/ModelBaseDetails'
type: object
email_queue_status_ValidateUpdateDataOutput:
description: ""
schema:
properties:
email_queue_status:
$ref: '#/definitions/ModelBaseDetails'
type: object
event_CustomizeDeleteOutput:
description: ""
schema:
properties:
event:
$ref: '#/definitions/ModelBaseDetails'
type: object
event_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
event:
$ref: '#/definitions/ModelBaseDetails'
type: object
event_ListItemFilterOutput:
description: ""
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_ValidateCreateDataOutput:
description: ""
schema:
properties:
event:
$ref: '#/definitions/ModelBaseDetails'
type: object
event_ValidateUpdateDataOutput:
description: ""
schema:
properties:
event:
$ref: '#/definitions/ModelBaseDetails'
type: object
notification_CustomizeDeleteOutput:
description: ""
schema:
properties:
notification:
$ref: '#/definitions/NotificationDetails'
type: object
notification_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
notification:
$ref: '#/definitions/NotificationDetails'
type: object
notification_GetDetailsMetadataOutput:
description: ""
schema:
properties:
notification:
additionalProperties:
type: string
type: object
x-go-name: Output
type: object
notification_GetDetailsStatusOutput:
description: ""
schema:
properties:
notification:
$ref: '#/definitions/GetDetailsStatusOutput'
type: object
notification_ListItemFilterOutput:
description: ""
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_PerformContactNotifyOutput:
description: ""
schema:
properties:
notification:
$ref: '#/definitions/NotificationManagerEventNotifyOutput'
type: object
notification_PerformEventNotifyOutput:
description: ""
schema:
properties:
notification:
$ref: '#/definitions/NotificationManagerEventNotifyOutput'
type: object
notification_ValidateCreateDataOutput:
description: ""
schema:
properties:
notification:
$ref: '#/definitions/NotificationDetails'
type: object
notification_ValidateUpdateDataOutput:
description: ""
schema:
properties:
notification:
$ref: '#/definitions/NotificationDetails'
type: object
notification_group_CustomizeDeleteOutput:
description: ""
schema:
properties:
notification_group:
$ref: '#/definitions/ModelBaseDetails'
type: object
notification_group_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
notification_group:
$ref: '#/definitions/ModelBaseDetails'
type: object
notification_group_ListItemFilterOutput:
description: ""
schema:
properties:
limit:
format: int64
type: integer
x-go-name: Limit
notification_groups:
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_group_ValidateCreateDataOutput:
description: ""
schema:
properties:
notification_group:
$ref: '#/definitions/ModelBaseDetails'
type: object
notification_group_ValidateUpdateDataOutput:
description: ""
schema:
properties:
notification_group:
$ref: '#/definitions/ModelBaseDetails'
type: object
notification_log_CustomizeDeleteOutput:
description: ""
schema:
properties:
notification_log:
$ref: '#/definitions/ModelBaseDetails'
type: object
notification_log_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
notification_log:
$ref: '#/definitions/ModelBaseDetails'
type: object
notification_log_ListItemFilterOutput:
description: ""
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_ValidateCreateDataOutput:
description: ""
schema:
properties:
notification_log:
$ref: '#/definitions/ModelBaseDetails'
type: object
notification_log_ValidateUpdateDataOutput:
description: ""
schema:
properties:
notification_log:
$ref: '#/definitions/ModelBaseDetails'
type: object
receiver_CustomizeDeleteOutput:
description: ""
schema:
properties:
receiver:
$ref: '#/definitions/ReceiverDetails'
type: object
receiver_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
receiver:
$ref: '#/definitions/ReceiverDetails'
type: object
receiver_GetDetailsMetadataOutput:
description: ""
schema:
properties:
receiver:
additionalProperties:
type: string
type: object
x-go-name: Output
type: object
receiver_GetDetailsStatusOutput:
description: ""
schema:
properties:
receiver:
$ref: '#/definitions/GetDetailsStatusOutput'
type: object
receiver_GetPropertyRoleContactTypeOutput:
description: ""
receiver_ListItemFilterOutput:
description: ""
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:
description: ""
receiver_PerformDisableOutput:
description: ""
receiver_PerformEnableContactTypeOutput:
description: ""
receiver_PerformEnableOutput:
description: ""
receiver_PerformGetSubscriptionOutput:
description: ""
receiver_PerformGetTypesOutput:
description: ""
schema:
properties:
receiver:
$ref: '#/definitions/ConfigManagerGetTypesOutput'
type: object
receiver_PerformIntellijGetOutput:
description: ""
receiver_PerformTriggerVerifyOutput:
description: ""
receiver_PerformVerifyOutput:
description: ""
receiver_ValidateCreateDataOutput:
description: ""
schema:
properties:
receiver:
$ref: '#/definitions/ReceiverDetails'
type: object
receiver_ValidateUpdateDataOutput:
description: ""
schema:
properties:
receiver:
$ref: '#/definitions/ReceiverDetails'
type: object
robot_CustomizeDeleteOutput:
description: ""
schema:
properties:
robot:
$ref: '#/definitions/RobotDetails'
type: object
robot_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
robot:
$ref: '#/definitions/RobotDetails'
type: object
robot_GetDetailsMetadataOutput:
description: ""
schema:
properties:
robot:
additionalProperties:
type: string
type: object
x-go-name: Output
type: object
robot_GetDetailsStatusOutput:
description: ""
schema:
properties:
robot:
$ref: '#/definitions/GetDetailsStatusOutput'
type: object
robot_ListItemFilterOutput:
description: ""
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_PerformChangeOwnerOutput:
description: ""
robot_PerformDisableOutput:
description: ""
robot_PerformEnableOutput:
description: ""
robot_PerformPrivateOutput:
description: ""
robot_PerformPublicOutput:
description: ""
robot_ValidateCreateDataOutput:
description: ""
schema:
properties:
robot:
$ref: '#/definitions/RobotDetails'
type: object
robot_ValidateUpdateDataOutput:
description: ""
schema:
properties:
robot:
$ref: '#/definitions/RobotDetails'
type: object
subscriber_CustomizeDeleteOutput:
description: ""
schema:
properties:
subscriber:
$ref: '#/definitions/SubscriberDetails'
type: object
subscriber_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
subscriber:
$ref: '#/definitions/SubscriberDetails'
type: object
subscriber_GetDetailsMetadataOutput:
description: ""
schema:
properties:
subscriber:
additionalProperties:
type: string
type: object
x-go-name: Output
type: object
subscriber_ListItemFilterOutput:
description: ""
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:
description: ""
subscriber_PerformDisableOutput:
description: ""
subscriber_PerformEnableOutput:
description: ""
subscriber_PerformSetReceiverOutput:
description: ""
subscriber_ValidateCreateDataOutput:
description: ""
schema:
properties:
subscriber:
$ref: '#/definitions/SubscriberDetails'
type: object
subscriber_ValidateUpdateDataOutput:
description: ""
schema:
properties:
subscriber:
$ref: '#/definitions/SubscriberDetails'
type: object
subscriber_receiver_CustomizeDeleteOutput:
description: ""
schema:
properties:
subscriber_receiver:
$ref: '#/definitions/JointResourceBaseDetails'
type: object
subscriber_receiver_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
subscriber_receiver:
$ref: '#/definitions/JointResourceBaseDetails'
type: object
subscriber_receiver_ListItemFilterOutput:
description: ""
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_ValidateCreateDataOutput:
description: ""
schema:
properties:
subscriber_receiver:
$ref: '#/definitions/JointResourceBaseDetails'
type: object
subscriber_receiver_ValidateUpdateDataOutput:
description: ""
schema:
properties:
subscriber_receiver:
$ref: '#/definitions/JointResourceBaseDetails'
type: object
template_CustomizeDeleteOutput:
description: ""
schema:
properties:
template:
$ref: '#/definitions/StandaloneAnonResourceDetails'
type: object
template_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
template:
$ref: '#/definitions/StandaloneAnonResourceDetails'
type: object
template_GetDetailsMetadataOutput:
description: ""
schema:
properties:
template:
additionalProperties:
type: string
type: object
x-go-name: Output
type: object
template_ListItemFilterOutput:
description: ""
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_PerformSaveOutput:
description: ""
template_ValidateCreateDataOutput:
description: ""
schema:
properties:
template:
$ref: '#/definitions/StandaloneAnonResourceDetails'
type: object
template_ValidateUpdateDataOutput:
description: ""
schema:
properties:
template:
$ref: '#/definitions/StandaloneAnonResourceDetails'
type: object
topic_CustomizeDeleteOutput:
description: ""
schema:
properties:
topic:
$ref: '#/definitions/TopicDetails'
type: object
topic_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
topic:
$ref: '#/definitions/TopicDetails'
type: object
topic_GetDetailsMetadataOutput:
description: ""
schema:
properties:
topic:
additionalProperties:
type: string
type: object
x-go-name: Output
type: object
topic_GetDetailsStatusOutput:
description: ""
schema:
properties:
topic:
$ref: '#/definitions/GetDetailsStatusOutput'
type: object
topic_ListItemFilterOutput:
description: ""
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_PerformDisableOutput:
description: ""
topic_PerformEnableOutput:
description: ""
topic_ValidateCreateDataOutput:
description: ""
schema:
properties:
topic:
$ref: '#/definitions/TopicDetails'
type: object
topic_ValidateUpdateDataOutput:
description: ""
schema:
properties:
topic:
$ref: '#/definitions/TopicDetails'
type: object
topic_action_CustomizeDeleteOutput:
description: ""
schema:
properties:
topic_action:
$ref: '#/definitions/ResourceBaseDetails'
type: object
topic_action_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
topic_action:
$ref: '#/definitions/ResourceBaseDetails'
type: object
topic_action_ListItemFilterOutput:
description: ""
schema:
properties:
limit:
format: int64
type: integer
x-go-name: Limit
offset:
format: int64
type: integer
x-go-name: Offset
topic_actions:
items:
$ref: '#/definitions/ResourceBaseDetails'
type: array
x-go-name: Output
total:
format: int64
type: integer
x-go-name: Total
type: object
topic_action_ValidateCreateDataOutput:
description: ""
schema:
properties:
topic_action:
$ref: '#/definitions/ResourceBaseDetails'
type: object
topic_action_ValidateUpdateDataOutput:
description: ""
schema:
properties:
topic_action:
$ref: '#/definitions/ResourceBaseDetails'
type: object
topic_resource_CustomizeDeleteOutput:
description: ""
schema:
properties:
topic_resource:
$ref: '#/definitions/ResourceBaseDetails'
type: object
topic_resource_FetchCustomizeColumnsOutput:
description: ""
schema:
properties:
topic_resource:
$ref: '#/definitions/ResourceBaseDetails'
type: object
topic_resource_ListItemFilterOutput:
description: ""
schema:
properties:
limit:
format: int64
type: integer
x-go-name: Limit
offset:
format: int64
type: integer
x-go-name: Offset
topic_resources:
items:
$ref: '#/definitions/ResourceBaseDetails'
type: array
x-go-name: Output
total:
format: int64
type: integer
x-go-name: Total
type: object
topic_resource_ValidateCreateDataOutput:
description: ""
schema:
properties:
topic_resource:
$ref: '#/definitions/ResourceBaseDetails'
type: object
topic_resource_ValidateUpdateDataOutput:
description: ""
schema:
properties:
topic_resource:
$ref: '#/definitions/ResourceBaseDetails'
type: object
schemes:
- https
- http
securityDefinitions:
keystone:
in: header
name: X-Auth-Token
type: apiKey
swagger: "2.0"
Reference in New Issue View Git Blame Copy Permalink