basePath: / consumes: - application/json definitions: AlertCloneDashboardInput: properties: clone_name: type: string x-go-name: CloneName type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertClonePanelInput: properties: clone_panel_name: type: string x-go-name: ClonePanelName panel_id: type: string x-go-name: PanelId type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertCondition: properties: evaluator: $ref: '#/definitions/Condition' operator: type: string x-go-name: Operator query: $ref: '#/definitions/AlertQuery' reducer: $ref: '#/definitions/Condition' reducer_order: $ref: '#/definitions/ResultReducerOrder' type: type: string x-go-name: Type type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertCreateInput: properties: customize_config: description: customize info type: object x-go-name: CustomizeConfig enabled: description: 启用报警 type: boolean x-go-name: Enabled execution_error_state: description: 报警执行错误将当前报警状态设置为对应的状态 type: string x-go-name: ExecutionErrorState for: description: 报警持续时间 format: int64 type: integer x-go-name: For frequency: description: 报警执行频率 format: int64 type: integer x-go-name: Frequency level: description: 报警级别 type: string x-go-name: Level name: description: 报警名称 type: string x-go-name: Name no_data_state: description: 没有收到监控指标时将当前报警状态设置为对应的状态 type: string x-go-name: NoDataState reason: type: string x-go-name: Reason settings: $ref: '#/definitions/AlertSetting' used_by: type: string x-go-name: UsedBy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertDashBoardCreateInput: 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 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 project_id: description: 指定项目的名称或ID type: string x-go-name: ProjectId refresh: type: string x-go-name: Refresh scope: type: string x-go-name: Scope required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertDashBoardDetails: properties: alert_panel_details: items: $ref: '#/definitions/AlertPanelDetail' type: array x-go-name: AlertPanelDetails 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 customize_config: type: object x-go-name: CustomizeConfig 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 enabled: description: 资源是否启用 type: boolean x-go-name: Enabled eval_data: type: object x-go-name: EvalData execution_error: description: Silenced bool type: string x-go-name: ExecutionError execution_error_state: type: string x-go-name: ExecutionErrorState for: description: |- If an alert rule has a configured `For` and the query violates the configured threshold it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any notifications. Once the alert rule has been firing for more than `For` duration, it will change to `Alerting` and send alert notifications. format: int64 type: integer x-go-name: For frequency: description: Frequency is evaluate period format: int64 type: integer x-go-name: Frequency id: description: 资源UUID type: string x-go-name: Id is_emulated: description: |- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 type: boolean x-go-name: IsEmulated last_state_change: format: date-time type: string x-go-name: LastStateChange level: type: string x-go-name: Level message: type: string x-go-name: Message metadata: additionalProperties: type: string description: 标签 type: object x-go-name: Metadata name: description: 资源名称 type: string x-go-name: Name no_data_state: type: string x-go-name: NoDataState org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: $ref: '#/definitions/AlertSetting' state: type: string x-go-name: State state_changes: format: int64 type: integer x-go-name: StateChanges 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 used_by: type: string x-go-name: UsedBy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertDetails: 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 customize_config: type: object x-go-name: CustomizeConfig 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 enabled: description: 资源是否启用 type: boolean x-go-name: Enabled eval_data: type: object x-go-name: EvalData execution_error: description: Silenced bool type: string x-go-name: ExecutionError execution_error_state: type: string x-go-name: ExecutionErrorState for: description: |- If an alert rule has a configured `For` and the query violates the configured threshold it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any notifications. Once the alert rule has been firing for more than `For` duration, it will change to `Alerting` and send alert notifications. format: int64 type: integer x-go-name: For frequency: description: Frequency is evaluate period format: int64 type: integer x-go-name: Frequency id: description: 资源UUID type: string x-go-name: Id is_emulated: description: |- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 type: boolean x-go-name: IsEmulated last_state_change: format: date-time type: string x-go-name: LastStateChange level: type: string x-go-name: Level message: type: string x-go-name: Message metadata: additionalProperties: type: string description: 标签 type: object x-go-name: Metadata name: description: 资源名称 type: string x-go-name: Name no_data_state: type: string x-go-name: NoDataState org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: $ref: '#/definitions/AlertSetting' state: type: string x-go-name: State state_changes: format: int64 type: integer x-go-name: StateChanges 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 used_by: type: string x-go-name: UsedBy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertPanelCreateInput: properties: customize_config: description: customize info type: object x-go-name: CustomizeConfig dashboard_id: type: string x-go-name: DashboardId domain_tags: $ref: '#/definitions/TTagSetList' enabled: description: 启用报警 type: boolean x-go-name: Enabled execution_error_state: description: 报警执行错误将当前报警状态设置为对应的状态 type: string x-go-name: ExecutionErrorState for: description: 报警持续时间 format: int64 type: integer x-go-name: For frequency: description: 报警执行频率 format: int64 type: integer x-go-name: Frequency from: type: string x-go-name: From interval: type: string x-go-name: Interval level: description: 报警级别 type: string x-go-name: Level metric_query: items: $ref: '#/definitions/CommonAlertQuery' type: array x-go-name: MetricQuery name: description: 报警名称 type: string x-go-name: Name no_data_state: description: 没有收到监控指标时将当前报警状态设置为对应的状态 type: string x-go-name: NoDataState no_domain_tags: $ref: '#/definitions/TTagSetList' no_project_tags: $ref: '#/definitions/TTagSetList' order_by_domain: description: 按domain名称排序，可能值为asc|desc pattern: asc|desc type: string x-go-name: OrderByDomain order_by_project: description: 按project名称排序，可能值为asc|desc pattern: asc|desc type: string x-go-name: OrderByProject policy_project_tags: $ref: '#/definitions/TTagSetList' project_domain_id: description: 指定项目归属域名称或ID type: string x-go-name: ProjectDomainId project_domain_ids: description: 对具有域属性的资源，严格匹配域ID items: type: string type: array x-go-name: ProjectDomainIds project_id: description: 指定项目的名称或ID type: string x-go-name: ProjectId project_ids: description: 对具有项目属性的资源，严格匹配项目ID items: type: string type: array x-go-name: ProjectIds project_organizations: description: filter by project organizations items: type: string type: array x-go-name: ProjectOrganizations project_tags: $ref: '#/definitions/TTagSetList' reason: type: string x-go-name: Reason refresh: type: string x-go-name: Refresh scope: description: 指定查询的权限范围，可能值为project, domain or system type: string x-go-name: Scope settings: $ref: '#/definitions/AlertSetting' to: type: string x-go-name: To used_by: type: string x-go-name: UsedBy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertPanelDetail: properties: Setting: $ref: '#/definitions/AlertSetting' 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 common_alert_metric_details: items: $ref: '#/definitions/CommonAlertMetricDetails' type: array x-go-name: CommonAlertMetricDetails created_at: description: 资源创建时间 format: date-time type: string x-go-name: CreatedAt customize_config: type: object x-go-name: CustomizeConfig 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 enabled: description: 资源是否启用 type: boolean x-go-name: Enabled eval_data: type: object x-go-name: EvalData execution_error: description: Silenced bool type: string x-go-name: ExecutionError execution_error_state: type: string x-go-name: ExecutionErrorState for: description: |- If an alert rule has a configured `For` and the query violates the configured threshold it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any notifications. Once the alert rule has been firing for more than `For` duration, it will change to `Alerting` and send alert notifications. format: int64 type: integer x-go-name: For frequency: description: Frequency is evaluate period format: int64 type: integer x-go-name: Frequency id: description: 资源UUID type: string x-go-name: Id is_emulated: description: |- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 type: boolean x-go-name: IsEmulated last_state_change: format: date-time type: string x-go-name: LastStateChange level: type: string x-go-name: Level message: type: string x-go-name: Message metadata: additionalProperties: type: string description: 标签 type: object x-go-name: Metadata name: description: 资源名称 type: string x-go-name: Name no_data_state: type: string x-go-name: NoDataState org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 panel_id: type: string x-go-name: PanelId panel_name: type: string x-go-name: PanelName 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 refresh: type: string x-go-name: Refresh res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: $ref: '#/definitions/AlertSetting' state: type: string x-go-name: State state_changes: format: int64 type: integer x-go-name: StateChanges 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 used_by: type: string x-go-name: UsedBy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertPanelSetOrderInput: properties: order: items: properties: index: format: int64 type: integer x-go-name: Index panel_id: type: string x-go-name: PanelId type: object type: array x-go-name: Order type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertPauseInput: properties: paused: type: boolean x-go-name: Paused type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertQuery: properties: from: type: string x-go-name: From model: $ref: '#/definitions/MetricQuery' result_reducer: $ref: '#/definitions/Condition' result_reducer_order: $ref: '#/definitions/ResultReducerOrder' to: type: string x-go-name: To type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertRecordCreateInput: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata alert_id: type: string x-go-name: AlertId alert_rule: items: $ref: '#/definitions/AlertRecordRule' type: array x-go-name: AlertRule description: description: 资源描述 example: test create network type: string x-go-name: Description dry_run: default: false description: 预检验参数,若为true则仅检查参数,并不真正创建变更 type: boolean x-go-name: DryRun eval_data: items: $ref: '#/definitions/EvalMatch' type: array x-go-name: EvalData 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 level: description: 报警级别 type: string x-go-name: Level 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 res_type: type: string x-go-name: ResType send_state: type: string x-go-name: SendState state: type: string x-go-name: State required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertRecordDetails: properties: alert_id: type: string x-go-name: AlertId alert_name: type: string x-go-name: AlertName alert_rule: type: object x-go-name: AlertRule 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 enabled: description: 资源是否启用 type: boolean x-go-name: Enabled eval_data: type: object x-go-name: EvalData id: description: 资源UUID type: string x-go-name: Id is_emulated: description: |- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 type: boolean x-go-name: IsEmulated level: type: string x-go-name: Level metadata: additionalProperties: type: string description: 标签 type: object x-go-name: Metadata org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 res_ids: type: string x-go-name: ResIds res_num: format: int64 type: integer x-go-name: ResNum res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope send_state: type: string x-go-name: SendState state: type: string x-go-name: State tenant: description: |- 资源归属项目的名称 alias:project type: string x-go-name: Project tenant_id: description: 项目Id type: string x-go-name: ProjectId trigger_time: format: date-time type: string x-go-name: TriggerTime 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/monitor AlertRecordHistoryAlert: properties: data: items: $ref: '#/definitions/AlertRecordHistoryAlertData' type: array x-go-name: Data type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertRecordHistoryAlertData: properties: domain: type: string x-go-name: Domain domain_id: type: string x-go-name: DomainId project: type: string x-go-name: Project project_id: type: string x-go-name: ProjectId res_num: format: int64 type: integer x-go-name: ResNum res_type: type: string x-go-name: ResType type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertRecordRule: properties: alert_duration: format: int64 type: integer x-go-name: AlertDuration comparator: description: '比较运算符, 比如: >, <, >=, <=' type: string x-go-name: Comparator condition_type: type: string x-go-name: ConditionType database: type: string x-go-name: Database field: type: string x-go-name: Field field_desc: type: string x-go-name: FieldDesc measurement: type: string x-go-name: Measurement measurement_desc: type: string x-go-name: MeasurementDesc metric: type: string x-go-name: Metric period: type: string x-go-name: Period reducer: type: string x-go-name: Reducer res_type: type: string x-go-name: ResType silent_period: description: 静默期 type: string x-go-name: SilentPeriod threshold: description: 报警阀值 type: string x-go-name: Threshold threshold_range: items: format: double type: number type: array x-go-name: ThresholdRange unit: type: string x-go-name: Unit type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertRecordShieldCreateInput: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata alert_id: type: string x-go-name: AlertId description: description: 资源描述 example: test create network type: string x-go-name: Description dry_run: default: false description: 预检验参数,若为true则仅检查参数,并不真正创建变更 type: boolean x-go-name: DryRun end_time: type: string x-go-name: EndTime 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 res_id: type: string x-go-name: ResId res_name: type: string x-go-name: ResName res_type: type: string x-go-name: ResType start_time: type: string x-go-name: StartTime required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertRecordShieldDetails: properties: alert_duration: description: 报警连续持续周期数 format: int64 type: integer x-go-name: AlertDuration alert_name: type: string x-go-name: AlertName alert_type: description: 报警类型 type: string x-go-name: AlertType 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 channel: items: type: string type: array x-go-name: Channel common_alert_metric_details: items: $ref: '#/definitions/CommonAlertMetricDetails' type: array x-go-name: CommonAlertMetricDetails created_at: description: 资源创建时间 format: date-time type: string x-go-name: CreatedAt customize_config: type: object x-go-name: CustomizeConfig 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 disable_notify_recovery: type: boolean x-go-name: DisableNotifyRecovery domain_id: description: 域Id type: string x-go-name: DomainId enabled: description: 资源是否启用 type: boolean x-go-name: Enabled eval_data: type: object x-go-name: EvalData execution_error: description: Silenced bool type: string x-go-name: ExecutionError execution_error_state: type: string x-go-name: ExecutionErrorState expired: type: boolean x-go-name: Expired for: description: |- If an alert rule has a configured `For` and the query violates the configured threshold it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any notifications. Once the alert rule has been firing for more than `For` duration, it will change to `Alerting` and send alert notifications. format: int64 type: integer x-go-name: For frequency: description: Frequency is evaluate period format: int64 type: integer x-go-name: Frequency id: description: 资源UUID type: string x-go-name: Id is_emulated: description: |- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 type: boolean x-go-name: IsEmulated last_state_change: format: date-time type: string x-go-name: LastStateChange level: type: string x-go-name: Level message: type: string x-go-name: Message metadata: additionalProperties: type: string description: 标签 type: object x-go-name: Metadata name: description: 资源名称 type: string x-go-name: Name no_data_state: type: string x-go-name: NoDataState notifier_id: type: string x-go-name: NotifierId org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 period: type: string x-go-name: Period 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 recipients: items: type: string type: array x-go-name: Recipients res_name: type: string x-go-name: ResName res_type: type: string x-go-name: ResType robot_ids: items: type: string type: array x-go-name: RobotIds role_ids: items: type: string type: array x-go-name: RoleIds scope: type: string x-go-name: Scope settings: $ref: '#/definitions/AlertSetting' silent_period: description: 静默期 type: string x-go-name: SilentPeriod state: type: string x-go-name: State state_changes: format: int64 type: integer x-go-name: StateChanges 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 used_by: type: string x-go-name: UsedBy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertResourceDetails: 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 count: format: int64 type: integer x-go-name: Count delete_fail_reason: $ref: '#/definitions/Error' metadata: additionalProperties: type: string description: 标签 type: object x-go-name: Metadata tags: additionalProperties: type: string type: object x-go-name: Tags update_fail_reason: $ref: '#/definitions/Error' type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertSetting: description: AlertSettings contains alert conditions properties: conditions: items: $ref: '#/definitions/AlertCondition' type: array x-go-name: Conditions type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertTestRunInput: properties: is_debug: type: boolean x-go-name: IsDebug type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertTestRunOutput: properties: alert_ok_eval_matches: items: $ref: '#/definitions/EvalMatch' type: array x-go-name: AlertOKEvalMatches condition_evals: type: string x-go-name: ConditionEvals end_time: format: date-time type: string x-go-name: EndTime error: type: string x-go-name: Error x-go-type: error eval_matches: items: $ref: '#/definitions/EvalMatch' type: array x-go-name: EvalMatches firing: type: boolean x-go-name: Firing is_debug: type: boolean x-go-name: IsDebug is_test_run: type: boolean x-go-name: IsTestRun logs: items: $ref: '#/definitions/ResultLogEntry' type: array x-go-name: Logs no_data_found: type: boolean x-go-name: NoDataFound prev_alert_state: type: string x-go-name: PrevAlertState start_time: format: date-time type: string x-go-name: StartTime type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertUpdateInput: properties: description: description: 资源描述 type: string x-go-name: Description enabled: description: 启用报警 type: boolean x-go-name: Enabled execution_error_state: description: 报警执行错误将当前报警状态设置为对应的状态 type: string x-go-name: ExecutionErrorState for: description: 报警持续时间 format: int64 type: integer x-go-name: For frequency: description: 报警执行频率 format: int64 type: integer x-go-name: Frequency level: description: 报警级别 type: string x-go-name: Level message: type: string x-go-name: Message name: description: 资源名称 type: string x-go-name: Name no_data_state: description: 没有收到监控指标时将当前报警状态设置为对应的状态 type: string x-go-name: NoDataState reason: description: 报警原因 type: string x-go-name: Reason settings: $ref: '#/definitions/AlertSetting' type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor CommonAlertCreateInput: properties: alert_duration: description: 报警连续持续周期数 format: int64 type: integer x-go-name: AlertDuration alert_type: description: 报警类型 type: string x-go-name: AlertType channel: description: '通知方式, 比如: email, mobile' items: type: string type: array x-go-name: Channel customize_config: description: customize info type: object x-go-name: CustomizeConfig description: type: string x-go-name: Description disable_notify_recovery: description: 为 true 时不发送恢复通知（OK） type: boolean x-go-name: DisableNotifyRecovery domain_id: type: string x-go-name: DomainId enabled: description: 启用报警 type: boolean x-go-name: Enabled execution_error_state: description: 报警执行错误将当前报警状态设置为对应的状态 type: string x-go-name: ExecutionErrorState for: description: 报警持续时间 format: int64 type: integer x-go-name: For frequency: description: 报警执行频率 format: int64 type: integer x-go-name: Frequency from: type: string x-go-name: From get_point_str: type: boolean x-go-name: GetPointStr interval: type: string x-go-name: Interval level: description: 报警级别 type: string x-go-name: Level meta_name: type: string x-go-name: MetaName metric_query: items: $ref: '#/definitions/CommonAlertQuery' type: array x-go-name: MetricQuery name: description: 报警名称 type: string x-go-name: Name no_data_state: description: 没有收到监控指标时将当前报警状态设置为对应的状态 type: string x-go-name: NoDataState period: description: 查询指标周期 type: string x-go-name: Period project_id: type: string x-go-name: ProjectId reason: type: string x-go-name: Reason recipients: description: 通知接受者 items: type: string type: array x-go-name: Recipients robot_ids: items: type: string type: array x-go-name: RobotIds roles: description: 角色 id 或者 name items: type: string type: array x-go-name: Roles scope: description: Scope Resource type: string x-go-name: Scope settings: $ref: '#/definitions/AlertSetting' silent_period: description: 静默期 type: string x-go-name: SilentPeriod to: type: string x-go-name: To used_by: type: string x-go-name: UsedBy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor CommonAlertDetails: properties: alert_duration: description: 报警连续持续周期数 format: int64 type: integer x-go-name: AlertDuration alert_type: description: 报警类型 type: string x-go-name: AlertType 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 channel: items: type: string type: array x-go-name: Channel common_alert_metric_details: items: $ref: '#/definitions/CommonAlertMetricDetails' type: array x-go-name: CommonAlertMetricDetails created_at: description: 资源创建时间 format: date-time type: string x-go-name: CreatedAt customize_config: type: object x-go-name: CustomizeConfig 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 disable_notify_recovery: type: boolean x-go-name: DisableNotifyRecovery domain_id: description: 域Id type: string x-go-name: DomainId enabled: description: 资源是否启用 type: boolean x-go-name: Enabled eval_data: type: object x-go-name: EvalData execution_error: description: Silenced bool type: string x-go-name: ExecutionError execution_error_state: type: string x-go-name: ExecutionErrorState for: description: |- If an alert rule has a configured `For` and the query violates the configured threshold it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any notifications. Once the alert rule has been firing for more than `For` duration, it will change to `Alerting` and send alert notifications. format: int64 type: integer x-go-name: For frequency: description: Frequency is evaluate period format: int64 type: integer x-go-name: Frequency id: description: 资源UUID type: string x-go-name: Id is_emulated: description: |- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 type: boolean x-go-name: IsEmulated last_state_change: format: date-time type: string x-go-name: LastStateChange level: type: string x-go-name: Level message: type: string x-go-name: Message metadata: additionalProperties: type: string description: 标签 type: object x-go-name: Metadata name: description: 资源名称 type: string x-go-name: Name no_data_state: type: string x-go-name: NoDataState notifier_id: type: string x-go-name: NotifierId org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 period: type: string x-go-name: Period 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 recipients: items: type: string type: array x-go-name: Recipients res_type: type: string x-go-name: ResType robot_ids: items: type: string type: array x-go-name: RobotIds role_ids: items: type: string type: array x-go-name: RoleIds scope: type: string x-go-name: Scope settings: $ref: '#/definitions/AlertSetting' silent_period: description: 静默期 type: string x-go-name: SilentPeriod state: type: string x-go-name: State state_changes: format: int64 type: integer x-go-name: StateChanges 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 used_by: type: string x-go-name: UsedBy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor CommonAlertFieldOpt: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/monitor CommonAlertMetricDetails: properties: FieldDescription: $ref: '#/definitions/MetricFieldDetail' comparator: type: string x-go-name: Comparator condition_type: type: string x-go-name: ConditionType db: type: string x-go-name: DB field: type: string x-go-name: Field field_opt: type: string x-go-name: FieldOpt filters: items: $ref: '#/definitions/MetricQueryTag' type: array x-go-name: Filters get_point_str: type: boolean x-go-name: GetPointStr groupby: type: string x-go-name: Groupby measurement: type: string x-go-name: Measurement measurement_display_name: type: string x-go-name: MeasurementDisplayName operator: type: string x-go-name: Operator reduce: description: metric points'value的运算方式 type: string x-go-name: Reduce res_type: type: string x-go-name: ResType threshold: format: double type: number x-go-name: Threshold threshold_range: items: format: double type: number type: array x-go-name: ThresholdRange threshold_str: type: string x-go-name: ThresholdStr type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor CommonAlertQuery: properties: comparator: description: '比较运算符, 比如: >, <, >=, <=, within_range, outside_range' type: string x-go-name: Comparator condition_type: type: string x-go-name: ConditionType field_opt: $ref: '#/definitions/CommonAlertFieldOpt' from: type: string x-go-name: From model: $ref: '#/definitions/MetricQuery' operator: description: Operator should be chosen from 'and | or' type: string x-go-name: Operator reduce: description: metric points'value的运算方式 type: string x-go-name: Reduce result_reducer: $ref: '#/definitions/Condition' result_reducer_order: $ref: '#/definitions/ResultReducerOrder' threshold: description: 报警阀值 (用于 gt, lt, eq) format: double type: number x-go-name: Threshold threshold_range: description: 范围参数 (用于 within_range, outside_range) items: format: double type: number type: array x-go-name: ThresholdRange to: type: string x-go-name: To type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor Condition: properties: operators: items: type: string type: array x-go-name: Operators params: items: format: double type: number type: array x-go-name: Params type: type: string x-go-name: Type type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor Duration: description: |- A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. format: int64 type: integer x-go-package: time 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 EvalMatch: properties: alert_details: type: object x-go-name: AlertDetails condition: type: string x-go-name: Condition is_recovery: type: boolean x-go-name: IsRecovery metric: type: string x-go-name: Metric tags: additionalProperties: type: string type: object x-go-name: Tags unit: type: string x-go-name: Unit value: format: double type: number x-go-name: Value value_str: type: string x-go-name: ValueStr title: EvalMatch represents the series violating the threshold. type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor GetDetailsStatusOutput: properties: status: description: 状态 type: string x-go-name: Status type: object x-go-package: yunion.io/x/onecloud/pkg/apis 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 MetricCreateInput: properties: measurement: $ref: '#/definitions/MetricMeasurementCreateInput' metric_fields: items: $ref: '#/definitions/MetricFieldCreateInput' type: array x-go-name: MetricFields scope: type: string x-go-name: Scope type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricDetails: 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 metric_fields: items: $ref: '#/definitions/MetricFieldDetail' type: array x-go-name: MetricFields 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 scope: type: string x-go-name: Scope 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/monitor MetricFieldCreateInput: 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 display_name: type: string x-go-name: DisplayName 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 score: format: int64 type: integer x-go-name: Score unit: type: string x-go-name: Unit value_type: type: string x-go-name: ValueType required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricFieldDetail: properties: display_name: type: string x-go-name: DisplayName id: type: string x-go-name: Id name: type: string x-go-name: Name unit: type: string x-go-name: Unit type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricFieldListInput: properties: belong_scope: description: 指定匹配的范围，可能值为project, domain or system type: string x-go-name: BelongScope details: description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 type: boolean x-go-name: Details display_name: type: string x-go-name: DisplayName domain_tags: $ref: '#/definitions/TTagSetList' enabled: description: 以资源是否启用/禁用过滤列表 type: boolean x-go-name: Enabled export_keys: description: 用于数据导出，指定导出的数据字段 type: string x-go-name: ExportKeys field: description: 返回结果只包含指定的字段 items: type: string type: array x-go-name: Field filter: 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或者空字符串 | items: type: string type: array x-go-name: Filter filter_any: description: 如果filter_any为true，则查询所有filter的并集，否则为交集 type: boolean x-go-name: FilterAny id: description: 以资源ID过滤列表 items: type: string type: array x-go-name: Ids joint_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') items: type: string type: array x-go-name: JointFilter limit: default: 20 description: 查询限制量 format: int64 type: integer x-go-name: Limit name: description: 以资源名称过滤列表 items: type: string type: array x-go-name: Names no_domain_tags: $ref: '#/definitions/TTagSetList' no_obj_tags: $ref: '#/definitions/TTagSetList' no_project_tags: $ref: '#/definitions/TTagSetList' no_tags: $ref: '#/definitions/TTagSet' obj_tags: $ref: '#/definitions/TTagSetList' offset: default: 0 description: 查询偏移量 format: int64 type: integer x-go-name: Offset order: description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc type: string x-go-name: Order order_by: description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 items: type: string type: array x-go-name: OrderBy order_by_domain: description: 按domain名称排序，可能值为asc|desc pattern: asc|desc type: string x-go-name: OrderByDomain order_by_project: description: 按project名称排序，可能值为asc|desc pattern: asc|desc type: string x-go-name: OrderByProject order_by_tag: description: 通过标签排序 type: string x-go-name: OrderByTag policy_project_tags: $ref: '#/definitions/TTagSetList' project_domain_id: description: 指定项目归属域名称或ID type: string x-go-name: ProjectDomainId project_domain_ids: description: 对具有域属性的资源，严格匹配域ID items: type: string type: array x-go-name: ProjectDomainIds project_id: description: 指定项目的名称或ID type: string x-go-name: ProjectId project_ids: description: 对具有项目属性的资源，严格匹配项目ID items: type: string type: array x-go-name: ProjectIds project_organizations: description: filter by project organizations items: type: string type: array x-go-name: ProjectOrganizations project_tags: $ref: '#/definitions/TTagSetList' scope: description: 指定查询的权限范围，可能值为project, domain or system type: string x-go-name: Scope search: description: 模糊搜索所有字段 type: string x-go-name: Search show_emulated: description: 显示所有的资源，包括模拟的资源 type: boolean x-go-name: ShowEmulated show_fail_reason: description: 返回结果携带delete_fail_reason和update_fail_reason字段 type: boolean x-go-name: ShowFailReason status: description: 以资源的状态过滤列表 items: type: string type: array x-go-name: Status summary_stats: description: 是否返回状态统计信息，默认为False type: boolean x-go-name: SummaryStats tags: $ref: '#/definitions/TTagSet' unit: type: string x-go-name: Unit with_any_meta: description: 返回包含任意标签的资源 type: boolean x-go-name: WithAnyMeta with_cloud_meta: description: 返回包含外部标签的资源 type: boolean x-go-name: WithCloudMeta with_meta: description: 返回列表数据中包含资源的标签数据（Metadata） type: boolean x-go-name: WithMeta with_user_meta: description: 返回包含用户标签的资源 type: boolean x-go-name: WithUserMeta without_user_meta: description: |- deprecated 返回资源的标签不包含用户标签 type: boolean x-go-name: WithoutUserMeta type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricFieldUpdateInput: properties: description: description: 资源描述 type: string x-go-name: Description display_name: type: string x-go-name: DisplayName id: type: string x-go-name: Id name: description: 资源名称 type: string x-go-name: Name score: format: int64 type: integer x-go-name: Score unit: type: string x-go-name: Unit value_type: type: string x-go-name: ValueType type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricMeasurementCreateInput: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata database: type: string x-go-name: Database description: description: 资源描述 example: test create network type: string x-go-name: Description disabled: description: 该资源是否被管理员*人为*禁用, 和enabled互斥 type: boolean x-go-name: Disabled display_name: type: string x-go-name: DisplayName dry_run: default: false description: 预检验参数,若为true则仅检查参数,并不真正创建变更 type: boolean x-go-name: DryRun enabled: description: 该资源是否被管理员*人为*启用或者禁用 type: boolean x-go-name: Enabled generate_name: description: |- 生成资源名称的模板，如果name为空，则为必填项 description: generated resource name, given a pattern to generate name, required if name is not given example: test### type: string x-go-name: GenerateName is_emulated: description: |- 资源是否为模拟资源 description: the resource is an emulated resource type: boolean x-go-name: IsEmulated name: description: |- 资源名称，如果generate_name为空，则为必填项 description: resource name, required if generated_name is not given example: test-network type: string uniqueItems: true x-go-name: Name res_type: type: string x-go-name: ResType score: format: int64 type: integer x-go-name: Score required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricMeasurementListInput: properties: belong_scope: description: 指定匹配的范围，可能值为project, domain or system type: string x-go-name: BelongScope details: description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 type: boolean x-go-name: Details display_name: type: string x-go-name: DisplayName domain_tags: $ref: '#/definitions/TTagSetList' enabled: description: 以资源是否启用/禁用过滤列表 type: boolean x-go-name: Enabled export_keys: description: 用于数据导出，指定导出的数据字段 type: string x-go-name: ExportKeys field: description: 返回结果只包含指定的字段 items: type: string type: array x-go-name: Field filter: 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或者空字符串 | items: type: string type: array x-go-name: Filter filter_any: description: 如果filter_any为true，则查询所有filter的并集，否则为交集 type: boolean x-go-name: FilterAny id: description: 以资源ID过滤列表 items: type: string type: array x-go-name: Ids joint_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') items: type: string type: array x-go-name: JointFilter limit: default: 20 description: 查询限制量 format: int64 type: integer x-go-name: Limit name: description: 以资源名称过滤列表 items: type: string type: array x-go-name: Names no_domain_tags: $ref: '#/definitions/TTagSetList' no_obj_tags: $ref: '#/definitions/TTagSetList' no_project_tags: $ref: '#/definitions/TTagSetList' no_tags: $ref: '#/definitions/TTagSet' obj_tags: $ref: '#/definitions/TTagSetList' offset: default: 0 description: 查询偏移量 format: int64 type: integer x-go-name: Offset order: description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc type: string x-go-name: Order order_by: description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 items: type: string type: array x-go-name: OrderBy order_by_domain: description: 按domain名称排序，可能值为asc|desc pattern: asc|desc type: string x-go-name: OrderByDomain order_by_project: description: 按project名称排序，可能值为asc|desc pattern: asc|desc type: string x-go-name: OrderByProject order_by_tag: description: 通过标签排序 type: string x-go-name: OrderByTag policy_project_tags: $ref: '#/definitions/TTagSetList' project_domain_id: description: 指定项目归属域名称或ID type: string x-go-name: ProjectDomainId project_domain_ids: description: 对具有域属性的资源，严格匹配域ID items: type: string type: array x-go-name: ProjectDomainIds project_id: description: 指定项目的名称或ID type: string x-go-name: ProjectId project_ids: description: 对具有项目属性的资源，严格匹配项目ID items: type: string type: array x-go-name: ProjectIds project_organizations: description: filter by project organizations items: type: string type: array x-go-name: ProjectOrganizations project_tags: $ref: '#/definitions/TTagSetList' res_type: type: string x-go-name: ResType scope: description: 指定查询的权限范围，可能值为project, domain or system type: string x-go-name: Scope search: description: 模糊搜索所有字段 type: string x-go-name: Search show_emulated: description: 显示所有的资源，包括模拟的资源 type: boolean x-go-name: ShowEmulated show_fail_reason: description: 返回结果携带delete_fail_reason和update_fail_reason字段 type: boolean x-go-name: ShowFailReason status: description: 以资源的状态过滤列表 items: type: string type: array x-go-name: Status summary_stats: description: 是否返回状态统计信息，默认为False type: boolean x-go-name: SummaryStats tags: $ref: '#/definitions/TTagSet' with_any_meta: description: 返回包含任意标签的资源 type: boolean x-go-name: WithAnyMeta with_cloud_meta: description: 返回包含外部标签的资源 type: boolean x-go-name: WithCloudMeta with_meta: description: 返回列表数据中包含资源的标签数据（Metadata） type: boolean x-go-name: WithMeta with_user_meta: description: 返回包含用户标签的资源 type: boolean x-go-name: WithUserMeta without_user_meta: description: |- deprecated 返回资源的标签不包含用户标签 type: boolean x-go-name: WithoutUserMeta type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricMeasurementUpdateInput: properties: description: description: 资源描述 type: string x-go-name: Description display_name: type: string x-go-name: DisplayName name: description: 资源名称 type: string x-go-name: Name res_type: type: string x-go-name: ResType type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricQuery: properties: alias: type: string x-go-name: Alias database: type: string x-go-name: Database group_by: items: $ref: '#/definitions/MetricQueryPart' type: array x-go-name: GroupBy interval: type: string x-go-name: Interval measurement: type: string x-go-name: Measurement policy: type: string x-go-name: Policy result_format: type: string x-go-name: ResultFormat select: items: $ref: '#/definitions/MetricQuerySelect' type: array x-go-name: Selects tags: items: $ref: '#/definitions/MetricQueryTag' type: array x-go-name: Tags tz: type: string x-go-name: Tz type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricQueryInput: properties: domain_id: type: string x-go-name: DomainId from: type: string x-go-name: From interval: type: string x-go-name: Interval metric_query: items: $ref: '#/definitions/AlertQuery' type: array x-go-name: MetricQuery project_id: type: string x-go-name: ProjectId scope: type: string x-go-name: Scope show_meta: type: boolean x-go-name: ShowMeta signature: type: string x-go-name: Signature skip_check_series: type: boolean x-go-name: SkipCheckSeries slimit: type: string x-go-name: Slimit soffset: type: string x-go-name: Soffset to: type: string x-go-name: To unit: type: boolean x-go-name: Unit type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricQueryPart: properties: params: items: type: string type: array x-go-name: Params type: type: string x-go-name: Type type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricQuerySelect: items: $ref: '#/definitions/MetricQueryPart' type: array x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricQueryTag: properties: condition: type: string x-go-name: Condition key: type: string x-go-name: Key operator: type: string x-go-name: Operator value: type: string x-go-name: Value type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricUpdateInput: properties: measurement: $ref: '#/definitions/MetricMeasurementUpdateInput' metric_fields: items: $ref: '#/definitions/MetricFieldUpdateInput' type: array x-go-name: MetricFields scope: type: string x-go-name: Scope type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MetricsQueryResult: properties: metas: items: $ref: '#/definitions/QueryResultMeta' type: array x-go-name: Metas reduced_result: $ref: '#/definitions/ReducedResult' series: $ref: '#/definitions/TimeSeriesSlice' series_total: format: int64 type: integer x-go-name: SeriesTotal type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MigrationAlertCreateInput: properties: customize_config: description: customize info type: object x-go-name: CustomizeConfig enabled: description: 启用报警 type: boolean x-go-name: Enabled execution_error_state: description: 报警执行错误将当前报警状态设置为对应的状态 type: string x-go-name: ExecutionErrorState for: description: 报警持续时间 format: int64 type: integer x-go-name: For frequency: description: 报警执行频率 format: int64 type: integer x-go-name: Frequency level: description: 报警级别 type: string x-go-name: Level metric_type: $ref: '#/definitions/MigrationAlertMetricType' migration_settings: $ref: '#/definitions/MigrationAlertSettings' name: description: 报警名称 type: string x-go-name: Name no_data_state: description: 没有收到监控指标时将当前报警状态设置为对应的状态 type: string x-go-name: NoDataState period: description: Period of querying metrics type: string x-go-name: Period reason: type: string x-go-name: Reason settings: $ref: '#/definitions/AlertSetting' threshold: description: Threshold is the value to trigger migration format: double type: number x-go-name: Threshold used_by: type: string x-go-name: UsedBy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MigrationAlertMetricType: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MigrationAlertSettings: properties: source: $ref: '#/definitions/MigrationAlertSettingsSource' target: $ref: '#/definitions/MigrationAlertSettingsTarget' type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MigrationAlertSettingsSource: properties: guest_ids: items: type: string type: array x-go-name: GuestIds host_ids: items: type: string type: array x-go-name: HostIds type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MigrationAlertSettingsTarget: properties: host_ids: items: type: string type: array x-go-name: HostIds type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MonitorResourceCreateInput: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata alert_status: type: string x-go-name: AlertStatus description: description: 资源描述 example: test create network type: string x-go-name: Description disabled: description: 该资源是否被管理员*人为*禁用, 和enabled互斥 type: boolean x-go-name: Disabled dry_run: default: false description: 预检验参数,若为true则仅检查参数,并不真正创建变更 type: boolean x-go-name: DryRun enabled: description: 该资源是否被管理员*人为*启用或者禁用 type: boolean x-go-name: Enabled generate_name: description: |- 生成资源名称的模板，如果name为空，则为必填项 description: generated resource name, given a pattern to generate name, required if name is not given example: test### type: string x-go-name: GenerateName is_emulated: description: |- 资源是否为模拟资源 description: the resource is an emulated resource type: boolean x-go-name: IsEmulated is_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 res_id: type: string x-go-name: ResId res_type: type: string x-go-name: ResType status: description: 用来存储资源的状态 type: string x-go-name: Status required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MonitorResourceDetails: properties: access_ip: type: string x-go-name: AccessIp account: description: 云账号名称 example: google-account type: string x-go-name: Account account_health_status: description: 云账号监控状态 type: string x-go-name: AccountHealthStatus account_read_only: type: boolean x-go-name: AccountReadOnly account_status: description: 云账号状态 type: string x-go-name: AccountStatus attach_alert_count: format: int64 type: integer x-go-name: AttachAlertCount brand: description: 云平台品牌 example: Google type: string x-go-name: Brand can_delete: description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 example: true type: boolean x-go-name: CanDelete can_update: description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 example: true type: boolean x-go-name: CanUpdate cloud_env: description: 云环境 example: public type: string x-go-name: CloudEnv cloudregion: description: 区域的名称 type: string x-go-name: Cloudregion delete_fail_reason: $ref: '#/definitions/Error' environment: description: Environment type: string x-go-name: Environment hypervisor: type: string x-go-name: Hypervisor ips: type: string x-go-name: Ips 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 provider: description: 云平台名称 example: Google type: string x-go-name: Provider region: description: 区域的名称 example: Default type: string x-go-name: Region region_ext_id: description: 纳管云区域的Id example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 type: string x-go-name: RegionExtId region_external_id: description: 纳管云区域的组合Id(平台+Id) example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 type: string x-go-name: RegionExternalId region_id: description: 区域的Id example: default type: string x-go-name: RegionId 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/monitor MonitorResourceDoActionInput: properties: action: type: string x-go-name: Action data: type: object x-go-name: Data type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor MonitorResourceJointDetails: properties: alert_count: format: int64 type: integer x-go-name: AlertCount alert_name: type: string x-go-name: AlertName alert_rule: type: object x-go-name: AlertRule is_set_shield: type: boolean x-go-name: IsSetShield level: type: string x-go-name: Level monitor_resource_object_id: type: string x-go-name: MonitorResourceObjectId res_id: type: string x-go-name: ResId res_name: type: string x-go-name: ResName res_type: type: string x-go-name: ResType send_state: type: string x-go-name: SendState state: type: string x-go-name: State type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor NodeAlertCreateInput: properties: channel: description: '通知方式, 比如: email, mobile' type: string x-go-name: Channel common_alert_create_input: $ref: '#/definitions/CommonAlertCreateInput' comparator: description: '比较运算符, 比如: >, <, >=, <=' type: string x-go-name: Comparator customize_config: description: customize info type: object x-go-name: CustomizeConfig enabled: description: 启用报警 type: boolean x-go-name: Enabled execution_error_state: description: 报警执行错误将当前报警状态设置为对应的状态 type: string x-go-name: ExecutionErrorState for: description: 报警持续时间 format: int64 type: integer x-go-name: For frequency: description: 报警执行频率 format: int64 type: integer x-go-name: Frequency level: description: 报警级别 type: string x-go-name: Level metric: description: 监控指标名称 type: string x-go-name: Metric name: description: 报警名称 type: string x-go-name: Name no_data_state: description: 没有收到监控指标时将当前报警状态设置为对应的状态 type: string x-go-name: NoDataState node_id: description: 监控资源 Id type: string x-go-name: NodeId node_name: description: 监控资源名称 type: string x-go-name: NodeName period: description: 查询指标周期 type: string x-go-name: Period reason: type: string x-go-name: Reason recipients: description: 通知接受者 type: string x-go-name: Recipients settings: $ref: '#/definitions/AlertSetting' threshold: description: 报警阀值 format: double type: number x-go-name: Threshold type: description: '监控资源类型, 比如: guest, host' type: string x-go-name: Type used_by: type: string x-go-name: UsedBy window: description: 每隔多久查询一次 type: string x-go-name: Window type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor NodeAlertDetails: 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 channel: type: string x-go-name: Channel comparator: type: string x-go-name: Comparator created_at: description: 资源创建时间 format: date-time type: string x-go-name: CreatedAt customize_config: type: object x-go-name: CustomizeConfig db: type: string x-go-name: DB 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 enabled: description: 资源是否启用 type: boolean x-go-name: Enabled eval_data: type: object x-go-name: EvalData execution_error: description: Silenced bool type: string x-go-name: ExecutionError execution_error_state: type: string x-go-name: ExecutionErrorState field: type: string x-go-name: Field for: description: |- If an alert rule has a configured `For` and the query violates the configured threshold it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any notifications. Once the alert rule has been firing for more than `For` duration, it will change to `Alerting` and send alert notifications. format: int64 type: integer x-go-name: For frequency: description: Frequency is evaluate period format: int64 type: integer x-go-name: Frequency id: description: 资源UUID type: string x-go-name: Id is_emulated: description: |- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 type: boolean x-go-name: IsEmulated last_state_change: format: date-time type: string x-go-name: LastStateChange level: type: string x-go-name: Level measurement: type: string x-go-name: Measurement message: type: string x-go-name: Message metadata: additionalProperties: type: string description: 标签 type: object x-go-name: Metadata metric: type: string x-go-name: Metric name: description: 资源名称 type: string x-go-name: Name no_data_state: type: string x-go-name: NoDataState node_id: type: string x-go-name: NodeId node_name: type: string x-go-name: NodeName notifier_id: type: string x-go-name: NotifierId org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 period: type: string x-go-name: Period 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 recipients: type: string x-go-name: Recipients res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: $ref: '#/definitions/AlertSetting' state: type: string x-go-name: State state_changes: format: int64 type: integer x-go-name: StateChanges 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 threshold: format: double type: number x-go-name: Threshold 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 used_by: type: string x-go-name: UsedBy window: type: string x-go-name: Window type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor NodeAlertUpdateInput: properties: channel: description: '通知方式, 比如: email, mobile' type: string x-go-name: Channel comparator: description: '比较运算符, 比如: >, <, >=, <=' type: string x-go-name: Comparator description: description: 资源描述 type: string x-go-name: Description enabled: description: 启用报警 type: boolean x-go-name: Enabled execution_error_state: description: 报警执行错误将当前报警状态设置为对应的状态 type: string x-go-name: ExecutionErrorState for: description: 报警持续时间 format: int64 type: integer x-go-name: For frequency: description: 报警执行频率 format: int64 type: integer x-go-name: Frequency level: description: 报警级别 type: string x-go-name: Level message: type: string x-go-name: Message metric: description: 监控指标名称 type: string x-go-name: Metric name: description: 资源名称 type: string x-go-name: Name no_data_state: description: 没有收到监控指标时将当前报警状态设置为对应的状态 type: string x-go-name: NoDataState node_id: description: 监控资源 Id type: string x-go-name: NodeId node_name: description: 监控资源名称 type: string x-go-name: NodeName period: description: 查询指标周期 type: string x-go-name: Period reason: description: 报警原因 type: string x-go-name: Reason recipients: description: 通知接受者 type: string x-go-name: Recipients settings: $ref: '#/definitions/AlertSetting' threshold: description: 报警阀值 format: double type: number x-go-name: Threshold type: description: '监控资源类型, 比如: guest, host' type: string x-go-name: Type window: description: 每隔多久查询一次 type: string x-go-name: Window type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor NotificationCreateInput: properties: disable_resolve_message: description: 是否禁用报警恢复提醒 type: boolean x-go-name: DisableResolveMessage frequency: $ref: '#/definitions/Duration' is_default: description: 是否为默认通知配置 type: boolean x-go-name: IsDefault name: description: 报警通知名称 type: string x-go-name: Name send_reminder: description: 是否一直提醒 type: boolean x-go-name: SendReminder settings: description: 通知配置 type: object x-go-name: Settings type: description: 类型 type: string x-go-name: Type type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor PanelDetails: 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 common_alert_metric_details: items: $ref: '#/definitions/CommonAlertMetricDetails' type: array x-go-name: CommonAlertMetricDetails created_at: description: 资源创建时间 format: date-time type: string x-go-name: CreatedAt customize_config: type: object x-go-name: CustomizeConfig 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 enabled: description: 资源是否启用 type: boolean x-go-name: Enabled eval_data: type: object x-go-name: EvalData execution_error: description: Silenced bool type: string x-go-name: ExecutionError execution_error_state: type: string x-go-name: ExecutionErrorState for: description: |- If an alert rule has a configured `For` and the query violates the configured threshold it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any notifications. Once the alert rule has been firing for more than `For` duration, it will change to `Alerting` and send alert notifications. format: int64 type: integer x-go-name: For frequency: description: Frequency is evaluate period format: int64 type: integer x-go-name: Frequency id: description: 资源UUID type: string x-go-name: Id is_emulated: description: |- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 type: boolean x-go-name: IsEmulated last_state_change: format: date-time type: string x-go-name: LastStateChange level: type: string x-go-name: Level message: type: string x-go-name: Message metadata: additionalProperties: type: string description: 标签 type: object x-go-name: Metadata name: description: 资源名称 type: string x-go-name: Name no_data_state: type: string x-go-name: NoDataState org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: $ref: '#/definitions/AlertSetting' state: type: string x-go-name: State state_changes: format: int64 type: integer x-go-name: StateChanges 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 used_by: type: string x-go-name: UsedBy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor 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 ProjectAlertResourceCount: description: ProjectAlertResourceCount 报警资源统计结果 properties: data: items: $ref: '#/definitions/ProjectAlertResourceCountData' type: array x-go-name: Data type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor ProjectAlertResourceCountData: description: ProjectAlertResourceCountData 报警资源统计数据（按 scope 分类） properties: domain: type: string x-go-name: Domain domain_id: type: string x-go-name: DomainId project: type: string x-go-name: Project project_id: type: string x-go-name: ProjectId res_count: format: int64 type: integer x-go-name: ResCount scope: type: string x-go-name: Scope type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor QueryResultMeta: properties: raw_query: type: string x-go-name: RawQuery result_reducer_value: format: double type: number x-go-name: ResultReducerValue type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor ReducedResult: properties: reducer: $ref: '#/definitions/Condition' result: items: format: double type: number type: array x-go-name: Result type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor ResultLogEntry: properties: data: x-go-name: Data message: type: string x-go-name: Message title: ResultLogEntry represents log data for the alert evaluation. type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor ResultReducerOrder: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/monitor 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 StandaloneAnonResourceBaseUpdateInput: properties: description: description: 资源描述 type: string x-go-name: Description type: object x-go-package: yunion.io/x/onecloud/pkg/apis StandaloneResourceBaseUpdateInput: properties: description: description: 资源描述 type: string x-go-name: Description name: description: 资源名称 type: string x-go-name: Name type: object x-go-package: yunion.io/x/onecloud/pkg/apis StandaloneResourceCreateInput: 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 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 required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis StandaloneResourceDetails: 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 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 TimePoint: items: {} type: array x-go-package: yunion.io/x/onecloud/pkg/apis/monitor TimeSeries: properties: cloud_tags: additionalProperties: type: string type: object x-go-name: CloudTags columns: items: type: string type: array x-go-name: Columns name: type: string x-go-name: Name points: $ref: '#/definitions/TimeSeriesPoints' raw_name: description: RawName is used to frontend displaying the curve name type: string x-go-name: RawName tags: additionalProperties: type: string type: object x-go-name: Tags type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor TimeSeriesPoints: items: $ref: '#/definitions/TimePoint' type: array x-go-package: yunion.io/x/onecloud/pkg/apis/monitor TimeSeriesSlice: items: $ref: '#/definitions/TimeSeries' type: array x-go-package: yunion.io/x/onecloud/pkg/apis/monitor VirtualJointResourceBaseUpdateInput: type: object x-go-package: yunion.io/x/onecloud/pkg/apis VirtualResourceBaseUpdateInput: 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 VirtualResourceDetails: 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 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 host: '"127.0.0.1:8889"' info: contact: email: lizexi@yunion.cn name: Zexi Li description: Cloudprovider API license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html version: "1.0" paths: /alert_notifications: get: description: 列表 operationId: alert_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 - 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: type type: string x-go-name: Type responses: "200": $ref: '#/responses/alert_notification_ListItemFilterOutput' summary: 列表 tags: - alert_notification post: description: 新建 operationId: alert_notification_ValidateCreateData parameters: - in: body name: body schema: properties: alert_notification: $ref: '#/definitions/NotificationCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_notification_ValidateCreateDataOutput' summary: 新建 tags: - alert_notification /alert_notifications/{id}: delete: description: 删除 operationId: alert_notification_CustomizeDelete parameters: - description: The Id or Name of alert_notification in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_notification_CustomizeDeleteOutput' summary: 删除 tags: - alert_notification get: description: 获取详情 operationId: alert_notification_FetchCustomizeColumns parameters: - description: The Id or Name of alert_notification in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_notification_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alert_notification put: description: 更新 operationId: alert_notification_ValidateUpdateData parameters: - description: The Id or Name of alert_notification in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_notification: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_notification_ValidateUpdateDataOutput' summary: 更新 tags: - alert_notification /alert_notifications/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: alert_notification_PerformChangeOwner parameters: - description: The Id or Name of alert_notification in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_notification: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_notification_PerformChangeOwnerOutput' summary: 更改项目 tags: - alert_notification /alert_notifications/{id}/metadata: get: description: 获取指定信息Metadata operationId: alert_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 alert_notification in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_notification_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alert_notification /alert_notifications/{id}/status: get: description: 获取指定信息Status operationId: alert_notification_GetDetailsStatus parameters: - description: The Id or Name of alert_notification in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_notification_GetDetailsStatusOutput' summary: 获取资源状态 tags: - alert_notification /alertdashboards: get: description: 列表 operationId: alertdashboard_ListItemFilter parameters: - 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: 指定匹配的范围，可能值为project, domain or system in: query name: belong_scope type: string x-go-name: BelongScope - description: 以资源是否启用/禁用过滤列表 in: query name: enabled type: boolean x-go-name: Enabled - 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: |- 以报警是否启用/禁用过滤列表 Enabled *bool `json:"enabled"` in: query items: type: string name: monitor_resource_id type: array x-go-name: MonitorResourceId responses: "200": $ref: '#/responses/alertdashboard_ListItemFilterOutput' summary: 列表 tags: - alertdashboard post: description: 新建 operationId: alertdashboard_ValidateCreateData parameters: - in: body name: body schema: properties: alertdashboard: $ref: '#/definitions/AlertDashBoardCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alertdashboard_ValidateCreateDataOutput' summary: 新建 tags: - alertdashboard /alertdashboards/{id}: delete: description: 删除 operationId: alertdashboard_CustomizeDelete parameters: - description: The Id or Name of alertdashboard in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertdashboard_CustomizeDeleteOutput' summary: 删除 tags: - alertdashboard get: description: 获取详情 operationId: alertdashboard_FetchCustomizeColumns parameters: - description: The Id or Name of alertdashboard in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertdashboard_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alertdashboard put: description: 更新 operationId: alertdashboard_ValidateUpdateData parameters: - description: The Id or Name of alertdashboard in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertdashboard_ValidateUpdateDataOutput' summary: 更新 tags: - alertdashboard /alertdashboards/{id}/clone-dashboard: post: description: 执行操作CloneDashboard operationId: alertdashboard_PerformCloneDashboard parameters: - description: The Id or Name of alertdashboard in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alertdashboard: $ref: '#/definitions/AlertCloneDashboardInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alertdashboard_PerformCloneDashboardOutput' summary: 执行操作CloneDashboard tags: - alertdashboard /alertdashboards/{id}/clone-panel: post: description: 执行操作ClonePanel operationId: alertdashboard_PerformClonePanel parameters: - description: The Id or Name of alertdashboard in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alertdashboard: $ref: '#/definitions/AlertClonePanelInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alertdashboard_PerformClonePanelOutput' summary: 执行操作ClonePanel tags: - alertdashboard /alertdashboards/{id}/metadata: get: description: 获取指定信息Metadata operationId: alertdashboard_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 alertdashboard in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertdashboard_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alertdashboard /alertdashboards/{id}/set-panel-order: post: description: 执行操作SetPanelOrder operationId: alertdashboard_PerformSetPanelOrder parameters: - description: The Id or Name of alertdashboard in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alertdashboard: $ref: '#/definitions/AlertPanelSetOrderInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alertdashboard_PerformSetPanelOrderOutput' summary: 执行操作SetPanelOrder tags: - alertdashboard /alertdashboards/{id}/set-scope: post: description: 执行操作SetScope operationId: alertdashboard_PerformSetScope parameters: - description: The Id or Name of alertdashboard in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertdashboard_PerformSetScopeOutput' summary: 执行操作SetScope tags: - alertdashboard /alertdashboards/{id}/status: get: description: 获取指定信息Status operationId: alertdashboard_GetDetailsStatus parameters: - description: The Id or Name of alertdashboard in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertdashboard_GetDetailsStatusOutput' summary: 获取资源状态 tags: - alertdashboard /alertpanels: get: description: 列表 operationId: alertpanel_ListItemFilter parameters: - 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: 指定匹配的范围，可能值为project, domain or system in: query name: belong_scope type: string x-go-name: BelongScope - description: 以资源是否启用/禁用过滤列表 in: query name: enabled type: boolean x-go-name: Enabled - 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: |- 以报警是否启用/禁用过滤列表 Enabled *bool `json:"enabled"` in: query items: type: string name: monitor_resource_id type: array x-go-name: MonitorResourceId - in: query name: dashboard_id type: string x-go-name: DashboardId responses: "200": $ref: '#/responses/alertpanel_ListItemFilterOutput' summary: 列表 tags: - alertpanel post: description: 新建 operationId: alertpanel_ValidateCreateData parameters: - in: body name: body schema: properties: alertpanel: $ref: '#/definitions/AlertPanelCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alertpanel_ValidateCreateDataOutput' summary: 新建 tags: - alertpanel /alertpanels/{id}: delete: description: 删除 operationId: alertpanel_CustomizeDelete parameters: - description: The Id or Name of alertpanel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertpanel_CustomizeDeleteOutput' summary: 删除 tags: - alertpanel get: description: 获取详情 operationId: alertpanel_FetchCustomizeColumns parameters: - description: The Id or Name of alertpanel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertpanel_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alertpanel put: description: 更新 operationId: alertpanel_ValidateUpdateData parameters: - description: The Id or Name of alertpanel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertpanel_ValidateUpdateDataOutput' summary: 更新 tags: - alertpanel /alertpanels/{id}/metadata: get: description: 获取指定信息Metadata operationId: alertpanel_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 alertpanel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertpanel_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alertpanel /alertpanels/{id}/status: get: description: 获取指定信息Status operationId: alertpanel_GetDetailsStatus parameters: - description: The Id or Name of alertpanel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertpanel_GetDetailsStatusOutput' summary: 获取资源状态 tags: - alertpanel /alertrecords: get: description: 列表 operationId: alertrecord_ListItemFilter parameters: - 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: 指定匹配的范围，可能值为project, domain or system in: query name: belong_scope type: string x-go-name: BelongScope - description: 以资源是否启用/禁用过滤列表 in: query name: enabled type: boolean x-go-name: Enabled - 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: alert_id type: string x-go-name: AlertId - in: query name: alert_name type: string x-go-name: AlertName - in: query name: level type: string x-go-name: Level - in: query name: state type: string x-go-name: State - in: query name: res_type type: string x-go-name: ResType - in: query name: alerting type: boolean x-go-name: Alerting - in: query name: res_name type: string x-go-name: ResName - in: query name: res_id type: string x-go-name: ResId responses: "200": $ref: '#/responses/alertrecord_ListItemFilterOutput' summary: 列表 tags: - alertrecord post: description: 新建 operationId: alertrecord_ValidateCreateData parameters: - in: body name: body schema: properties: alertrecord: $ref: '#/definitions/AlertRecordCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alertrecord_ValidateCreateDataOutput' summary: 新建 tags: - alertrecord /alertrecords/{id}: delete: description: 删除 operationId: alertrecord_CustomizeDelete parameters: - description: The Id or Name of alertrecord in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertrecord_CustomizeDeleteOutput' summary: 删除 tags: - alertrecord get: description: 获取详情 operationId: alertrecord_FetchCustomizeColumns parameters: - description: The Id or Name of alertrecord in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertrecord_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alertrecord put: description: 更新 operationId: alertrecord_ValidateUpdateData parameters: - description: The Id or Name of alertrecord in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alertrecord: $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alertrecord_ValidateUpdateDataOutput' summary: 更新 tags: - alertrecord /alertrecords/{id}/metadata: get: description: 获取指定信息Metadata operationId: alertrecord_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 alertrecord in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertrecord_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alertrecord /alertrecords/history-alert: get: description: 获取指定资源类的信息HistoryAlert operationId: alertrecord_GetPropertyHistoryAlert responses: "200": $ref: '#/responses/alertrecord_GetPropertyHistoryAlertOutput' summary: 获取过去一天的报警历史分布 tags: - alertrecord /alertrecords/project-alert-resource-count: get: description: 获取指定资源类的信息ProjectAlertResourceCount operationId: alertrecord_GetPropertyProjectAlertResourceCount parameters: - format: date-time in: query name: start_time type: string x-go-name: StartTime - format: date-time in: query name: end_time type: string x-go-name: EndTime - in: query name: res_type type: string x-go-name: ResType - in: query name: alert_id type: string x-go-name: AlertId - in: query name: scope type: string x-go-name: Scope responses: "200": $ref: '#/responses/alertrecord_GetPropertyProjectAlertResourceCountOutput' summary: GetPropertyProjectAlertResourceCount 获取指定时间段内各项目下的报警资源数量 tags: - alertrecord /alertrecords/total-alert: get: description: 获取指定资源类的信息TotalAlert operationId: alertrecord_GetPropertyTotalAlert responses: "200": $ref: '#/responses/alertrecord_GetPropertyTotalAlertOutput' summary: 获取指定资源类的信息TotalAlert tags: - alertrecord /alertrecordshields: get: description: 列表 operationId: alertrecordshield_ListItemFilter parameters: - 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: 指定匹配的范围，可能值为project, domain or system in: query name: belong_scope type: string x-go-name: BelongScope - description: 以资源是否启用/禁用过滤列表 in: query name: enabled type: boolean x-go-name: Enabled - 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: alert_name type: string x-go-name: AlertName - in: query name: res_type type: string x-go-name: ResType - in: query name: res_name type: string x-go-name: ResName - in: query name: res_id type: string x-go-name: ResId - in: query name: alert_id type: string x-go-name: AlertId - format: date-time in: query name: start_time type: string x-go-name: StartTime - format: date-time in: query name: end_time type: string x-go-name: EndTime responses: "200": $ref: '#/responses/alertrecordshield_ListItemFilterOutput' summary: 列表 tags: - alertrecordshield post: description: 新建 operationId: alertrecordshield_ValidateCreateData parameters: - in: body name: body schema: properties: alertrecordshield: $ref: '#/definitions/AlertRecordShieldCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alertrecordshield_ValidateCreateDataOutput' summary: 新建 tags: - alertrecordshield /alertrecordshields/{id}: delete: description: 删除 operationId: alertrecordshield_CustomizeDelete parameters: - description: The Id or Name of alertrecordshield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertrecordshield_CustomizeDeleteOutput' summary: 删除 tags: - alertrecordshield get: description: 获取详情 operationId: alertrecordshield_FetchCustomizeColumns parameters: - description: The Id or Name of alertrecordshield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertrecordshield_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alertrecordshield put: description: 更新 operationId: alertrecordshield_ValidateUpdateData parameters: - description: The Id or Name of alertrecordshield in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alertrecordshield: $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alertrecordshield_ValidateUpdateDataOutput' summary: 更新 tags: - alertrecordshield /alertrecordshields/{id}/metadata: get: description: 获取指定信息Metadata operationId: alertrecordshield_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 alertrecordshield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertrecordshield_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alertrecordshield /alertrecordshields/{id}/status: get: description: 获取指定信息Status operationId: alertrecordshield_GetDetailsStatus parameters: - description: The Id or Name of alertrecordshield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertrecordshield_GetDetailsStatusOutput' summary: 获取资源状态 tags: - alertrecordshield /alertresources: get: description: 列表 operationId: alertresource_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 - in: query name: type type: string x-go-name: Type responses: "200": $ref: '#/responses/alertresource_ListItemFilterOutput' summary: 列表 tags: - alertresource post: description: 新建 operationId: alertresource_ValidateCreateData parameters: - in: body name: body schema: properties: alertresource: $ref: '#/definitions/StandaloneResourceCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alertresource_ValidateCreateDataOutput' summary: 新建 tags: - alertresource /alertresources/{id}: delete: description: 删除 operationId: alertresource_CustomizeDelete parameters: - description: The Id or Name of alertresource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertresource_CustomizeDeleteOutput' summary: 删除 tags: - alertresource get: description: 获取详情 operationId: alertresource_FetchCustomizeColumns parameters: - description: The Id or Name of alertresource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertresource_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alertresource put: description: 更新 operationId: alertresource_ValidateUpdateData parameters: - description: The Id or Name of alertresource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alertresource: $ref: '#/definitions/StandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alertresource_ValidateUpdateDataOutput' summary: 更新 tags: - alertresource /alertresources/{id}/metadata: get: description: 获取指定信息Metadata operationId: alertresource_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 alertresource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alertresource_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alertresource /alerts: get: description: 列表 operationId: alert_ListItemFilter parameters: - 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: 指定匹配的范围，可能值为project, domain or system in: query name: belong_scope type: string x-go-name: BelongScope - description: 以资源是否启用/禁用过滤列表 in: query name: enabled type: boolean x-go-name: Enabled - 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: |- 以报警是否启用/禁用过滤列表 Enabled *bool `json:"enabled"` in: query items: type: string name: monitor_resource_id type: array x-go-name: MonitorResourceId responses: "200": $ref: '#/responses/alert_ListItemFilterOutput' summary: 列表 tags: - alert post: description: 新建 operationId: alert_ValidateCreateData parameters: - in: body name: body schema: properties: alert: $ref: '#/definitions/AlertCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_ValidateCreateDataOutput' summary: 新建 tags: - alert /alerts/{id}: delete: description: 删除 operationId: alert_CustomizeDelete parameters: - description: The Id or Name of alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_CustomizeDeleteOutput' summary: 删除 tags: - alert get: description: 获取详情 operationId: alert_FetchCustomizeColumns parameters: - description: The Id or Name of alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alert put: description: 更新 operationId: alert_ValidateUpdateData parameters: - description: The Id or Name of alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert: $ref: '#/definitions/AlertUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_ValidateUpdateDataOutput' summary: 更新 tags: - alert /alerts/{id}/disable: post: description: 执行操作Disable operationId: alert_PerformDisable parameters: - description: The Id or Name of alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_PerformDisableOutput' summary: 执行操作Disable tags: - alert /alerts/{id}/enable: post: description: 执行操作Enable operationId: alert_PerformEnable parameters: - description: The Id or Name of alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_PerformEnableOutput' summary: 执行操作Enable tags: - alert /alerts/{id}/metadata: get: description: 获取指定信息Metadata operationId: alert_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 alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alert /alerts/{id}/pause: post: description: 执行操作Pause operationId: alert_PerformPause parameters: - description: The Id or Name of alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert: $ref: '#/definitions/AlertPauseInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_PerformPauseOutput' summary: 执行操作Pause tags: - alert /alerts/{id}/status: get: description: 获取指定信息Status operationId: alert_GetDetailsStatus parameters: - description: The Id or Name of alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_GetDetailsStatusOutput' summary: 获取资源状态 tags: - alert /alerts/{id}/test-run: post: description: 执行操作TestRun operationId: alert_PerformTestRun parameters: - description: The Id or Name of alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert: $ref: '#/definitions/AlertTestRunInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_PerformTestRunOutput' summary: 执行操作TestRun tags: - alert /commonalerts: get: description: 列表 operationId: commonalert_ListItemFilter parameters: - 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: 指定匹配的范围，可能值为project, domain or system in: query name: belong_scope type: string x-go-name: BelongScope - description: 以资源是否启用/禁用过滤列表 in: query name: enabled type: boolean x-go-name: Enabled - 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: status type: array x-go-name: Status - description: |- 以报警是否启用/禁用过滤列表 Enabled *bool `json:"enabled"` in: query items: type: string name: monitor_resource_id type: array x-go-name: MonitorResourceId - description: 查询时间段开始时间 format: date-time in: query name: start_time type: string x-go-name: StartTime - description: 查询时间段结束时间 format: date-time in: query name: end_time type: string x-go-name: EndTime - description: 返回 top N（默认 5） format: int64 in: query name: top type: integer x-go-name: Top - description: |- V1AlertListInput 报警类型 in: query name: alert_type type: string x-go-name: AlertType - description: 监控指标名称 in: query name: metric type: string x-go-name: Metric - in: query name: level type: string x-go-name: Level - in: query items: type: string name: res_type type: array x-go-name: ResType - in: query name: used_by type: string x-go-name: UsedBy - description: 以资源名称过滤列表 in: query items: type: string name: name type: string x-go-name: Name responses: "200": $ref: '#/responses/commonalert_ListItemFilterOutput' summary: 列表 tags: - commonalert post: description: 新建 operationId: commonalert_ValidateCreateData parameters: - in: body name: body schema: properties: commonalert: $ref: '#/definitions/CommonAlertCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/commonalert_ValidateCreateDataOutput' summary: 新建 tags: - commonalert /commonalerts/{id}: delete: description: 删除 operationId: commonalert_CustomizeDelete parameters: - description: The Id or Name of commonalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/commonalert_CustomizeDeleteOutput' summary: 删除 tags: - commonalert get: description: 获取详情 operationId: commonalert_FetchCustomizeColumns parameters: - description: The Id or Name of commonalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/commonalert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - commonalert put: description: 更新 operationId: commonalert_ValidateUpdateData parameters: - description: The Id or Name of commonalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/commonalert_ValidateUpdateDataOutput' summary: 更新 tags: - commonalert /commonalerts/{id}/config: post: description: 执行操作Config operationId: commonalert_PerformConfig parameters: - description: The Id or Name of commonalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/commonalert_PerformConfigOutput' summary: 执行操作Config tags: - commonalert /commonalerts/{id}/disable: post: description: 执行操作Disable operationId: commonalert_PerformDisable parameters: - description: The Id or Name of commonalert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: commonalert: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/commonalert_PerformDisableOutput' summary: 执行操作Disable tags: - commonalert /commonalerts/{id}/enable: post: description: 执行操作Enable operationId: commonalert_PerformEnable parameters: - description: The Id or Name of commonalert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: commonalert: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/commonalert_PerformEnableOutput' summary: 执行操作Enable tags: - commonalert /commonalerts/{id}/metadata: get: description: 获取指定信息Metadata operationId: commonalert_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 commonalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/commonalert_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - commonalert /commonalerts/{id}/pause: post: description: 执行操作Pause operationId: commonalert_PerformPause parameters: - description: The Id or Name of commonalert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: commonalert: $ref: '#/definitions/AlertPauseInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/commonalert_PerformPauseOutput' summary: 执行操作Pause tags: - commonalert /commonalerts/{id}/set-scope: post: description: 执行操作SetScope operationId: commonalert_PerformSetScope parameters: - description: The Id or Name of commonalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/commonalert_PerformSetScopeOutput' summary: 执行操作SetScope tags: - commonalert /commonalerts/{id}/status: get: description: 获取指定信息Status operationId: commonalert_GetDetailsStatus parameters: - description: The Id or Name of commonalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/commonalert_GetDetailsStatusOutput' summary: 获取资源状态 tags: - commonalert /commonalerts/{id}/test-run: post: description: 执行操作TestRun operationId: commonalert_PerformTestRun parameters: - description: The Id or Name of commonalert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: commonalert: $ref: '#/definitions/AlertTestRunInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/commonalert_PerformTestRunOutput' summary: 执行操作TestRun tags: - commonalert /datasources: get: description: 列表 operationId: datasource_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 responses: "200": $ref: '#/responses/datasource_ListItemFilterOutput' summary: 列表 tags: - datasource post: description: 新建 operationId: datasource_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count datasource: $ref: '#/definitions/StandaloneResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/datasource_ValidateCreateDataOutput' summary: 新建 tags: - datasource /datasources/{id}: delete: description: 删除 operationId: datasource_CustomizeDelete parameters: - description: The Id or Name of datasource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/datasource_CustomizeDeleteOutput' summary: 删除 tags: - datasource get: description: 获取详情 operationId: datasource_FetchCustomizeColumns parameters: - description: The Id or Name of datasource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/datasource_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - datasource put: description: 更新 operationId: datasource_ValidateUpdateData parameters: - description: The Id or Name of datasource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: datasource: $ref: '#/definitions/StandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/datasource_ValidateUpdateDataOutput' summary: 更新 tags: - datasource /datasources/{id}/metadata: get: description: 获取指定信息Metadata operationId: datasource_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 datasource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/datasource_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - datasource /metricfields: get: description: 列表 operationId: metricfield_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 in: query items: type: string name: status type: array x-go-name: Status - description: 以资源是否启用/禁用过滤列表 in: query name: enabled type: boolean x-go-name: Enabled - 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: 指定匹配的范围，可能值为project, domain or system in: query name: belong_scope type: string x-go-name: BelongScope - in: query name: display_name type: string x-go-name: DisplayName - in: query name: unit type: string x-go-name: Unit - description: 指定查询的权限范围，可能值为project, domain or system in: query name: scope type: string x-go-name: Scope responses: "200": $ref: '#/responses/metricfield_ListItemFilterOutput' summary: 列表 tags: - metricfield post: description: 新建 operationId: metricfield_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count metricfield: $ref: '#/definitions/MetricFieldCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metricfield_ValidateCreateDataOutput' summary: 新建 tags: - metricfield /metricfields/{id}: delete: description: 删除 operationId: metricfield_CustomizeDelete parameters: - description: The Id or Name of metricfield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metricfield_CustomizeDeleteOutput' summary: 删除 tags: - metricfield get: description: 获取详情 operationId: metricfield_FetchCustomizeColumns parameters: - description: The Id or Name of metricfield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metricfield_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - metricfield put: description: 更新 operationId: metricfield_ValidateUpdateData parameters: - description: The Id or Name of metricfield in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metricfield: $ref: '#/definitions/MetricFieldUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metricfield_ValidateUpdateDataOutput' summary: 更新 tags: - metricfield /metricfields/{id}/metadata: get: description: 获取指定信息Metadata operationId: metricfield_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 metricfield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metricfield_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - metricfield /metricfields/{id}/status: get: description: 获取指定信息Status operationId: metricfield_GetDetailsStatus parameters: - description: The Id or Name of metricfield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metricfield_GetDetailsStatusOutput' summary: 获取资源状态 tags: - metricfield /metricmeasurements: get: description: 列表 operationId: metricmeasurement_ListItemFilter parameters: - $ref: '#/definitions/MetricMeasurementListInput' in: query name: measurement x-go-name: Measurement - $ref: '#/definitions/MetricFieldListInput' in: query name: metric_fields x-go-name: MetricFields - in: query name: scope type: string x-go-name: Scope responses: "200": $ref: '#/responses/metricmeasurement_ListItemFilterOutput' summary: 列表 tags: - metricmeasurement post: description: 新建 operationId: metricmeasurement_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count metricmeasurement: $ref: '#/definitions/MetricCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metricmeasurement_ValidateCreateDataOutput' summary: 新建 tags: - metricmeasurement /metricmeasurements/{id}: delete: description: 删除 operationId: metricmeasurement_CustomizeDelete parameters: - description: The Id or Name of metricmeasurement in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metricmeasurement_CustomizeDeleteOutput' summary: 删除 tags: - metricmeasurement get: description: 获取详情 operationId: metricmeasurement_FetchCustomizeColumns parameters: - description: The Id or Name of metricmeasurement in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metricmeasurement_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - metricmeasurement put: description: 更新 operationId: metricmeasurement_ValidateUpdateData parameters: - description: The Id or Name of metricmeasurement in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metricmeasurement: $ref: '#/definitions/MetricUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metricmeasurement_ValidateUpdateDataOutput' summary: 更新 tags: - metricmeasurement /metricmeasurements/{id}/metadata: get: description: 获取指定信息Metadata operationId: metricmeasurement_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 metricmeasurement in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metricmeasurement_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - metricmeasurement /metricmeasurements/{id}/status: get: description: 获取指定信息Status operationId: metricmeasurement_GetDetailsStatus parameters: - description: The Id or Name of metricmeasurement in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metricmeasurement_GetDetailsStatusOutput' summary: 获取资源状态 tags: - metricmeasurement /metrics: get: description: 列表 operationId: metric_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/metric_ListItemFilterOutput' summary: 列表 tags: - metric post: description: 新建 operationId: metric_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count metric: $ref: '#/definitions/JoinResourceBaseCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_ValidateCreateDataOutput' summary: 新建 tags: - metric /metrics/{id}: delete: description: 删除 operationId: metric_CustomizeDelete parameters: - description: The Id or Name of metric in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_CustomizeDeleteOutput' summary: 删除 tags: - metric get: description: 获取详情 operationId: metric_FetchCustomizeColumns parameters: - description: The Id or Name of metric in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - metric put: description: 更新 operationId: metric_ValidateUpdateData parameters: - description: The Id or Name of metric in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric: $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_ValidateUpdateDataOutput' summary: 更新 tags: - metric /migrationalerts: get: description: 列表 operationId: migrationalert_ListItemFilter parameters: - 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: 指定匹配的范围，可能值为project, domain or system in: query name: belong_scope type: string x-go-name: BelongScope - description: 以资源是否启用/禁用过滤列表 in: query name: enabled type: boolean x-go-name: Enabled - 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: |- 以报警是否启用/禁用过滤列表 Enabled *bool `json:"enabled"` in: query items: type: string name: monitor_resource_id type: array x-go-name: MonitorResourceId - in: query name: metric_type type: string x-go-name: MetricType responses: "200": $ref: '#/responses/migrationalert_ListItemFilterOutput' summary: 列表 tags: - migrationalert post: description: 新建 operationId: migrationalert_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count migrationalert: $ref: '#/definitions/MigrationAlertCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migrationalert_ValidateCreateDataOutput' summary: 新建 tags: - migrationalert /migrationalerts/{id}: delete: description: 删除 operationId: migrationalert_CustomizeDelete parameters: - description: The Id or Name of migrationalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/migrationalert_CustomizeDeleteOutput' summary: 删除 tags: - migrationalert get: description: 获取详情 operationId: migrationalert_FetchCustomizeColumns parameters: - description: The Id or Name of migrationalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/migrationalert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - migrationalert put: description: 更新 operationId: migrationalert_ValidateUpdateData parameters: - description: The Id or Name of migrationalert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migrationalert: $ref: '#/definitions/AlertUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migrationalert_ValidateUpdateDataOutput' summary: 更新 tags: - migrationalert /migrationalerts/{id}/disable: post: description: 执行操作Disable operationId: migrationalert_PerformDisable parameters: - description: The Id or Name of migrationalert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migrationalert: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migrationalert_PerformDisableOutput' summary: 执行操作Disable tags: - migrationalert /migrationalerts/{id}/enable: post: description: 执行操作Enable operationId: migrationalert_PerformEnable parameters: - description: The Id or Name of migrationalert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migrationalert: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migrationalert_PerformEnableOutput' summary: 执行操作Enable tags: - migrationalert /migrationalerts/{id}/metadata: get: description: 获取指定信息Metadata operationId: migrationalert_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 migrationalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/migrationalert_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - migrationalert /migrationalerts/{id}/pause: post: description: 执行操作Pause operationId: migrationalert_PerformPause parameters: - description: The Id or Name of migrationalert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migrationalert: $ref: '#/definitions/AlertPauseInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migrationalert_PerformPauseOutput' summary: 执行操作Pause tags: - migrationalert /migrationalerts/{id}/status: get: description: 获取指定信息Status operationId: migrationalert_GetDetailsStatus parameters: - description: The Id or Name of migrationalert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/migrationalert_GetDetailsStatusOutput' summary: 获取资源状态 tags: - migrationalert /migrationalerts/{id}/test-run: post: description: 执行操作TestRun operationId: migrationalert_PerformTestRun parameters: - description: The Id or Name of migrationalert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migrationalert: $ref: '#/definitions/AlertTestRunInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migrationalert_PerformTestRunOutput' summary: 执行操作TestRun tags: - migrationalert /monitorresourcealerts: get: description: 列表 operationId: monitorresourcealert_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: 查询时间段开始时间 format: date-time in: query name: start_time type: string x-go-name: StartTime - description: 查询时间段结束时间 format: date-time in: query name: end_time type: string x-go-name: EndTime - description: 返回 top N（默认 5） format: int64 in: query name: top type: integer x-go-name: Top - in: query name: monitor_resource_id type: string x-go-name: MonitorResourceId - in: query name: alert_id type: string x-go-name: AlertId - in: query items: format: int64 type: integer name: joint_id type: array x-go-name: JointId - in: query name: alerting type: boolean x-go-name: Alerting - in: query name: alert_state type: string x-go-name: AlertState - in: query name: send_state type: string x-go-name: SendState - in: query name: res_type type: string x-go-name: ResType - in: query name: metric type: string x-go-name: Metric - in: query name: res_name type: string x-go-name: ResName - in: query name: alert_name type: string x-go-name: AlertName - in: query name: level type: string x-go-name: Level - description: 查询所有状态 in: query name: all_state type: boolean x-go-name: AllState responses: "200": $ref: '#/responses/monitorresourcealert_ListItemFilterOutput' summary: 列表 tags: - monitorresourcealert post: description: 新建 operationId: monitorresourcealert_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count monitorresourcealert: $ref: '#/definitions/JoinResourceBaseCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitorresourcealert_ValidateCreateDataOutput' summary: 新建 tags: - monitorresourcealert /monitorresourcealerts/{id}: delete: description: 删除 operationId: monitorresourcealert_CustomizeDelete parameters: - description: The Id or Name of monitorresourcealert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitorresourcealert_CustomizeDeleteOutput' summary: 删除 tags: - monitorresourcealert get: description: 获取详情 operationId: monitorresourcealert_FetchCustomizeColumns parameters: - description: The Id or Name of monitorresourcealert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitorresourcealert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - monitorresourcealert put: description: 更新 operationId: monitorresourcealert_ValidateUpdateData parameters: - description: The Id or Name of monitorresourcealert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitorresourcealert: $ref: '#/definitions/JointResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitorresourcealert_ValidateUpdateDataOutput' summary: 更新 tags: - monitorresourcealert /monitorresources: get: description: 列表 operationId: monitorresource_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: 指定项目的名称或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 - description: 指定查询的权限范围，可能值为project, domain or system in: query name: scope type: string x-go-name: Scope - description: 指定项目归属域名称或ID in: query name: project_domain_id type: string x-go-name: ProjectDomainId - description: 对具有域属性的资源，严格匹配域ID in: query items: type: string name: project_domain_ids type: array x-go-name: ProjectDomainIds - description: 按domain名称排序，可能值为asc|desc in: query name: order_by_domain pattern: asc|desc type: string x-go-name: OrderByDomain - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: domain_tags x-go-name: DomainTags - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: no_domain_tags x-go-name: NoDomainTags - description: |- 列出指定云平台的资源，支持的云平台如下 Provider | 开始支持版本 | 平台 | -----------|------------|-------------------------------------| OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | VMware | 1.2 | VMware vCenter | OpenStack | 2.6 | OpenStack M版本以上私有云 | ZStack | 2.10 | ZStack私有云 | Aliyun | 2.0 | 阿里云 | Aws | 2.3 | Amazon AWS | Azure | 2.2 | Microsoft Azure | Google | 2.13 | Google Cloud Platform | Qcloud | 2.3 | 腾讯云 | Huawei | 2.5 | 华为公有云 | Ucloud | 2.7 | UCLOUD | Ctyun | 2.13 | 天翼云 | S3 | 2.11 | 通用s3对象存储 | Ceph | 2.11 | Ceph对象存储 | Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | enum: - OneCloud - VMware - Aliyun - Qcloud - Azure - Aws - Huawei - OpenStack - Ucloud - ZStack - Google - Ctyun - S3 - Ceph - Xsky in: query items: type: string name: providers type: array x-go-name: Providers - in: query items: type: string name: brands type: array x-go-name: Brands - description: |- 列出指定云环境的资源，支持云环境如下： CloudEnv | 说明 | -----------|--------| public | 公有云 | private | 私有云 | onpremise | 本地IDC | enum: - public - private - onpremise in: query name: cloud_env type: string x-go-name: CloudEnv - description: 以平台名称排序 in: query name: order_by_provider pattern: asc|desc type: string x-go-name: OrderByProvider - description: 以平台品牌排序 in: query name: order_by_brand pattern: asc|desc type: string x-go-name: OrderByBrand - description: 列出关联指定云订阅(ID或Name)的资源 in: query items: type: string name: cloudprovider_id type: array x-go-name: CloudproviderId - description: 列出关联指定云账号(ID或Name)的资源 in: query items: type: string name: cloudaccount_id type: array x-go-name: CloudaccountId - default: false description: 过滤资源，是否为非OneCloud内置私有云管理的资源 in: query name: is_managed type: boolean x-go-name: IsManaged - description: 以云账号名称排序 in: query name: order_by_account pattern: asc|desc type: string x-go-name: OrderByAccount - description: 以云订阅名称排序 in: query name: order_by_manager pattern: asc|desc type: string x-go-name: OrderByManager - description: 查询时间段开始时间 format: date-time in: query name: start_time type: string x-go-name: StartTime - description: 查询时间段结束时间 format: date-time in: query name: end_time type: string x-go-name: EndTime - description: 返回 top N（默认 5） format: int64 in: query name: top type: integer x-go-name: Top - in: query items: type: string name: res_id type: array x-go-name: ResId - in: query name: res_type type: string x-go-name: ResType - in: query name: only_res_id type: boolean x-go-name: OnlyResId - in: query items: type: string name: alert_states type: array x-go-name: AlertStates - in: query name: res_name type: string x-go-name: ResName responses: "200": $ref: '#/responses/monitorresource_ListItemFilterOutput' summary: 列表 tags: - monitorresource post: description: 新建 operationId: monitorresource_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count monitorresource: $ref: '#/definitions/MonitorResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitorresource_ValidateCreateDataOutput' summary: 新建 tags: - monitorresource /monitorresources/{id}: delete: description: 删除 operationId: monitorresource_CustomizeDelete parameters: - description: The Id or Name of monitorresource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitorresource_CustomizeDeleteOutput' summary: 删除 tags: - monitorresource get: description: 获取详情 operationId: monitorresource_FetchCustomizeColumns parameters: - description: The Id or Name of monitorresource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitorresource_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - monitorresource put: description: 更新 operationId: monitorresource_ValidateUpdateData parameters: - description: The Id or Name of monitorresource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitorresource: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitorresource_ValidateUpdateDataOutput' summary: 更新 tags: - monitorresource /monitorresources/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: monitorresource_PerformChangeOwner parameters: - description: The Id or Name of monitorresource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitorresource: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitorresource_PerformChangeOwnerOutput' summary: 更改项目 tags: - monitorresource /monitorresources/{id}/do-action: post: description: 执行操作DoAction operationId: monitorresource_PerformDoAction parameters: - description: The Id or Name of monitorresource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitorresource: $ref: '#/definitions/MonitorResourceDoActionInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitorresource_PerformDoActionOutput' summary: 执行操作DoAction tags: - monitorresource /monitorresources/{id}/metadata: get: description: 获取指定信息Metadata operationId: monitorresource_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 monitorresource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitorresource_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - monitorresource /monitorresources/{id}/status: get: description: 获取指定信息Status operationId: monitorresource_GetDetailsStatus parameters: - description: The Id or Name of monitorresource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitorresource_GetDetailsStatusOutput' summary: 获取资源状态 tags: - monitorresource /monitorresources/alert: get: description: 获取指定资源类的信息Alert operationId: monitorresource_GetPropertyAlert responses: "200": $ref: '#/responses/monitorresource_GetPropertyAlertOutput' summary: 获取指定资源类的信息Alert tags: - monitorresource /nodealerts: get: description: 列表 operationId: nodealert_ListItemFilter parameters: - 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: 指定匹配的范围，可能值为project, domain or system in: query name: belong_scope type: string x-go-name: BelongScope - description: 以资源是否启用/禁用过滤列表 in: query name: enabled type: boolean x-go-name: Enabled - 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: |- 以报警是否启用/禁用过滤列表 Enabled *bool `json:"enabled"` in: query items: type: string name: monitor_resource_id type: array x-go-name: MonitorResourceId - description: 监控指标名称 in: query name: metric type: string x-go-name: Metric - description: '监控资源类型, 比如: guest, host' in: query name: type type: string x-go-name: Type - description: 监控资源名称 in: query name: node_name type: string x-go-name: NodeName - description: 监控资源 Id in: query name: node_id type: string x-go-name: NodeId responses: "200": $ref: '#/responses/nodealert_ListItemFilterOutput' summary: 列表 tags: - nodealert post: description: 新建 operationId: nodealert_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count nodealert: $ref: '#/definitions/NodeAlertCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/nodealert_ValidateCreateDataOutput' summary: 新建 tags: - nodealert /nodealerts/{id}: delete: description: 删除 operationId: nodealert_CustomizeDelete parameters: - description: The Id or Name of nodealert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/nodealert_CustomizeDeleteOutput' summary: 删除 tags: - nodealert get: description: 获取详情 operationId: nodealert_FetchCustomizeColumns parameters: - description: The Id or Name of nodealert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/nodealert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - nodealert put: description: 更新 operationId: nodealert_ValidateUpdateData parameters: - description: The Id or Name of nodealert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: nodealert: $ref: '#/definitions/NodeAlertUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/nodealert_ValidateUpdateDataOutput' summary: 更新 tags: - nodealert /nodealerts/{id}/config: post: description: 执行操作Config operationId: nodealert_PerformConfig parameters: - description: The Id or Name of nodealert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/nodealert_PerformConfigOutput' summary: 执行操作Config tags: - nodealert /nodealerts/{id}/disable: post: description: 执行操作Disable operationId: nodealert_PerformDisable parameters: - description: The Id or Name of nodealert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: nodealert: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/nodealert_PerformDisableOutput' summary: 执行操作Disable tags: - nodealert /nodealerts/{id}/enable: post: description: 执行操作Enable operationId: nodealert_PerformEnable parameters: - description: The Id or Name of nodealert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: nodealert: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/nodealert_PerformEnableOutput' summary: 执行操作Enable tags: - nodealert /nodealerts/{id}/metadata: get: description: 获取指定信息Metadata operationId: nodealert_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 nodealert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/nodealert_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - nodealert /nodealerts/{id}/pause: post: description: 执行操作Pause operationId: nodealert_PerformPause parameters: - description: The Id or Name of nodealert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: nodealert: $ref: '#/definitions/AlertPauseInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/nodealert_PerformPauseOutput' summary: 执行操作Pause tags: - nodealert /nodealerts/{id}/set-scope: post: description: 执行操作SetScope operationId: nodealert_PerformSetScope parameters: - description: The Id or Name of nodealert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/nodealert_PerformSetScopeOutput' summary: 执行操作SetScope tags: - nodealert /nodealerts/{id}/status: get: description: 获取指定信息Status operationId: nodealert_GetDetailsStatus parameters: - description: The Id or Name of nodealert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/nodealert_GetDetailsStatusOutput' summary: 获取资源状态 tags: - nodealert /nodealerts/{id}/test-run: post: description: 执行操作TestRun operationId: nodealert_PerformTestRun parameters: - description: The Id or Name of nodealert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: nodealert: $ref: '#/definitions/AlertTestRunInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/nodealert_PerformTestRunOutput' summary: 执行操作TestRun tags: - nodealert /unifiedmonitors/query: post: description: 查询监控数据接口 operationId: models_PerformQuery parameters: - in: body name: body schema: $ref: '#/definitions/MetricQueryInput' x-go-name: Body responses: "200": $ref: '#/responses/models_PerformQueryOutput' summary: 查询监控数据接口 tags: - unifiedmonitor produces: - application/json responses: alert_CustomizeDeleteOutput: description: "" schema: properties: alert: $ref: '#/definitions/AlertDetails' type: object alert_FetchCustomizeColumnsOutput: description: "" schema: properties: alert: $ref: '#/definitions/AlertDetails' type: object alert_GetDetailsMetadataOutput: description: "" schema: properties: alert: additionalProperties: type: string type: object x-go-name: Output type: object alert_GetDetailsStatusOutput: description: "" schema: properties: alert: $ref: '#/definitions/GetDetailsStatusOutput' type: object alert_ListItemFilterOutput: description: "" schema: properties: alerts: items: $ref: '#/definitions/AlertDetails' 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 alert_PerformDisableOutput: description: "" alert_PerformEnableOutput: description: "" alert_PerformPauseOutput: description: "" alert_PerformTestRunOutput: description: "" schema: properties: alert: $ref: '#/definitions/AlertTestRunOutput' type: object alert_ValidateCreateDataOutput: description: "" schema: properties: alert: $ref: '#/definitions/AlertDetails' type: object alert_ValidateUpdateDataOutput: description: "" schema: properties: alert: $ref: '#/definitions/AlertDetails' type: object alert_notification_CustomizeDeleteOutput: description: "" schema: properties: alert_notification: $ref: '#/definitions/VirtualResourceDetails' type: object alert_notification_FetchCustomizeColumnsOutput: description: "" schema: properties: alert_notification: $ref: '#/definitions/VirtualResourceDetails' type: object alert_notification_GetDetailsMetadataOutput: description: "" schema: properties: alert_notification: additionalProperties: type: string type: object x-go-name: Output type: object alert_notification_GetDetailsStatusOutput: description: "" schema: properties: alert_notification: $ref: '#/definitions/GetDetailsStatusOutput' type: object alert_notification_ListItemFilterOutput: description: "" schema: properties: alert_notifications: items: $ref: '#/definitions/VirtualResourceDetails' 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 alert_notification_PerformChangeOwnerOutput: description: "" alert_notification_ValidateCreateDataOutput: description: "" schema: properties: alert_notification: $ref: '#/definitions/VirtualResourceDetails' type: object alert_notification_ValidateUpdateDataOutput: description: "" schema: properties: alert_notification: $ref: '#/definitions/VirtualResourceDetails' type: object alertdashboard_CustomizeDeleteOutput: description: "" schema: properties: alertdashboard: $ref: '#/definitions/AlertDashBoardDetails' type: object alertdashboard_FetchCustomizeColumnsOutput: description: "" schema: properties: alertdashboard: $ref: '#/definitions/AlertDashBoardDetails' type: object alertdashboard_GetDetailsMetadataOutput: description: "" schema: properties: alertdashboard: additionalProperties: type: string type: object x-go-name: Output type: object alertdashboard_GetDetailsStatusOutput: description: "" schema: properties: alertdashboard: $ref: '#/definitions/GetDetailsStatusOutput' type: object alertdashboard_ListItemFilterOutput: description: "" schema: properties: alertdashboards: items: $ref: '#/definitions/AlertDashBoardDetails' 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 alertdashboard_PerformCloneDashboardOutput: description: "" alertdashboard_PerformClonePanelOutput: description: "" alertdashboard_PerformSetPanelOrderOutput: description: "" alertdashboard_PerformSetScopeOutput: description: "" alertdashboard_ValidateCreateDataOutput: description: "" schema: properties: alertdashboard: $ref: '#/definitions/AlertDashBoardDetails' type: object alertdashboard_ValidateUpdateDataOutput: description: "" schema: properties: alertdashboard: $ref: '#/definitions/AlertDashBoardDetails' type: object alertpanel_CustomizeDeleteOutput: description: "" schema: properties: alertpanel: $ref: '#/definitions/PanelDetails' type: object alertpanel_FetchCustomizeColumnsOutput: description: "" schema: properties: alertpanel: $ref: '#/definitions/PanelDetails' type: object alertpanel_GetDetailsMetadataOutput: description: "" schema: properties: alertpanel: additionalProperties: type: string type: object x-go-name: Output type: object alertpanel_GetDetailsStatusOutput: description: "" schema: properties: alertpanel: $ref: '#/definitions/GetDetailsStatusOutput' type: object alertpanel_ListItemFilterOutput: description: "" schema: properties: alertpanels: items: $ref: '#/definitions/PanelDetails' 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 alertpanel_ValidateCreateDataOutput: description: "" schema: properties: alertpanel: $ref: '#/definitions/PanelDetails' type: object alertpanel_ValidateUpdateDataOutput: description: "" schema: properties: alertpanel: $ref: '#/definitions/PanelDetails' type: object alertrecord_CustomizeDeleteOutput: description: "" schema: properties: alertrecord: $ref: '#/definitions/AlertRecordDetails' type: object alertrecord_FetchCustomizeColumnsOutput: description: "" schema: properties: alertrecord: $ref: '#/definitions/AlertRecordDetails' type: object alertrecord_GetDetailsMetadataOutput: description: "" schema: properties: alertrecord: additionalProperties: type: string type: object x-go-name: Output type: object alertrecord_GetPropertyHistoryAlertOutput: description: "" schema: properties: alertrecord: $ref: '#/definitions/AlertRecordHistoryAlert' type: object alertrecord_GetPropertyProjectAlertResourceCountOutput: description: "" schema: properties: alertrecord: $ref: '#/definitions/ProjectAlertResourceCount' type: object alertrecord_GetPropertyTotalAlertOutput: description: "" alertrecord_ListItemFilterOutput: description: "" schema: properties: alertrecords: items: $ref: '#/definitions/AlertRecordDetails' 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 alertrecord_ValidateCreateDataOutput: description: "" schema: properties: alertrecord: $ref: '#/definitions/AlertRecordDetails' type: object alertrecord_ValidateUpdateDataOutput: description: "" schema: properties: alertrecord: $ref: '#/definitions/AlertRecordDetails' type: object alertrecordshield_CustomizeDeleteOutput: description: "" schema: properties: alertrecordshield: $ref: '#/definitions/AlertRecordShieldDetails' type: object alertrecordshield_FetchCustomizeColumnsOutput: description: "" schema: properties: alertrecordshield: $ref: '#/definitions/AlertRecordShieldDetails' type: object alertrecordshield_GetDetailsMetadataOutput: description: "" schema: properties: alertrecordshield: additionalProperties: type: string type: object x-go-name: Output type: object alertrecordshield_GetDetailsStatusOutput: description: "" schema: properties: alertrecordshield: $ref: '#/definitions/GetDetailsStatusOutput' type: object alertrecordshield_ListItemFilterOutput: description: "" schema: properties: alertrecordshields: items: $ref: '#/definitions/AlertRecordShieldDetails' 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 alertrecordshield_ValidateCreateDataOutput: description: "" schema: properties: alertrecordshield: $ref: '#/definitions/AlertRecordShieldDetails' type: object alertrecordshield_ValidateUpdateDataOutput: description: "" schema: properties: alertrecordshield: $ref: '#/definitions/AlertRecordShieldDetails' type: object alertresource_CustomizeDeleteOutput: description: "" schema: properties: alertresource: $ref: '#/definitions/AlertResourceDetails' type: object alertresource_FetchCustomizeColumnsOutput: description: "" schema: properties: alertresource: $ref: '#/definitions/AlertResourceDetails' type: object alertresource_GetDetailsMetadataOutput: description: "" schema: properties: alertresource: additionalProperties: type: string type: object x-go-name: Output type: object alertresource_ListItemFilterOutput: description: "" schema: properties: alertresources: items: $ref: '#/definitions/AlertResourceDetails' 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 alertresource_ValidateCreateDataOutput: description: "" schema: properties: alertresource: $ref: '#/definitions/AlertResourceDetails' type: object alertresource_ValidateUpdateDataOutput: description: "" schema: properties: alertresource: $ref: '#/definitions/AlertResourceDetails' type: object commonalert_CustomizeDeleteOutput: description: "" schema: properties: commonalert: $ref: '#/definitions/CommonAlertDetails' type: object commonalert_FetchCustomizeColumnsOutput: description: "" schema: properties: commonalert: $ref: '#/definitions/CommonAlertDetails' type: object commonalert_GetDetailsMetadataOutput: description: "" schema: properties: commonalert: additionalProperties: type: string type: object x-go-name: Output type: object commonalert_GetDetailsStatusOutput: description: "" schema: properties: commonalert: $ref: '#/definitions/GetDetailsStatusOutput' type: object commonalert_ListItemFilterOutput: description: "" schema: properties: commonalerts: items: $ref: '#/definitions/CommonAlertDetails' 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 commonalert_PerformConfigOutput: description: "" commonalert_PerformDisableOutput: description: "" commonalert_PerformEnableOutput: description: "" commonalert_PerformPauseOutput: description: "" commonalert_PerformSetScopeOutput: description: "" commonalert_PerformTestRunOutput: description: "" schema: properties: commonalert: $ref: '#/definitions/AlertTestRunOutput' type: object commonalert_ValidateCreateDataOutput: description: "" schema: properties: commonalert: $ref: '#/definitions/CommonAlertDetails' type: object commonalert_ValidateUpdateDataOutput: description: "" schema: properties: commonalert: $ref: '#/definitions/CommonAlertDetails' type: object datasource_CustomizeDeleteOutput: description: "" schema: properties: datasource: $ref: '#/definitions/StandaloneResourceDetails' type: object datasource_FetchCustomizeColumnsOutput: description: "" schema: properties: datasource: $ref: '#/definitions/StandaloneResourceDetails' type: object datasource_GetDetailsMetadataOutput: description: "" schema: properties: datasource: additionalProperties: type: string type: object x-go-name: Output type: object datasource_ListItemFilterOutput: description: "" schema: properties: datasources: items: $ref: '#/definitions/StandaloneResourceDetails' 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 datasource_ValidateCreateDataOutput: description: "" schema: properties: datasource: $ref: '#/definitions/StandaloneResourceDetails' type: object datasource_ValidateUpdateDataOutput: description: "" schema: properties: datasource: $ref: '#/definitions/StandaloneResourceDetails' type: object metric_CustomizeDeleteOutput: description: "" schema: properties: metric: $ref: '#/definitions/JointResourceBaseDetails' type: object metric_FetchCustomizeColumnsOutput: description: "" schema: properties: metric: $ref: '#/definitions/JointResourceBaseDetails' type: object metric_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit metrics: items: $ref: '#/definitions/JointResourceBaseDetails' 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 metric_ValidateCreateDataOutput: description: "" schema: properties: metric: $ref: '#/definitions/JointResourceBaseDetails' type: object metric_ValidateUpdateDataOutput: description: "" schema: properties: metric: $ref: '#/definitions/JointResourceBaseDetails' type: object metricfield_CustomizeDeleteOutput: description: "" schema: properties: metricfield: $ref: '#/definitions/MetricFieldDetail' type: object metricfield_FetchCustomizeColumnsOutput: description: "" schema: properties: metricfield: $ref: '#/definitions/MetricFieldDetail' type: object metricfield_GetDetailsMetadataOutput: description: "" schema: properties: metricfield: additionalProperties: type: string type: object x-go-name: Output type: object metricfield_GetDetailsStatusOutput: description: "" schema: properties: metricfield: $ref: '#/definitions/GetDetailsStatusOutput' type: object metricfield_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit metricfields: items: $ref: '#/definitions/MetricFieldDetail' 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 metricfield_ValidateCreateDataOutput: description: "" schema: properties: metricfield: $ref: '#/definitions/MetricFieldDetail' type: object metricfield_ValidateUpdateDataOutput: description: "" schema: properties: metricfield: $ref: '#/definitions/MetricFieldDetail' type: object metricmeasurement_CustomizeDeleteOutput: description: "" schema: properties: metricmeasurement: $ref: '#/definitions/MetricDetails' type: object metricmeasurement_FetchCustomizeColumnsOutput: description: "" schema: properties: metricmeasurement: $ref: '#/definitions/MetricDetails' type: object metricmeasurement_GetDetailsMetadataOutput: description: "" schema: properties: metricmeasurement: additionalProperties: type: string type: object x-go-name: Output type: object metricmeasurement_GetDetailsStatusOutput: description: "" schema: properties: metricmeasurement: $ref: '#/definitions/GetDetailsStatusOutput' type: object metricmeasurement_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit metricmeasurements: items: $ref: '#/definitions/MetricDetails' 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 metricmeasurement_ValidateCreateDataOutput: description: "" schema: properties: metricmeasurement: $ref: '#/definitions/MetricDetails' type: object metricmeasurement_ValidateUpdateDataOutput: description: "" schema: properties: metricmeasurement: $ref: '#/definitions/MetricDetails' type: object migrationalert_CustomizeDeleteOutput: description: "" schema: properties: migrationalert: $ref: '#/definitions/AlertDetails' type: object migrationalert_FetchCustomizeColumnsOutput: description: "" schema: properties: migrationalert: $ref: '#/definitions/AlertDetails' type: object migrationalert_GetDetailsMetadataOutput: description: "" schema: properties: migrationalert: additionalProperties: type: string type: object x-go-name: Output type: object migrationalert_GetDetailsStatusOutput: description: "" schema: properties: migrationalert: $ref: '#/definitions/GetDetailsStatusOutput' type: object migrationalert_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit migrationalerts: items: $ref: '#/definitions/AlertDetails' 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 migrationalert_PerformDisableOutput: description: "" migrationalert_PerformEnableOutput: description: "" migrationalert_PerformPauseOutput: description: "" migrationalert_PerformTestRunOutput: description: "" schema: properties: migrationalert: $ref: '#/definitions/AlertTestRunOutput' type: object migrationalert_ValidateCreateDataOutput: description: "" schema: properties: migrationalert: $ref: '#/definitions/AlertDetails' type: object migrationalert_ValidateUpdateDataOutput: description: "" schema: properties: migrationalert: $ref: '#/definitions/AlertDetails' type: object models_PerformQueryOutput: description: "" schema: properties: unifiedmonitor: $ref: '#/definitions/MetricsQueryResult' type: object monitorresource_CustomizeDeleteOutput: description: "" schema: properties: monitorresource: $ref: '#/definitions/MonitorResourceDetails' type: object monitorresource_FetchCustomizeColumnsOutput: description: "" schema: properties: monitorresource: $ref: '#/definitions/MonitorResourceDetails' type: object monitorresource_GetDetailsMetadataOutput: description: "" schema: properties: monitorresource: additionalProperties: type: string type: object x-go-name: Output type: object monitorresource_GetDetailsStatusOutput: description: "" schema: properties: monitorresource: $ref: '#/definitions/GetDetailsStatusOutput' type: object monitorresource_GetPropertyAlertOutput: description: "" monitorresource_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit monitorresources: items: $ref: '#/definitions/MonitorResourceDetails' 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 monitorresource_PerformChangeOwnerOutput: description: "" monitorresource_PerformDoActionOutput: description: "" monitorresource_ValidateCreateDataOutput: description: "" schema: properties: monitorresource: $ref: '#/definitions/MonitorResourceDetails' type: object monitorresource_ValidateUpdateDataOutput: description: "" schema: properties: monitorresource: $ref: '#/definitions/MonitorResourceDetails' type: object monitorresourcealert_CustomizeDeleteOutput: description: "" schema: properties: monitorresourcealert: $ref: '#/definitions/MonitorResourceJointDetails' type: object monitorresourcealert_FetchCustomizeColumnsOutput: description: "" schema: properties: monitorresourcealert: $ref: '#/definitions/MonitorResourceJointDetails' type: object monitorresourcealert_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit monitorresourcealerts: items: $ref: '#/definitions/MonitorResourceJointDetails' 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 monitorresourcealert_ValidateCreateDataOutput: description: "" schema: properties: monitorresourcealert: $ref: '#/definitions/MonitorResourceJointDetails' type: object monitorresourcealert_ValidateUpdateDataOutput: description: "" schema: properties: monitorresourcealert: $ref: '#/definitions/MonitorResourceJointDetails' type: object nodealert_CustomizeDeleteOutput: description: "" schema: properties: nodealert: $ref: '#/definitions/NodeAlertDetails' type: object nodealert_FetchCustomizeColumnsOutput: description: "" schema: properties: nodealert: $ref: '#/definitions/NodeAlertDetails' type: object nodealert_GetDetailsMetadataOutput: description: "" schema: properties: nodealert: additionalProperties: type: string type: object x-go-name: Output type: object nodealert_GetDetailsStatusOutput: description: "" schema: properties: nodealert: $ref: '#/definitions/GetDetailsStatusOutput' type: object nodealert_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit nodealerts: items: $ref: '#/definitions/NodeAlertDetails' 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 nodealert_PerformConfigOutput: description: "" nodealert_PerformDisableOutput: description: "" nodealert_PerformEnableOutput: description: "" nodealert_PerformPauseOutput: description: "" nodealert_PerformSetScopeOutput: description: "" nodealert_PerformTestRunOutput: description: "" schema: properties: nodealert: $ref: '#/definitions/AlertTestRunOutput' type: object nodealert_ValidateCreateDataOutput: description: "" schema: properties: nodealert: $ref: '#/definitions/NodeAlertDetails' type: object nodealert_ValidateUpdateDataOutput: description: "" schema: properties: nodealert: $ref: '#/definitions/NodeAlertDetails' type: object schemes: - https - http securityDefinitions: keystone: in: header name: X-Auth-Token type: apiKey swagger: "2.0"