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' 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 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 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 res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: type: object x-go-name: Settings 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 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 res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: type: object x-go-name: Settings 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_tags: $ref: '#/definitions/TTagSetList' 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: type: object 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 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 refresh: type: string x-go-name: Refresh res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: type: object x-go-name: Settings 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 AlertPauseInput: properties: paused: type: boolean x-go-name: Paused type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertQuery: properties: data_source_id: type: string x-go-name: DataSourceId from: type: string x-go-name: From model: $ref: '#/definitions/MetricQuery' 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 AlertRule: $ref: '#/definitions/AlertRecordRule' 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 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: TriggerTime: format: date-time type: string 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 name: description: 资源名称 type: string x-go-name: Name 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 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 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 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 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 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 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 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 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: type: object x-go-name: Settings 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 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 settings: $ref: '#/definitions/AlertSetting' type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor AlertV1Details: 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 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 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 recipients: type: string x-go-name: Recipients res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: type: object x-go-name: Settings 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 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 ChangeOwnerCandidateDomainsOutput: properties: candidates: items: $ref: '#/definitions/SharedDomain' type: array x-go-name: Candidates type: object x-go-package: yunion.io/x/onecloud/pkg/apis 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 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 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 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 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 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: type: object x-go-name: Settings 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 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 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_str: type: string x-go-name: ThresholdStr within_range: items: format: double type: number type: array x-go-name: WithinRange type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor CommonAlertQuery: properties: comparator: description: '比较运算符, 比如: >, <, >=, <=' type: string x-go-name: Comparator condition_type: type: string x-go-name: ConditionType data_source_id: type: string x-go-name: DataSourceId field_opt: description: field yunsuan type: string x-go-name: FieldOpt from: type: string x-go-name: From model: $ref: '#/definitions/MetricQuery' reduce: description: metric points'value的运算方式 type: string x-go-name: Reduce threshold: description: 报警阀值 format: double type: number x-go-name: Threshold 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: condition: type: string x-go-name: Condition 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 MeterAlertCreateInput: properties: account_id: description: 云账号 Id type: string x-go-name: AccountId channel: description: '通知方式, 比如: email, mobile' type: string x-go-name: Channel 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 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: description: 项目 Id string type: string x-go-name: ProjectId provider: description: 云平台类型 type: string x-go-name: Provider recipients: description: 通知接受者 type: string x-go-name: Recipients settings: $ref: '#/definitions/AlertSetting' threshold: description: 报警阀值 format: double type: number x-go-name: Threshold type: description: '监控资源类型, 比如: balance, resFree, monthFee' 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 MeterAlertDetails: properties: account_id: type: string x-go-name: AccountId 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 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 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: ProjectId provider: type: string x-go-name: Provider recipients: type: string x-go-name: Recipients res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: type: object x-go-name: Settings 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 MeterAlertUpdateInput: 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 name: description: 资源名称 type: string x-go-name: Name no_data_state: description: 没有收到监控指标时将当前报警状态设置为对应的状态 type: string x-go-name: NoDataState project_id: description: 项目 Id type: string x-go-name: ProjectId recipients: description: 通知接受者 type: string x-go-name: Recipients settings: $ref: '#/definitions/AlertSetting' status: type: string x-go-name: Status threshold: description: 报警阀值 format: double type: number x-go-name: Threshold type: object x-go-package: yunion.io/x/onecloud/pkg/apis/monitor 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 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_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 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: Id: type: string description: description: 资源描述 type: string x-go-name: Description display_name: type: string x-go-name: DisplayName 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_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 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 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 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 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 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 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 MonitorResourceJointDetails: properties: 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 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 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 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 recipients: type: string x-go-name: Recipients res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: type: object x-go-name: Settings 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 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 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 res_type: type: string x-go-name: ResType scope: type: string x-go-name: Scope settings: type: object x-go-name: Settings 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 PerformFreezeInput: type: object x-go-package: yunion.io/x/onecloud/pkg/apis PerformStatusInput: properties: host_id: description: call from host id type: string x-go-name: HostId power_states: description: 电源状态 type: string x-go-name: PowerStates reason: description: 更改状态的原因描述 type: string x-go-name: Reason status: description: 更改的目标状态值 type: string x-go-name: Status required: - status type: object x-go-package: yunion.io/x/onecloud/pkg/apis PerformUnfreezeInput: type: object x-go-package: yunion.io/x/onecloud/pkg/apis ProjectStatistic: properties: Count: format: int64 type: integer Id: type: string Name: type: string type: object x-go-package: yunion.io/x/onecloud/pkg/apis PurgeSplitTableInput: properties: tables: items: type: string type: array x-go-name: Tables type: object x-go-package: yunion.io/x/onecloud/pkg/apis ResultLogEntry: properties: data: type: object 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 STag: properties: key: description: 标签Kye type: string x-go-name: Key value: description: 标签Value type: string x-go-name: Value type: object x-go-package: yunion.io/x/onecloud/pkg/util/tagutils SharedDomain: properties: id: type: string x-go-name: Id name: type: string x-go-name: Name type: object x-go-package: yunion.io/x/onecloud/pkg/apis 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 StatusStatistic: properties: TotalCpuCount: description: CPU总量 format: int64 type: integer TotalDiskSizeMb: description: 存储总量 format: int64 type: integer TotalMemSizeMb: description: 内存总量 format: int64 type: integer status_info: items: $ref: '#/definitions/StatusStatisticStatusInfo' type: array x-go-name: StatusInfo type: object x-go-package: yunion.io/x/onecloud/pkg/apis StatusStatisticStatusInfo: properties: Status: type: string pending_deleted_count: description: |- 回收站数量 需要指定pending_delete=all format: int64 type: integer x-go-name: PendingDeletedCount total_count: description: 资源总数 format: int64 type: integer x-go-name: TotalCount type: object x-go-package: yunion.io/x/onecloud/pkg/apis 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 V1AlertUpdateInput: 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 settings: $ref: '#/definitions/AlertSetting' type: object 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 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: Monitor API license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html version: "1.0" paths: /alert_dash_boards: get: description: 列表 operationId: alert_dash_board_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 - $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 - $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 responses: "200": $ref: '#/responses/alert_dash_board_ListItemFilterOutput' summary: 列表 tags: - alert_dash_board post: description: 新建 operationId: alert_dash_board_ValidateCreateData parameters: - in: body name: body schema: properties: alert_dash_board: $ref: '#/definitions/AlertDashBoardCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dash_board_ValidateCreateDataOutput' summary: 新建 tags: - alert_dash_board /alert_dash_boards/{id}: delete: description: 删除 operationId: alert_dash_board_CustomizeDelete parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_dash_board_CustomizeDeleteOutput' summary: 删除 tags: - alert_dash_board get: description: 获取详情 operationId: alert_dash_board_FetchCustomizeColumns parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_dash_board_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alert_dash_board put: description: 更新 operationId: alert_dash_board_ValidateUpdateData parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_dash_board_ValidateUpdateDataOutput' summary: 更新 tags: - alert_dash_board /alert_dash_boards/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: alert_dash_board_GetDetailsClassMetadata parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_dash_board_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - alert_dash_board post: description: 执行操作ClassMetadata operationId: alert_dash_board_PerformClassMetadata parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_dash_board: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dash_board_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - alert_dash_board /alert_dash_boards/{id}/clone-dashboard: post: description: 执行操作CloneDashboard operationId: alert_dash_board_PerformCloneDashboard parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_dash_board: $ref: '#/definitions/AlertCloneDashboardInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dash_board_PerformCloneDashboardOutput' summary: 执行操作CloneDashboard tags: - alert_dash_board /alert_dash_boards/{id}/clone-panel: post: description: 执行操作ClonePanel operationId: alert_dash_board_PerformClonePanel parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_dash_board: $ref: '#/definitions/AlertClonePanelInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dash_board_PerformClonePanelOutput' summary: 执行操作ClonePanel tags: - alert_dash_board /alert_dash_boards/{id}/metadata: get: description: 获取指定信息Metadata operationId: alert_dash_board_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_dash_board in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_dash_board_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alert_dash_board /alert_dash_boards/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: alert_dash_board_PerformSetClassMetadata parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_dash_board: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dash_board_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - alert_dash_board /alert_dash_boards/{id}/set-scope: post: description: 执行操作SetScope operationId: alert_dash_board_PerformSetScope parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_dash_board_PerformSetScopeOutput' summary: 执行操作SetScope tags: - alert_dash_board /alert_dash_boards/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: alert_dash_board_PerformSetUserMetadata parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_dash_board: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dash_board_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - alert_dash_board /alert_dash_boards/{id}/status: get: description: 获取指定信息Status operationId: alert_dash_board_GetDetailsStatus parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_dash_board_GetDetailsStatusOutput' summary: 获取资源状态 tags: - alert_dash_board post: description: 执行操作Status operationId: alert_dash_board_PerformStatus parameters: - description: The Id or Name of alert_dash_board in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_dash_board: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dash_board_PerformStatusOutput' summary: 更新资源状态 tags: - alert_dash_board /alert_dash_boards/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: alert_dash_board_GetPropertyDistinctField responses: "200": $ref: '#/responses/alert_dash_board_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - alert_dash_board /alert_dash_boards/purge-splitable: post: description: 执行操作PurgeSplitable operationId: alert_dash_board_PerformPurgeSplitable parameters: - in: body name: body schema: properties: alert_dash_board: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dash_board_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - alert_dash_board /alert_dash_boards/splitable: get: description: 获取指定资源类的信息Splitable operationId: alert_dash_board_GetPropertySplitable responses: "200": $ref: '#/responses/alert_dash_board_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - alert_dash_board /alert_dash_boards/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: alert_dash_board_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/alert_dash_board_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - alert_dash_board /alert_dash_boards/statistics: get: description: 获取指定资源类的信息Statistics operationId: alert_dash_board_GetPropertyStatistics responses: "200": $ref: '#/responses/alert_dash_board_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - alert_dash_board /alert_dash_boards/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: alert_dash_board_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/alert_dash_board_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - alert_dash_board /alert_dash_boards/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: alert_dash_board_GetPropertyTagValueTree responses: "200": $ref: '#/responses/alert_dash_board_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - alert_dash_board /alert_dashboard_panels: get: description: 列表 operationId: alert_dashboard_panel_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason responses: "200": $ref: '#/responses/alert_dashboard_panel_ListItemFilterOutput' summary: 列表 tags: - alert_dashboard_panel post: description: 新建 operationId: alert_dashboard_panel_ValidateCreateData parameters: - in: body name: body schema: properties: alert_dashboard_panel: $ref: '#/definitions/JoinResourceBaseCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dashboard_panel_ValidateCreateDataOutput' summary: 新建 tags: - alert_dashboard_panel /alert_dashboard_panels/{id}: delete: description: 删除 operationId: alert_dashboard_panel_CustomizeDelete parameters: - description: The Id or Name of alert_dashboard_panel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_dashboard_panel_CustomizeDeleteOutput' summary: 删除 tags: - alert_dashboard_panel get: description: 获取详情 operationId: alert_dashboard_panel_FetchCustomizeColumns parameters: - description: The Id or Name of alert_dashboard_panel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_dashboard_panel_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alert_dashboard_panel put: description: 更新 operationId: alert_dashboard_panel_ValidateUpdateData parameters: - description: The Id or Name of alert_dashboard_panel in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_dashboard_panel: $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dashboard_panel_ValidateUpdateDataOutput' summary: 更新 tags: - alert_dashboard_panel /alert_dashboard_panels/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: alert_dashboard_panel_GetPropertyDistinctField responses: "200": $ref: '#/responses/alert_dashboard_panel_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - alert_dashboard_panel /alert_dashboard_panels/purge-splitable: post: description: 执行操作PurgeSplitable operationId: alert_dashboard_panel_PerformPurgeSplitable parameters: - in: body name: body schema: properties: alert_dashboard_panel: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_dashboard_panel_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - alert_dashboard_panel /alert_dashboard_panels/splitable: get: description: 获取指定资源类的信息Splitable operationId: alert_dashboard_panel_GetPropertySplitable responses: "200": $ref: '#/responses/alert_dashboard_panel_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - alert_dashboard_panel /alert_dashboard_panels/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: alert_dashboard_panel_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/alert_dashboard_panel_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - alert_dashboard_panel /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 - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 in: query items: type: string name: status type: array x-go-name: Status - description: 指定查询的权限范围，可能值为project, domain or system in: query name: scope type: string x-go-name: Scope - description: 指定项目归属域名称或ID in: query name: project_domain_id type: string x-go-name: ProjectDomainId - description: 对具有域属性的资源，严格匹配域ID in: query items: type: string name: project_domain_ids type: array x-go-name: ProjectDomainIds - description: 按domain名称排序，可能值为asc|desc in: query name: order_by_domain pattern: asc|desc type: string x-go-name: OrderByDomain - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: domain_tags x-go-name: DomainTags - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: no_domain_tags x-go-name: NoDomainTags - description: 指定项目的名称或ID in: query name: project_id type: string x-go-name: ProjectId - description: 对具有项目属性的资源，严格匹配项目ID in: query items: type: string name: project_ids type: array x-go-name: ProjectIds - description: 按project名称排序，可能值为asc|desc in: query name: order_by_project pattern: asc|desc type: string x-go-name: OrderByProject - $ref: '#/definitions/TTagSetList' description: filter by project tags in: query name: project_tags x-go-name: ProjectTags - $ref: '#/definitions/TTagSetList' description: filter by no project tags in: query name: no_project_tags x-go-name: NoProjectTags - $ref: '#/definitions/TTagSetList' description: |- ignore project tag fitlers imposed by policy in: query name: policy_project_tags x-go-name: PolicyProjectTags - description: 列表中包含标记为"系统资源"的资源 in: query name: system type: boolean x-go-name: System - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） in: query name: pending_delete type: boolean x-go-name: PendingDelete - description: 类型 in: query name: 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}/cancel-delete: post: description: 执行操作CancelDelete operationId: alert_notification_PerformCancelDelete 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_PerformCancelDeleteOutput' summary: 执行操作CancelDelete 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: 执行操作ChangeOwner tags: - alert_notification /alert_notifications/{id}/change-owner-candidate-domains: get: description: 获取指定信息ChangeOwnerCandidateDomains operationId: alert_notification_GetDetailsChangeOwnerCandidateDomains 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_GetDetailsChangeOwnerCandidateDomainsOutput' summary: 获取指定信息ChangeOwnerCandidateDomains tags: - alert_notification /alert_notifications/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: alert_notification_GetDetailsClassMetadata 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_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - alert_notification post: description: 执行操作ClassMetadata operationId: alert_notification_PerformClassMetadata 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: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_notification_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - alert_notification /alert_notifications/{id}/freeze: post: description: 执行操作Freeze operationId: alert_notification_PerformFreeze 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/PerformFreezeInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_notification_PerformFreezeOutput' summary: freezed update and perform action operation except for unfreeze 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}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: alert_notification_PerformSetClassMetadata 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: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_notification_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - alert_notification /alert_notifications/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: alert_notification_PerformSetUserMetadata 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: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_notification_PerformSetUserMetadataOutput' 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 post: description: 执行操作Status operationId: alert_notification_PerformStatus 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/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_notification_PerformStatusOutput' summary: 更新资源状态 tags: - alert_notification /alert_notifications/{id}/unfreeze: post: description: 执行操作Unfreeze operationId: alert_notification_PerformUnfreeze 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/PerformUnfreezeInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_notification_PerformUnfreezeOutput' summary: 执行操作Unfreeze tags: - alert_notification /alert_notifications/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: alert_notification_GetPropertyDistinctField responses: "200": $ref: '#/responses/alert_notification_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - alert_notification /alert_notifications/domain-statistics: get: description: 获取指定资源类的信息DomainStatistics operationId: alert_notification_GetPropertyDomainStatistics responses: "200": $ref: '#/responses/alert_notification_GetPropertyDomainStatisticsOutput' summary: 获取指定资源类的信息DomainStatistics tags: - alert_notification /alert_notifications/project-statistics: get: description: 获取指定资源类的信息ProjectStatistics operationId: alert_notification_GetPropertyProjectStatistics responses: "200": $ref: '#/responses/alert_notification_GetPropertyProjectStatisticsOutput' summary: 获取指定资源类的信息ProjectStatistics tags: - alert_notification /alert_notifications/project-tag-value-pairs: get: description: 获取指定资源类的信息ProjectTagValuePairs operationId: alert_notification_GetPropertyProjectTagValuePairs responses: "200": $ref: '#/responses/alert_notification_GetPropertyProjectTagValuePairsOutput' summary: 获取指定资源类的信息ProjectTagValuePairs tags: - alert_notification /alert_notifications/project-tag-value-tree: get: description: 获取指定资源类的信息ProjectTagValueTree operationId: alert_notification_GetPropertyProjectTagValueTree responses: "200": $ref: '#/responses/alert_notification_GetPropertyProjectTagValueTreeOutput' summary: 获取指定资源类的信息ProjectTagValueTree tags: - alert_notification /alert_notifications/purge-splitable: post: description: 执行操作PurgeSplitable operationId: alert_notification_PerformPurgeSplitable parameters: - in: body name: body schema: properties: alert_notification: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_notification_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - alert_notification /alert_notifications/splitable: get: description: 获取指定资源类的信息Splitable operationId: alert_notification_GetPropertySplitable responses: "200": $ref: '#/responses/alert_notification_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - alert_notification /alert_notifications/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: alert_notification_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/alert_notification_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - alert_notification /alert_notifications/statistics: get: description: 获取指定资源类的信息Statistics operationId: alert_notification_GetPropertyStatistics responses: "200": $ref: '#/responses/alert_notification_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - alert_notification /alert_notifications/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: alert_notification_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/alert_notification_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - alert_notification /alert_notifications/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: alert_notification_GetPropertyTagValueTree responses: "200": $ref: '#/responses/alert_notification_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - alert_notification /alert_panels: get: description: 列表 operationId: alert_panel_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 - $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 - $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: dashboard_id type: string x-go-name: DashboardId responses: "200": $ref: '#/responses/alert_panel_ListItemFilterOutput' summary: 列表 tags: - alert_panel post: description: 新建 operationId: alert_panel_ValidateCreateData parameters: - in: body name: body schema: properties: alert_panel: $ref: '#/definitions/AlertPanelCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_panel_ValidateCreateDataOutput' summary: 新建 tags: - alert_panel /alert_panels/{id}: delete: description: 删除 operationId: alert_panel_CustomizeDelete parameters: - description: The Id or Name of alert_panel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_panel_CustomizeDeleteOutput' summary: 删除 tags: - alert_panel get: description: 获取详情 operationId: alert_panel_FetchCustomizeColumns parameters: - description: The Id or Name of alert_panel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_panel_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alert_panel put: description: 更新 operationId: alert_panel_ValidateUpdateData parameters: - description: The Id or Name of alert_panel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_panel_ValidateUpdateDataOutput' summary: 更新 tags: - alert_panel /alert_panels/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: alert_panel_GetDetailsClassMetadata parameters: - description: The Id or Name of alert_panel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_panel_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - alert_panel post: description: 执行操作ClassMetadata operationId: alert_panel_PerformClassMetadata parameters: - description: The Id or Name of alert_panel in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_panel: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_panel_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - alert_panel /alert_panels/{id}/metadata: get: description: 获取指定信息Metadata operationId: alert_panel_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_panel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_panel_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alert_panel /alert_panels/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: alert_panel_PerformSetClassMetadata parameters: - description: The Id or Name of alert_panel in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_panel: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_panel_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - alert_panel /alert_panels/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: alert_panel_PerformSetUserMetadata parameters: - description: The Id or Name of alert_panel in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_panel: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_panel_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - alert_panel /alert_panels/{id}/status: get: description: 获取指定信息Status operationId: alert_panel_GetDetailsStatus parameters: - description: The Id or Name of alert_panel in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_panel_GetDetailsStatusOutput' summary: 获取资源状态 tags: - alert_panel post: description: 执行操作Status operationId: alert_panel_PerformStatus parameters: - description: The Id or Name of alert_panel in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_panel: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_panel_PerformStatusOutput' summary: 更新资源状态 tags: - alert_panel /alert_panels/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: alert_panel_GetPropertyDistinctField responses: "200": $ref: '#/responses/alert_panel_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - alert_panel /alert_panels/purge-splitable: post: description: 执行操作PurgeSplitable operationId: alert_panel_PerformPurgeSplitable parameters: - in: body name: body schema: properties: alert_panel: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_panel_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - alert_panel /alert_panels/splitable: get: description: 获取指定资源类的信息Splitable operationId: alert_panel_GetPropertySplitable responses: "200": $ref: '#/responses/alert_panel_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - alert_panel /alert_panels/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: alert_panel_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/alert_panel_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - alert_panel /alert_panels/statistics: get: description: 获取指定资源类的信息Statistics operationId: alert_panel_GetPropertyStatistics responses: "200": $ref: '#/responses/alert_panel_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - alert_panel /alert_panels/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: alert_panel_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/alert_panel_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - alert_panel /alert_panels/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: alert_panel_GetPropertyTagValueTree responses: "200": $ref: '#/responses/alert_panel_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - alert_panel /alert_record_shields: get: description: 列表 operationId: alert_record_shield_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 - $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 - $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/alert_record_shield_ListItemFilterOutput' summary: 列表 tags: - alert_record_shield post: description: 新建 operationId: alert_record_shield_ValidateCreateData parameters: - in: body name: body schema: properties: alert_record_shield: $ref: '#/definitions/AlertRecordShieldCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_shield_ValidateCreateDataOutput' summary: 新建 tags: - alert_record_shield /alert_record_shields/{id}: delete: description: 删除 operationId: alert_record_shield_CustomizeDelete parameters: - description: The Id or Name of alert_record_shield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_record_shield_CustomizeDeleteOutput' summary: 删除 tags: - alert_record_shield get: description: 获取详情 operationId: alert_record_shield_FetchCustomizeColumns parameters: - description: The Id or Name of alert_record_shield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_record_shield_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alert_record_shield put: description: 更新 operationId: alert_record_shield_ValidateUpdateData parameters: - description: The Id or Name of alert_record_shield in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_record_shield: $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_shield_ValidateUpdateDataOutput' summary: 更新 tags: - alert_record_shield /alert_record_shields/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: alert_record_shield_GetDetailsClassMetadata parameters: - description: The Id or Name of alert_record_shield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_record_shield_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - alert_record_shield post: description: 执行操作ClassMetadata operationId: alert_record_shield_PerformClassMetadata parameters: - description: The Id or Name of alert_record_shield in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_record_shield: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_shield_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - alert_record_shield /alert_record_shields/{id}/metadata: get: description: 获取指定信息Metadata operationId: alert_record_shield_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_record_shield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_record_shield_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alert_record_shield /alert_record_shields/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: alert_record_shield_PerformSetClassMetadata parameters: - description: The Id or Name of alert_record_shield in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_record_shield: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_shield_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - alert_record_shield /alert_record_shields/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: alert_record_shield_PerformSetUserMetadata parameters: - description: The Id or Name of alert_record_shield in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_record_shield: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_shield_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - alert_record_shield /alert_record_shields/{id}/status: get: description: 获取指定信息Status operationId: alert_record_shield_GetDetailsStatus parameters: - description: The Id or Name of alert_record_shield in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_record_shield_GetDetailsStatusOutput' summary: 获取资源状态 tags: - alert_record_shield post: description: 执行操作Status operationId: alert_record_shield_PerformStatus parameters: - description: The Id or Name of alert_record_shield in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_record_shield: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_shield_PerformStatusOutput' summary: 更新资源状态 tags: - alert_record_shield /alert_record_shields/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: alert_record_shield_GetPropertyDistinctField responses: "200": $ref: '#/responses/alert_record_shield_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - alert_record_shield /alert_record_shields/purge-splitable: post: description: 执行操作PurgeSplitable operationId: alert_record_shield_PerformPurgeSplitable parameters: - in: body name: body schema: properties: alert_record_shield: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_shield_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - alert_record_shield /alert_record_shields/splitable: get: description: 获取指定资源类的信息Splitable operationId: alert_record_shield_GetPropertySplitable responses: "200": $ref: '#/responses/alert_record_shield_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - alert_record_shield /alert_record_shields/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: alert_record_shield_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/alert_record_shield_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - alert_record_shield /alert_record_shields/statistics: get: description: 获取指定资源类的信息Statistics operationId: alert_record_shield_GetPropertyStatistics responses: "200": $ref: '#/responses/alert_record_shield_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - alert_record_shield /alert_record_shields/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: alert_record_shield_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/alert_record_shield_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - alert_record_shield /alert_record_shields/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: alert_record_shield_GetPropertyTagValueTree responses: "200": $ref: '#/responses/alert_record_shield_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - alert_record_shield /alert_records: get: description: 列表 operationId: alert_record_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 - $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 - $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: 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 responses: "200": $ref: '#/responses/alert_record_ListItemFilterOutput' summary: 列表 tags: - alert_record post: description: 新建 operationId: alert_record_ValidateCreateData parameters: - in: body name: body schema: properties: alert_record: $ref: '#/definitions/AlertRecordCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_ValidateCreateDataOutput' summary: 新建 tags: - alert_record /alert_records/{id}: delete: description: 删除 operationId: alert_record_CustomizeDelete parameters: - description: The Id or Name of alert_record in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_record_CustomizeDeleteOutput' summary: 删除 tags: - alert_record get: description: 获取详情 operationId: alert_record_FetchCustomizeColumns parameters: - description: The Id or Name of alert_record in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_record_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alert_record put: description: 更新 operationId: alert_record_ValidateUpdateData parameters: - description: The Id or Name of alert_record in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_record: $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_ValidateUpdateDataOutput' summary: 更新 tags: - alert_record /alert_records/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: alert_record_GetDetailsClassMetadata parameters: - description: The Id or Name of alert_record in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_record_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - alert_record post: description: 执行操作ClassMetadata operationId: alert_record_PerformClassMetadata parameters: - description: The Id or Name of alert_record in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_record: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - alert_record /alert_records/{id}/metadata: get: description: 获取指定信息Metadata operationId: alert_record_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_record in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_record_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alert_record /alert_records/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: alert_record_PerformSetClassMetadata parameters: - description: The Id or Name of alert_record in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_record: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - alert_record /alert_records/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: alert_record_PerformSetUserMetadata parameters: - description: The Id or Name of alert_record in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_record: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - alert_record /alert_records/{id}/status: get: description: 获取指定信息Status operationId: alert_record_GetDetailsStatus parameters: - description: The Id or Name of alert_record in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_record_GetDetailsStatusOutput' summary: 获取资源状态 tags: - alert_record post: description: 执行操作Status operationId: alert_record_PerformStatus parameters: - description: The Id or Name of alert_record in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_record: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_PerformStatusOutput' summary: 更新资源状态 tags: - alert_record /alert_records/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: alert_record_GetPropertyDistinctField responses: "200": $ref: '#/responses/alert_record_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - alert_record /alert_records/purge-splitable: post: description: 执行操作PurgeSplitable operationId: alert_record_PerformPurgeSplitable parameters: - in: body name: body schema: properties: alert_record: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_record_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - alert_record /alert_records/splitable: get: description: 获取指定资源类的信息Splitable operationId: alert_record_GetPropertySplitable responses: "200": $ref: '#/responses/alert_record_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - alert_record /alert_records/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: alert_record_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/alert_record_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - alert_record /alert_records/statistics: get: description: 获取指定资源类的信息Statistics operationId: alert_record_GetPropertyStatistics responses: "200": $ref: '#/responses/alert_record_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - alert_record /alert_records/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: alert_record_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/alert_record_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - alert_record /alert_records/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: alert_record_GetPropertyTagValueTree responses: "200": $ref: '#/responses/alert_record_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - alert_record /alert_records/total-alert: get: description: 获取指定资源类的信息TotalAlert operationId: alert_record_GetPropertyTotalAlert responses: "200": $ref: '#/responses/alert_record_GetPropertyTotalAlertOutput' summary: 获取指定资源类的信息TotalAlert tags: - alert_record /alert_resource_alerts: get: description: 列表 operationId: alert_resource_alert_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - in: query name: alert_resource_id type: string x-go-name: AlertResourceId - in: query name: alert_id type: string x-go-name: AlertId responses: "200": $ref: '#/responses/alert_resource_alert_ListItemFilterOutput' summary: 列表 tags: - alert_resource_alert post: description: 新建 operationId: alert_resource_alert_ValidateCreateData parameters: - in: body name: body schema: properties: alert_resource_alert: $ref: '#/definitions/JoinResourceBaseCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_resource_alert_ValidateCreateDataOutput' summary: 新建 tags: - alert_resource_alert /alert_resource_alerts/{id}: delete: description: 删除 operationId: alert_resource_alert_CustomizeDelete parameters: - description: The Id or Name of alert_resource_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_resource_alert_CustomizeDeleteOutput' summary: 删除 tags: - alert_resource_alert get: description: 获取详情 operationId: alert_resource_alert_FetchCustomizeColumns parameters: - description: The Id or Name of alert_resource_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_resource_alert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alert_resource_alert put: description: 更新 operationId: alert_resource_alert_ValidateUpdateData parameters: - description: The Id or Name of alert_resource_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_resource_alert: $ref: '#/definitions/JointResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_resource_alert_ValidateUpdateDataOutput' summary: 更新 tags: - alert_resource_alert /alert_resource_alerts/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: alert_resource_alert_GetPropertyDistinctField responses: "200": $ref: '#/responses/alert_resource_alert_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - alert_resource_alert /alert_resource_alerts/purge-splitable: post: description: 执行操作PurgeSplitable operationId: alert_resource_alert_PerformPurgeSplitable parameters: - in: body name: body schema: properties: alert_resource_alert: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_resource_alert_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - alert_resource_alert /alert_resource_alerts/splitable: get: description: 获取指定资源类的信息Splitable operationId: alert_resource_alert_GetPropertySplitable responses: "200": $ref: '#/responses/alert_resource_alert_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - alert_resource_alert /alert_resource_alerts/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: alert_resource_alert_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/alert_resource_alert_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - alert_resource_alert /alert_resources: get: description: 列表 operationId: alert_resource_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - $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/alert_resource_ListItemFilterOutput' summary: 列表 tags: - alert_resource post: description: 新建 operationId: alert_resource_ValidateCreateData parameters: - in: body name: body schema: properties: alert_resource: $ref: '#/definitions/StandaloneResourceCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_resource_ValidateCreateDataOutput' summary: 新建 tags: - alert_resource /alert_resources/{id}: delete: description: 删除 operationId: alert_resource_CustomizeDelete parameters: - description: The Id or Name of alert_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_resource_CustomizeDeleteOutput' summary: 删除 tags: - alert_resource get: description: 获取详情 operationId: alert_resource_FetchCustomizeColumns parameters: - description: The Id or Name of alert_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_resource_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - alert_resource put: description: 更新 operationId: alert_resource_ValidateUpdateData parameters: - description: The Id or Name of alert_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_resource: $ref: '#/definitions/StandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_resource_ValidateUpdateDataOutput' summary: 更新 tags: - alert_resource /alert_resources/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: alert_resource_GetDetailsClassMetadata parameters: - description: The Id or Name of alert_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_resource_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - alert_resource post: description: 执行操作ClassMetadata operationId: alert_resource_PerformClassMetadata parameters: - description: The Id or Name of alert_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_resource: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_resource_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - alert_resource /alert_resources/{id}/metadata: get: description: 获取指定信息Metadata operationId: alert_resource_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_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/alert_resource_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - alert_resource /alert_resources/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: alert_resource_PerformSetClassMetadata parameters: - description: The Id or Name of alert_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_resource: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_resource_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - alert_resource /alert_resources/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: alert_resource_PerformSetUserMetadata parameters: - description: The Id or Name of alert_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: alert_resource: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_resource_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - alert_resource /alert_resources/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: alert_resource_GetPropertyDistinctField responses: "200": $ref: '#/responses/alert_resource_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - alert_resource /alert_resources/purge-splitable: post: description: 执行操作PurgeSplitable operationId: alert_resource_PerformPurgeSplitable parameters: - in: body name: body schema: properties: alert_resource: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_resource_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - alert_resource /alert_resources/splitable: get: description: 获取指定资源类的信息Splitable operationId: alert_resource_GetPropertySplitable responses: "200": $ref: '#/responses/alert_resource_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - alert_resource /alert_resources/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: alert_resource_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/alert_resource_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - alert_resource /alert_resources/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: alert_resource_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/alert_resource_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - alert_resource /alert_resources/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: alert_resource_GetPropertyTagValueTree responses: "200": $ref: '#/responses/alert_resource_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - alert_resource /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 - $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 - $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 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}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: alert_GetDetailsClassMetadata 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_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - alert post: description: 执行操作ClassMetadata operationId: alert_PerformClassMetadata 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: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_PerformClassMetadataOutput' summary: 更新资源的 class 标签 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}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: alert_PerformSetClassMetadata 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: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - alert /alerts/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: alert_PerformSetUserMetadata 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: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 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 post: description: 执行操作Status operationId: alert_PerformStatus 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/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_PerformStatusOutput' 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 /alerts/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: alert_GetPropertyDistinctField responses: "200": $ref: '#/responses/alert_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - alert /alerts/purge-splitable: post: description: 执行操作PurgeSplitable operationId: alert_PerformPurgeSplitable parameters: - in: body name: body schema: properties: alert: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/alert_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - alert /alerts/splitable: get: description: 获取指定资源类的信息Splitable operationId: alert_GetPropertySplitable responses: "200": $ref: '#/responses/alert_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - alert /alerts/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: alert_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/alert_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - alert /alerts/statistics: get: description: 获取指定资源类的信息Statistics operationId: alert_GetPropertyStatistics responses: "200": $ref: '#/responses/alert_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - alert /alerts/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: alert_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/alert_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - alert /alerts/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: alert_GetPropertyTagValueTree responses: "200": $ref: '#/responses/alert_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - alert /common_alerts: get: description: 列表 operationId: common_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 - $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 - $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: |- 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/common_alert_ListItemFilterOutput' summary: 列表 tags: - common_alert post: description: 新建 operationId: common_alert_ValidateCreateData parameters: - in: body name: body schema: properties: common_alert: $ref: '#/definitions/CommonAlertCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/common_alert_ValidateCreateDataOutput' summary: 新建 tags: - common_alert /common_alerts/{id}: delete: description: 删除 operationId: common_alert_CustomizeDelete parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/common_alert_CustomizeDeleteOutput' summary: 删除 tags: - common_alert get: description: 获取详情 operationId: common_alert_FetchCustomizeColumns parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/common_alert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - common_alert put: description: 更新 operationId: common_alert_ValidateUpdateData parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/common_alert_ValidateUpdateDataOutput' summary: 更新 tags: - common_alert /common_alerts/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: common_alert_GetDetailsClassMetadata parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/common_alert_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - common_alert post: description: 执行操作ClassMetadata operationId: common_alert_PerformClassMetadata parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: common_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/common_alert_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - common_alert /common_alerts/{id}/config: post: description: 执行操作Config operationId: common_alert_PerformConfig parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/common_alert_PerformConfigOutput' summary: 执行操作Config tags: - common_alert /common_alerts/{id}/disable: post: description: 执行操作Disable operationId: common_alert_PerformDisable parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: common_alert: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/common_alert_PerformDisableOutput' summary: 执行操作Disable tags: - common_alert /common_alerts/{id}/enable: post: description: 执行操作Enable operationId: common_alert_PerformEnable parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: common_alert: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/common_alert_PerformEnableOutput' summary: 执行操作Enable tags: - common_alert /common_alerts/{id}/metadata: get: description: 获取指定信息Metadata operationId: common_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 common_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/common_alert_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - common_alert /common_alerts/{id}/pause: post: description: 执行操作Pause operationId: common_alert_PerformPause parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: common_alert: $ref: '#/definitions/AlertPauseInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/common_alert_PerformPauseOutput' summary: 执行操作Pause tags: - common_alert /common_alerts/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: common_alert_PerformSetClassMetadata parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: common_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/common_alert_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - common_alert /common_alerts/{id}/set-scope: post: description: 执行操作SetScope operationId: common_alert_PerformSetScope parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/common_alert_PerformSetScopeOutput' summary: 执行操作SetScope tags: - common_alert /common_alerts/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: common_alert_PerformSetUserMetadata parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: common_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/common_alert_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - common_alert /common_alerts/{id}/status: get: description: 获取指定信息Status operationId: common_alert_GetDetailsStatus parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/common_alert_GetDetailsStatusOutput' summary: 获取资源状态 tags: - common_alert post: description: 执行操作Status operationId: common_alert_PerformStatus parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: common_alert: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/common_alert_PerformStatusOutput' summary: 更新资源状态 tags: - common_alert /common_alerts/{id}/test-run: post: description: 执行操作TestRun operationId: common_alert_PerformTestRun parameters: - description: The Id or Name of common_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: common_alert: $ref: '#/definitions/AlertTestRunInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/common_alert_PerformTestRunOutput' summary: 执行操作TestRun tags: - common_alert /common_alerts/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: common_alert_GetPropertyDistinctField responses: "200": $ref: '#/responses/common_alert_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - common_alert /common_alerts/purge-splitable: post: description: 执行操作PurgeSplitable operationId: common_alert_PerformPurgeSplitable parameters: - in: body name: body schema: properties: common_alert: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/common_alert_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - common_alert /common_alerts/splitable: get: description: 获取指定资源类的信息Splitable operationId: common_alert_GetPropertySplitable responses: "200": $ref: '#/responses/common_alert_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - common_alert /common_alerts/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: common_alert_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/common_alert_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - common_alert /common_alerts/statistics: get: description: 获取指定资源类的信息Statistics operationId: common_alert_GetPropertyStatistics responses: "200": $ref: '#/responses/common_alert_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - common_alert /common_alerts/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: common_alert_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/common_alert_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - common_alert /common_alerts/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: common_alert_GetPropertyTagValueTree responses: "200": $ref: '#/responses/common_alert_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - common_alert /data_sources: get: description: 列表 operationId: data_source_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names responses: "200": $ref: '#/responses/data_source_ListItemFilterOutput' summary: 列表 tags: - data_source post: description: 新建 operationId: data_source_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count data_source: $ref: '#/definitions/StandaloneResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/data_source_ValidateCreateDataOutput' summary: 新建 tags: - data_source /data_sources/{id}: delete: description: 删除 operationId: data_source_CustomizeDelete parameters: - description: The Id or Name of data_source in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/data_source_CustomizeDeleteOutput' summary: 删除 tags: - data_source get: description: 获取详情 operationId: data_source_FetchCustomizeColumns parameters: - description: The Id or Name of data_source in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/data_source_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - data_source put: description: 更新 operationId: data_source_ValidateUpdateData parameters: - description: The Id or Name of data_source in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: data_source: $ref: '#/definitions/StandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/data_source_ValidateUpdateDataOutput' summary: 更新 tags: - data_source /data_sources/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: data_source_GetDetailsClassMetadata parameters: - description: The Id or Name of data_source in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/data_source_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - data_source post: description: 执行操作ClassMetadata operationId: data_source_PerformClassMetadata parameters: - description: The Id or Name of data_source in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: data_source: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/data_source_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - data_source /data_sources/{id}/metadata: get: description: 获取指定信息Metadata operationId: data_source_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 data_source in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/data_source_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - data_source /data_sources/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: data_source_PerformSetClassMetadata parameters: - description: The Id or Name of data_source in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: data_source: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/data_source_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - data_source /data_sources/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: data_source_PerformSetUserMetadata parameters: - description: The Id or Name of data_source in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: data_source: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/data_source_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - data_source /data_sources/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: data_source_GetPropertyDistinctField responses: "200": $ref: '#/responses/data_source_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - data_source /data_sources/purge-splitable: post: description: 执行操作PurgeSplitable operationId: data_source_PerformPurgeSplitable parameters: - in: body name: body schema: properties: data_source: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/data_source_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - data_source /data_sources/splitable: get: description: 获取指定资源类的信息Splitable operationId: data_source_GetPropertySplitable responses: "200": $ref: '#/responses/data_source_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - data_source /data_sources/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: data_source_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/data_source_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - data_source /data_sources/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: data_source_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/data_source_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - data_source /data_sources/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: data_source_GetPropertyTagValueTree responses: "200": $ref: '#/responses/data_source_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - data_source /meter_alerts: get: description: 列表 operationId: meter_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 items: type: string name: project_ids type: array x-go-name: ProjectIds - description: 按project名称排序，可能值为asc|desc in: query name: order_by_project pattern: asc|desc type: string x-go-name: OrderByProject - $ref: '#/definitions/TTagSetList' description: filter by project tags in: query name: project_tags x-go-name: ProjectTags - $ref: '#/definitions/TTagSetList' description: filter by no project tags in: query name: no_project_tags x-go-name: NoProjectTags - $ref: '#/definitions/TTagSetList' description: |- ignore project tag fitlers imposed by policy in: query name: policy_project_tags x-go-name: PolicyProjectTags - description: 指定匹配的范围，可能值为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 - $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: '监控资源类型, 比如: balance, resFree, monthFee' in: query name: type type: string x-go-name: Type - description: 云平台类型 in: query name: provider type: string x-go-name: Provider - description: 云账号 Id in: query name: account_id type: string x-go-name: AccountId - description: 项目 Id in: query name: project_id type: string x-go-name: ProjectId responses: "200": $ref: '#/responses/meter_alert_ListItemFilterOutput' summary: 列表 tags: - meter_alert post: description: 新建 operationId: meter_alert_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count meter_alert: $ref: '#/definitions/MeterAlertCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_ValidateCreateDataOutput' summary: 新建 tags: - meter_alert /meter_alerts/{id}: delete: description: 删除 operationId: meter_alert_CustomizeDelete parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/meter_alert_CustomizeDeleteOutput' summary: 删除 tags: - meter_alert get: description: 获取详情 operationId: meter_alert_FetchCustomizeColumns parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/meter_alert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - meter_alert put: description: 更新 operationId: meter_alert_ValidateUpdateData parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: meter_alert: $ref: '#/definitions/MeterAlertUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_ValidateUpdateDataOutput' summary: 更新 tags: - meter_alert /meter_alerts/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: meter_alert_GetDetailsClassMetadata parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/meter_alert_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - meter_alert post: description: 执行操作ClassMetadata operationId: meter_alert_PerformClassMetadata parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: meter_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - meter_alert /meter_alerts/{id}/disable: post: description: 执行操作Disable operationId: meter_alert_PerformDisable parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: meter_alert: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_PerformDisableOutput' summary: 执行操作Disable tags: - meter_alert /meter_alerts/{id}/enable: post: description: 执行操作Enable operationId: meter_alert_PerformEnable parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: meter_alert: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_PerformEnableOutput' summary: 执行操作Enable tags: - meter_alert /meter_alerts/{id}/metadata: get: description: 获取指定信息Metadata operationId: meter_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 meter_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/meter_alert_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - meter_alert /meter_alerts/{id}/pause: post: description: 执行操作Pause operationId: meter_alert_PerformPause parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: meter_alert: $ref: '#/definitions/AlertPauseInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_PerformPauseOutput' summary: 执行操作Pause tags: - meter_alert /meter_alerts/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: meter_alert_PerformSetClassMetadata parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: meter_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - meter_alert /meter_alerts/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: meter_alert_PerformSetUserMetadata parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: meter_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - meter_alert /meter_alerts/{id}/status: get: description: 获取指定信息Status operationId: meter_alert_GetDetailsStatus parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/meter_alert_GetDetailsStatusOutput' summary: 获取资源状态 tags: - meter_alert post: description: 执行操作Status operationId: meter_alert_PerformStatus parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: meter_alert: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_PerformStatusOutput' summary: 更新资源状态 tags: - meter_alert /meter_alerts/{id}/test-run: post: description: 执行操作TestRun operationId: meter_alert_PerformTestRun parameters: - description: The Id or Name of meter_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: meter_alert: $ref: '#/definitions/AlertTestRunInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_PerformTestRunOutput' summary: 执行操作TestRun tags: - meter_alert /meter_alerts/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: meter_alert_GetPropertyDistinctField responses: "200": $ref: '#/responses/meter_alert_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - meter_alert /meter_alerts/purge-splitable: post: description: 执行操作PurgeSplitable operationId: meter_alert_PerformPurgeSplitable parameters: - in: body name: body schema: properties: meter_alert: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/meter_alert_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - meter_alert /meter_alerts/splitable: get: description: 获取指定资源类的信息Splitable operationId: meter_alert_GetPropertySplitable responses: "200": $ref: '#/responses/meter_alert_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - meter_alert /meter_alerts/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: meter_alert_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/meter_alert_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - meter_alert /meter_alerts/statistics: get: description: 获取指定资源类的信息Statistics operationId: meter_alert_GetPropertyStatistics responses: "200": $ref: '#/responses/meter_alert_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - meter_alert /meter_alerts/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: meter_alert_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/meter_alert_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - meter_alert /meter_alerts/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: meter_alert_GetPropertyTagValueTree responses: "200": $ref: '#/responses/meter_alert_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - meter_alert /metric_fields: get: description: 列表 operationId: metric_field_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 in: query items: type: string name: status type: array x-go-name: Status - description: 以资源是否启用/禁用过滤列表 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 - $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/metric_field_ListItemFilterOutput' summary: 列表 tags: - metric_field post: description: 新建 operationId: metric_field_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count metric_field: $ref: '#/definitions/MetricFieldCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_field_ValidateCreateDataOutput' summary: 新建 tags: - metric_field /metric_fields/{id}: delete: description: 删除 operationId: metric_field_CustomizeDelete parameters: - description: The Id or Name of metric_field in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_field_CustomizeDeleteOutput' summary: 删除 tags: - metric_field get: description: 获取详情 operationId: metric_field_FetchCustomizeColumns parameters: - description: The Id or Name of metric_field in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_field_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - metric_field put: description: 更新 operationId: metric_field_ValidateUpdateData parameters: - description: The Id or Name of metric_field in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric_field: $ref: '#/definitions/MetricFieldUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_field_ValidateUpdateDataOutput' summary: 更新 tags: - metric_field /metric_fields/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: metric_field_GetDetailsClassMetadata parameters: - description: The Id or Name of metric_field in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_field_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - metric_field post: description: 执行操作ClassMetadata operationId: metric_field_PerformClassMetadata parameters: - description: The Id or Name of metric_field in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric_field: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_field_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - metric_field /metric_fields/{id}/metadata: get: description: 获取指定信息Metadata operationId: metric_field_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 metric_field in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_field_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - metric_field /metric_fields/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: metric_field_PerformSetClassMetadata parameters: - description: The Id or Name of metric_field in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric_field: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_field_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - metric_field /metric_fields/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: metric_field_PerformSetUserMetadata parameters: - description: The Id or Name of metric_field in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric_field: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_field_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - metric_field /metric_fields/{id}/status: get: description: 获取指定信息Status operationId: metric_field_GetDetailsStatus parameters: - description: The Id or Name of metric_field in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_field_GetDetailsStatusOutput' summary: 获取资源状态 tags: - metric_field post: description: 执行操作Status operationId: metric_field_PerformStatus parameters: - description: The Id or Name of metric_field in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric_field: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_field_PerformStatusOutput' summary: 更新资源状态 tags: - metric_field /metric_fields/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: metric_field_GetPropertyDistinctField responses: "200": $ref: '#/responses/metric_field_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - metric_field /metric_fields/purge-splitable: post: description: 执行操作PurgeSplitable operationId: metric_field_PerformPurgeSplitable parameters: - in: body name: body schema: properties: metric_field: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_field_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - metric_field /metric_fields/splitable: get: description: 获取指定资源类的信息Splitable operationId: metric_field_GetPropertySplitable responses: "200": $ref: '#/responses/metric_field_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - metric_field /metric_fields/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: metric_field_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/metric_field_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - metric_field /metric_fields/statistics: get: description: 获取指定资源类的信息Statistics operationId: metric_field_GetPropertyStatistics responses: "200": $ref: '#/responses/metric_field_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - metric_field /metric_fields/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: metric_field_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/metric_field_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - metric_field /metric_fields/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: metric_field_GetPropertyTagValueTree responses: "200": $ref: '#/responses/metric_field_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - metric_field /metric_measurements: get: description: 列表 operationId: metric_measurement_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/metric_measurement_ListItemFilterOutput' summary: 列表 tags: - metric_measurement post: description: 新建 operationId: metric_measurement_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count metric_measurement: $ref: '#/definitions/MetricCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_measurement_ValidateCreateDataOutput' summary: 新建 tags: - metric_measurement /metric_measurements/{id}: delete: description: 删除 operationId: metric_measurement_CustomizeDelete parameters: - description: The Id or Name of metric_measurement in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_measurement_CustomizeDeleteOutput' summary: 删除 tags: - metric_measurement get: description: 获取详情 operationId: metric_measurement_FetchCustomizeColumns parameters: - description: The Id or Name of metric_measurement in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_measurement_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - metric_measurement put: description: 更新 operationId: metric_measurement_ValidateUpdateData parameters: - description: The Id or Name of metric_measurement in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric_measurement: $ref: '#/definitions/MetricUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_measurement_ValidateUpdateDataOutput' summary: 更新 tags: - metric_measurement /metric_measurements/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: metric_measurement_GetDetailsClassMetadata parameters: - description: The Id or Name of metric_measurement in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_measurement_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - metric_measurement post: description: 执行操作ClassMetadata operationId: metric_measurement_PerformClassMetadata parameters: - description: The Id or Name of metric_measurement in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric_measurement: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_measurement_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - metric_measurement /metric_measurements/{id}/metadata: get: description: 获取指定信息Metadata operationId: metric_measurement_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 metric_measurement in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_measurement_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - metric_measurement /metric_measurements/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: metric_measurement_PerformSetClassMetadata parameters: - description: The Id or Name of metric_measurement in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric_measurement: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_measurement_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - metric_measurement /metric_measurements/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: metric_measurement_PerformSetUserMetadata parameters: - description: The Id or Name of metric_measurement in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric_measurement: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_measurement_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - metric_measurement /metric_measurements/{id}/status: get: description: 获取指定信息Status operationId: metric_measurement_GetDetailsStatus parameters: - description: The Id or Name of metric_measurement in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/metric_measurement_GetDetailsStatusOutput' summary: 获取资源状态 tags: - metric_measurement post: description: 执行操作Status operationId: metric_measurement_PerformStatus parameters: - description: The Id or Name of metric_measurement in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: metric_measurement: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_measurement_PerformStatusOutput' summary: 更新资源状态 tags: - metric_measurement /metric_measurements/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: metric_measurement_GetPropertyDistinctField responses: "200": $ref: '#/responses/metric_measurement_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - metric_measurement /metric_measurements/purge-splitable: post: description: 执行操作PurgeSplitable operationId: metric_measurement_PerformPurgeSplitable parameters: - in: body name: body schema: properties: metric_measurement: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_measurement_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - metric_measurement /metric_measurements/splitable: get: description: 获取指定资源类的信息Splitable operationId: metric_measurement_GetPropertySplitable responses: "200": $ref: '#/responses/metric_measurement_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - metric_measurement /metric_measurements/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: metric_measurement_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/metric_measurement_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - metric_measurement /metric_measurements/statistics: get: description: 获取指定资源类的信息Statistics operationId: metric_measurement_GetPropertyStatistics responses: "200": $ref: '#/responses/metric_measurement_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - metric_measurement /metric_measurements/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: metric_measurement_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/metric_measurement_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - metric_measurement /metric_measurements/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: metric_measurement_GetPropertyTagValueTree responses: "200": $ref: '#/responses/metric_measurement_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - metric_measurement /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 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 /metrics/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: metric_GetPropertyDistinctField responses: "200": $ref: '#/responses/metric_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - metric /metrics/purge-splitable: post: description: 执行操作PurgeSplitable operationId: metric_PerformPurgeSplitable parameters: - in: body name: body schema: properties: metric: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/metric_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - metric /metrics/splitable: get: description: 获取指定资源类的信息Splitable operationId: metric_GetPropertySplitable responses: "200": $ref: '#/responses/metric_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - metric /metrics/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: metric_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/metric_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - metric /migration_alerts: get: description: 列表 operationId: migration_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 - $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 - $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: metric_type type: string x-go-name: MetricType responses: "200": $ref: '#/responses/migration_alert_ListItemFilterOutput' summary: 列表 tags: - migration_alert post: description: 新建 operationId: migration_alert_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count migration_alert: $ref: '#/definitions/MigrationAlertCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_ValidateCreateDataOutput' summary: 新建 tags: - migration_alert /migration_alerts/{id}: delete: description: 删除 operationId: migration_alert_CustomizeDelete parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/migration_alert_CustomizeDeleteOutput' summary: 删除 tags: - migration_alert get: description: 获取详情 operationId: migration_alert_FetchCustomizeColumns parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/migration_alert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - migration_alert put: description: 更新 operationId: migration_alert_ValidateUpdateData parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migration_alert: $ref: '#/definitions/AlertUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_ValidateUpdateDataOutput' summary: 更新 tags: - migration_alert /migration_alerts/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: migration_alert_GetDetailsClassMetadata parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/migration_alert_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - migration_alert post: description: 执行操作ClassMetadata operationId: migration_alert_PerformClassMetadata parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migration_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - migration_alert /migration_alerts/{id}/disable: post: description: 执行操作Disable operationId: migration_alert_PerformDisable parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migration_alert: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_PerformDisableOutput' summary: 执行操作Disable tags: - migration_alert /migration_alerts/{id}/enable: post: description: 执行操作Enable operationId: migration_alert_PerformEnable parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migration_alert: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_PerformEnableOutput' summary: 执行操作Enable tags: - migration_alert /migration_alerts/{id}/metadata: get: description: 获取指定信息Metadata operationId: migration_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 migration_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/migration_alert_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - migration_alert /migration_alerts/{id}/pause: post: description: 执行操作Pause operationId: migration_alert_PerformPause parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migration_alert: $ref: '#/definitions/AlertPauseInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_PerformPauseOutput' summary: 执行操作Pause tags: - migration_alert /migration_alerts/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: migration_alert_PerformSetClassMetadata parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migration_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - migration_alert /migration_alerts/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: migration_alert_PerformSetUserMetadata parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migration_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - migration_alert /migration_alerts/{id}/status: get: description: 获取指定信息Status operationId: migration_alert_GetDetailsStatus parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/migration_alert_GetDetailsStatusOutput' summary: 获取资源状态 tags: - migration_alert post: description: 执行操作Status operationId: migration_alert_PerformStatus parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migration_alert: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_PerformStatusOutput' summary: 更新资源状态 tags: - migration_alert /migration_alerts/{id}/test-run: post: description: 执行操作TestRun operationId: migration_alert_PerformTestRun parameters: - description: The Id or Name of migration_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: migration_alert: $ref: '#/definitions/AlertTestRunInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_PerformTestRunOutput' summary: 执行操作TestRun tags: - migration_alert /migration_alerts/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: migration_alert_GetPropertyDistinctField responses: "200": $ref: '#/responses/migration_alert_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - migration_alert /migration_alerts/purge-splitable: post: description: 执行操作PurgeSplitable operationId: migration_alert_PerformPurgeSplitable parameters: - in: body name: body schema: properties: migration_alert: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/migration_alert_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - migration_alert /migration_alerts/splitable: get: description: 获取指定资源类的信息Splitable operationId: migration_alert_GetPropertySplitable responses: "200": $ref: '#/responses/migration_alert_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - migration_alert /migration_alerts/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: migration_alert_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/migration_alert_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - migration_alert /migration_alerts/statistics: get: description: 获取指定资源类的信息Statistics operationId: migration_alert_GetPropertyStatistics responses: "200": $ref: '#/responses/migration_alert_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - migration_alert /migration_alerts/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: migration_alert_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/migration_alert_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - migration_alert /migration_alerts/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: migration_alert_GetPropertyTagValueTree responses: "200": $ref: '#/responses/migration_alert_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - migration_alert /monitor_resource_alerts: get: description: 列表 operationId: monitor_resource_alert_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 in: query items: type: string name: status type: array x-go-name: Status - description: 指定查询的权限范围，可能值为project, domain or system in: query name: scope type: string x-go-name: Scope - description: 指定项目归属域名称或ID in: query name: project_domain_id type: string x-go-name: ProjectDomainId - description: 对具有域属性的资源，严格匹配域ID in: query items: type: string name: project_domain_ids type: array x-go-name: ProjectDomainIds - description: 按domain名称排序，可能值为asc|desc in: query name: order_by_domain pattern: asc|desc type: string x-go-name: OrderByDomain - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: domain_tags x-go-name: DomainTags - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: no_domain_tags x-go-name: NoDomainTags - description: 指定项目的名称或ID in: query name: project_id type: string x-go-name: ProjectId - description: 对具有项目属性的资源，严格匹配项目ID in: query items: type: string name: project_ids type: array x-go-name: ProjectIds - description: 按project名称排序，可能值为asc|desc in: query name: order_by_project pattern: asc|desc type: string x-go-name: OrderByProject - $ref: '#/definitions/TTagSetList' description: filter by project tags in: query name: project_tags x-go-name: ProjectTags - $ref: '#/definitions/TTagSetList' description: filter by no project tags in: query name: no_project_tags x-go-name: NoProjectTags - $ref: '#/definitions/TTagSetList' description: |- ignore project tag fitlers imposed by policy in: query name: policy_project_tags x-go-name: PolicyProjectTags - description: 列表中包含标记为"系统资源"的资源 in: query name: system type: boolean x-go-name: System - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） in: query name: pending_delete type: boolean x-go-name: PendingDelete - 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: alertinng type: boolean x-go-name: Alerting - 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: 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 responses: "200": $ref: '#/responses/monitor_resource_alert_ListItemFilterOutput' summary: 列表 tags: - monitor_resource_alert post: description: 新建 operationId: monitor_resource_alert_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count monitor_resource_alert: $ref: '#/definitions/JoinResourceBaseCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_alert_ValidateCreateDataOutput' summary: 新建 tags: - monitor_resource_alert /monitor_resource_alerts/{id}: delete: description: 删除 operationId: monitor_resource_alert_CustomizeDelete parameters: - description: The Id or Name of monitor_resource_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitor_resource_alert_CustomizeDeleteOutput' summary: 删除 tags: - monitor_resource_alert get: description: 获取详情 operationId: monitor_resource_alert_FetchCustomizeColumns parameters: - description: The Id or Name of monitor_resource_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitor_resource_alert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - monitor_resource_alert put: description: 更新 operationId: monitor_resource_alert_ValidateUpdateData parameters: - description: The Id or Name of monitor_resource_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitor_resource_alert: $ref: '#/definitions/JointResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_alert_ValidateUpdateDataOutput' summary: 更新 tags: - monitor_resource_alert /monitor_resource_alerts/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: monitor_resource_alert_GetPropertyDistinctField responses: "200": $ref: '#/responses/monitor_resource_alert_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - monitor_resource_alert /monitor_resource_alerts/purge-splitable: post: description: 执行操作PurgeSplitable operationId: monitor_resource_alert_PerformPurgeSplitable parameters: - in: body name: body schema: properties: monitor_resource_alert: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_alert_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - monitor_resource_alert /monitor_resource_alerts/splitable: get: description: 获取指定资源类的信息Splitable operationId: monitor_resource_alert_GetPropertySplitable responses: "200": $ref: '#/responses/monitor_resource_alert_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - monitor_resource_alert /monitor_resource_alerts/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: monitor_resource_alert_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/monitor_resource_alert_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - monitor_resource_alert /monitor_resources: get: description: 列表 operationId: monitor_resource_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - $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 - $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 - description: |- 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band Brand | Provider | 说明 | ----------|----------|------------| DStack | ZStack | 滴滴云私有云 | 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 name: cloudprovider_id type: string 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 - 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 name: res_name type: string x-go-name: ResName responses: "200": $ref: '#/responses/monitor_resource_ListItemFilterOutput' summary: 列表 tags: - monitor_resource post: description: 新建 operationId: monitor_resource_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count monitor_resource: $ref: '#/definitions/MonitorResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_ValidateCreateDataOutput' summary: 新建 tags: - monitor_resource /monitor_resources/{id}: delete: description: 删除 operationId: monitor_resource_CustomizeDelete parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitor_resource_CustomizeDeleteOutput' summary: 删除 tags: - monitor_resource get: description: 获取详情 operationId: monitor_resource_FetchCustomizeColumns parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitor_resource_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - monitor_resource put: description: 更新 operationId: monitor_resource_ValidateUpdateData parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitor_resource: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_ValidateUpdateDataOutput' summary: 更新 tags: - monitor_resource /monitor_resources/{id}/cancel-delete: post: description: 执行操作CancelDelete operationId: monitor_resource_PerformCancelDelete parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitor_resource_PerformCancelDeleteOutput' summary: 执行操作CancelDelete tags: - monitor_resource /monitor_resources/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: monitor_resource_PerformChangeOwner parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitor_resource: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - monitor_resource /monitor_resources/{id}/change-owner-candidate-domains: get: description: 获取指定信息ChangeOwnerCandidateDomains operationId: monitor_resource_GetDetailsChangeOwnerCandidateDomains parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitor_resource_GetDetailsChangeOwnerCandidateDomainsOutput' summary: 获取指定信息ChangeOwnerCandidateDomains tags: - monitor_resource /monitor_resources/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: monitor_resource_GetDetailsClassMetadata parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitor_resource_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - monitor_resource post: description: 执行操作ClassMetadata operationId: monitor_resource_PerformClassMetadata parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitor_resource: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - monitor_resource /monitor_resources/{id}/freeze: post: description: 执行操作Freeze operationId: monitor_resource_PerformFreeze parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitor_resource: $ref: '#/definitions/PerformFreezeInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_PerformFreezeOutput' summary: freezed update and perform action operation except for unfreeze tags: - monitor_resource /monitor_resources/{id}/metadata: get: description: 获取指定信息Metadata operationId: monitor_resource_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 monitor_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitor_resource_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - monitor_resource /monitor_resources/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: monitor_resource_PerformSetClassMetadata parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitor_resource: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - monitor_resource /monitor_resources/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: monitor_resource_PerformSetUserMetadata parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitor_resource: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - monitor_resource /monitor_resources/{id}/status: get: description: 获取指定信息Status operationId: monitor_resource_GetDetailsStatus parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/monitor_resource_GetDetailsStatusOutput' summary: 获取资源状态 tags: - monitor_resource post: description: 执行操作Status operationId: monitor_resource_PerformStatus parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitor_resource: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_PerformStatusOutput' summary: 更新资源状态 tags: - monitor_resource /monitor_resources/{id}/unfreeze: post: description: 执行操作Unfreeze operationId: monitor_resource_PerformUnfreeze parameters: - description: The Id or Name of monitor_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: monitor_resource: $ref: '#/definitions/PerformUnfreezeInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_PerformUnfreezeOutput' summary: 执行操作Unfreeze tags: - monitor_resource /monitor_resources/alert: get: description: 获取指定资源类的信息Alert operationId: monitor_resource_GetPropertyAlert responses: "200": $ref: '#/responses/monitor_resource_GetPropertyAlertOutput' summary: 获取指定资源类的信息Alert tags: - monitor_resource /monitor_resources/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: monitor_resource_GetPropertyDistinctField responses: "200": $ref: '#/responses/monitor_resource_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - monitor_resource /monitor_resources/domain-statistics: get: description: 获取指定资源类的信息DomainStatistics operationId: monitor_resource_GetPropertyDomainStatistics responses: "200": $ref: '#/responses/monitor_resource_GetPropertyDomainStatisticsOutput' summary: 获取指定资源类的信息DomainStatistics tags: - monitor_resource /monitor_resources/project-statistics: get: description: 获取指定资源类的信息ProjectStatistics operationId: monitor_resource_GetPropertyProjectStatistics responses: "200": $ref: '#/responses/monitor_resource_GetPropertyProjectStatisticsOutput' summary: 获取指定资源类的信息ProjectStatistics tags: - monitor_resource /monitor_resources/project-tag-value-pairs: get: description: 获取指定资源类的信息ProjectTagValuePairs operationId: monitor_resource_GetPropertyProjectTagValuePairs responses: "200": $ref: '#/responses/monitor_resource_GetPropertyProjectTagValuePairsOutput' summary: 获取指定资源类的信息ProjectTagValuePairs tags: - monitor_resource /monitor_resources/project-tag-value-tree: get: description: 获取指定资源类的信息ProjectTagValueTree operationId: monitor_resource_GetPropertyProjectTagValueTree responses: "200": $ref: '#/responses/monitor_resource_GetPropertyProjectTagValueTreeOutput' summary: 获取指定资源类的信息ProjectTagValueTree tags: - monitor_resource /monitor_resources/purge-splitable: post: description: 执行操作PurgeSplitable operationId: monitor_resource_PerformPurgeSplitable parameters: - in: body name: body schema: properties: monitor_resource: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/monitor_resource_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - monitor_resource /monitor_resources/splitable: get: description: 获取指定资源类的信息Splitable operationId: monitor_resource_GetPropertySplitable responses: "200": $ref: '#/responses/monitor_resource_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - monitor_resource /monitor_resources/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: monitor_resource_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/monitor_resource_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - monitor_resource /monitor_resources/statistics: get: description: 获取指定资源类的信息Statistics operationId: monitor_resource_GetPropertyStatistics responses: "200": $ref: '#/responses/monitor_resource_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - monitor_resource /monitor_resources/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: monitor_resource_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/monitor_resource_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - monitor_resource /monitor_resources/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: monitor_resource_GetPropertyTagValueTree responses: "200": $ref: '#/responses/monitor_resource_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - monitor_resource /node_alerts: get: description: 列表 operationId: node_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 - $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 - $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: 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/node_alert_ListItemFilterOutput' summary: 列表 tags: - node_alert post: description: 新建 operationId: node_alert_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count node_alert: $ref: '#/definitions/NodeAlertCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_ValidateCreateDataOutput' summary: 新建 tags: - node_alert /node_alerts/{id}: delete: description: 删除 operationId: node_alert_CustomizeDelete parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/node_alert_CustomizeDeleteOutput' summary: 删除 tags: - node_alert get: description: 获取详情 operationId: node_alert_FetchCustomizeColumns parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/node_alert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - node_alert put: description: 更新 operationId: node_alert_ValidateUpdateData parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: node_alert: $ref: '#/definitions/NodeAlertUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_ValidateUpdateDataOutput' summary: 更新 tags: - node_alert /node_alerts/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: node_alert_GetDetailsClassMetadata parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/node_alert_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - node_alert post: description: 执行操作ClassMetadata operationId: node_alert_PerformClassMetadata parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: node_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - node_alert /node_alerts/{id}/config: post: description: 执行操作Config operationId: node_alert_PerformConfig parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/node_alert_PerformConfigOutput' summary: 执行操作Config tags: - node_alert /node_alerts/{id}/disable: post: description: 执行操作Disable operationId: node_alert_PerformDisable parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: node_alert: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_PerformDisableOutput' summary: 执行操作Disable tags: - node_alert /node_alerts/{id}/enable: post: description: 执行操作Enable operationId: node_alert_PerformEnable parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: node_alert: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_PerformEnableOutput' summary: 执行操作Enable tags: - node_alert /node_alerts/{id}/metadata: get: description: 获取指定信息Metadata operationId: node_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 node_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/node_alert_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - node_alert /node_alerts/{id}/pause: post: description: 执行操作Pause operationId: node_alert_PerformPause parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: node_alert: $ref: '#/definitions/AlertPauseInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_PerformPauseOutput' summary: 执行操作Pause tags: - node_alert /node_alerts/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: node_alert_PerformSetClassMetadata parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: node_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - node_alert /node_alerts/{id}/set-scope: post: description: 执行操作SetScope operationId: node_alert_PerformSetScope parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/node_alert_PerformSetScopeOutput' summary: 执行操作SetScope tags: - node_alert /node_alerts/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: node_alert_PerformSetUserMetadata parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: node_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - node_alert /node_alerts/{id}/status: get: description: 获取指定信息Status operationId: node_alert_GetDetailsStatus parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/node_alert_GetDetailsStatusOutput' summary: 获取资源状态 tags: - node_alert post: description: 执行操作Status operationId: node_alert_PerformStatus parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: node_alert: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_PerformStatusOutput' summary: 更新资源状态 tags: - node_alert /node_alerts/{id}/test-run: post: description: 执行操作TestRun operationId: node_alert_PerformTestRun parameters: - description: The Id or Name of node_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: node_alert: $ref: '#/definitions/AlertTestRunInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_PerformTestRunOutput' summary: 执行操作TestRun tags: - node_alert /node_alerts/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: node_alert_GetPropertyDistinctField responses: "200": $ref: '#/responses/node_alert_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - node_alert /node_alerts/purge-splitable: post: description: 执行操作PurgeSplitable operationId: node_alert_PerformPurgeSplitable parameters: - in: body name: body schema: properties: node_alert: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/node_alert_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - node_alert /node_alerts/splitable: get: description: 获取指定资源类的信息Splitable operationId: node_alert_GetPropertySplitable responses: "200": $ref: '#/responses/node_alert_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - node_alert /node_alerts/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: node_alert_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/node_alert_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - node_alert /node_alerts/statistics: get: description: 获取指定资源类的信息Statistics operationId: node_alert_GetPropertyStatistics responses: "200": $ref: '#/responses/node_alert_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - node_alert /node_alerts/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: node_alert_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/node_alert_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - node_alert /node_alerts/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: node_alert_GetPropertyTagValueTree responses: "200": $ref: '#/responses/node_alert_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - node_alert /v1_alerts: get: description: 列表 operationId: v1_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 - $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 - $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 responses: "200": $ref: '#/responses/v1_alert_ListItemFilterOutput' summary: 列表 tags: - v1_alert post: description: 新建 operationId: v1_alert_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count v1_alert: $ref: '#/definitions/AlertCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_ValidateCreateDataOutput' summary: 新建 tags: - v1_alert /v1_alerts/{id}: delete: description: 删除 operationId: v1_alert_CustomizeDelete parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/v1_alert_CustomizeDeleteOutput' summary: 删除 tags: - v1_alert get: description: 获取详情 operationId: v1_alert_FetchCustomizeColumns parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/v1_alert_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - v1_alert put: description: 更新 operationId: v1_alert_ValidateUpdateData parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: v1_alert: $ref: '#/definitions/V1AlertUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_ValidateUpdateDataOutput' summary: 更新 tags: - v1_alert /v1_alerts/{id}/class-metadata: get: description: 获取指定信息ClassMetadata operationId: v1_alert_GetDetailsClassMetadata parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/v1_alert_GetDetailsClassMetadataOutput' summary: 获取指定信息ClassMetadata tags: - v1_alert post: description: 执行操作ClassMetadata operationId: v1_alert_PerformClassMetadata parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: v1_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_PerformClassMetadataOutput' summary: 更新资源的 class 标签 tags: - v1_alert /v1_alerts/{id}/disable: post: description: 执行操作Disable operationId: v1_alert_PerformDisable parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: v1_alert: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_PerformDisableOutput' summary: 执行操作Disable tags: - v1_alert /v1_alerts/{id}/enable: post: description: 执行操作Enable operationId: v1_alert_PerformEnable parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: v1_alert: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_PerformEnableOutput' summary: 执行操作Enable tags: - v1_alert /v1_alerts/{id}/metadata: get: description: 获取指定信息Metadata operationId: v1_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 v1_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/v1_alert_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - v1_alert /v1_alerts/{id}/pause: post: description: 执行操作Pause operationId: v1_alert_PerformPause parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: v1_alert: $ref: '#/definitions/AlertPauseInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_PerformPauseOutput' summary: 执行操作Pause tags: - v1_alert /v1_alerts/{id}/set-class-metadata: post: description: 执行操作SetClassMetadata operationId: v1_alert_PerformSetClassMetadata parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: v1_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_PerformSetClassMetadataOutput' summary: 全量替换资源的所有 class 标签 tags: - v1_alert /v1_alerts/{id}/set-user-metadata: post: description: 执行操作SetUserMetadata operationId: v1_alert_PerformSetUserMetadata parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: v1_alert: additionalProperties: type: string type: object x-go-name: Input type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_PerformSetUserMetadataOutput' summary: 全量替换资源的所有用户标签 tags: - v1_alert /v1_alerts/{id}/status: get: description: 获取指定信息Status operationId: v1_alert_GetDetailsStatus parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/v1_alert_GetDetailsStatusOutput' summary: 获取资源状态 tags: - v1_alert post: description: 执行操作Status operationId: v1_alert_PerformStatus parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: v1_alert: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_PerformStatusOutput' summary: 更新资源状态 tags: - v1_alert /v1_alerts/{id}/test-run: post: description: 执行操作TestRun operationId: v1_alert_PerformTestRun parameters: - description: The Id or Name of v1_alert in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: v1_alert: $ref: '#/definitions/AlertTestRunInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_PerformTestRunOutput' summary: 执行操作TestRun tags: - v1_alert /v1_alerts/distinct-field: get: description: 获取指定资源类的信息DistinctField operationId: v1_alert_GetPropertyDistinctField responses: "200": $ref: '#/responses/v1_alert_GetPropertyDistinctFieldOutput' summary: 获取指定资源类的信息DistinctField tags: - v1_alert /v1_alerts/purge-splitable: post: description: 执行操作PurgeSplitable operationId: v1_alert_PerformPurgeSplitable parameters: - in: body name: body schema: properties: v1_alert: $ref: '#/definitions/PurgeSplitTableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/v1_alert_PerformPurgeSplitableOutput' summary: 执行操作PurgeSplitable tags: - v1_alert /v1_alerts/splitable: get: description: 获取指定资源类的信息Splitable operationId: v1_alert_GetPropertySplitable responses: "200": $ref: '#/responses/v1_alert_GetPropertySplitableOutput' summary: 获取指定资源类的信息Splitable tags: - v1_alert /v1_alerts/splitable-export: get: description: 获取指定资源类的信息SplitableExport operationId: v1_alert_GetPropertySplitableExport parameters: - in: query name: table type: string x-go-name: Table - format: int64 in: query name: offset type: integer x-go-name: Offset - format: int64 in: query name: limit type: integer x-go-name: Limit responses: "200": $ref: '#/responses/v1_alert_GetPropertySplitableExportOutput' summary: 获取指定资源类的信息SplitableExport tags: - v1_alert /v1_alerts/statistics: get: description: 获取指定资源类的信息Statistics operationId: v1_alert_GetPropertyStatistics responses: "200": $ref: '#/responses/v1_alert_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - v1_alert /v1_alerts/tag-value-pairs: get: description: 获取指定资源类的信息TagValuePairs operationId: v1_alert_GetPropertyTagValuePairs responses: "200": $ref: '#/responses/v1_alert_GetPropertyTagValuePairsOutput' summary: 获取指定资源类的信息TagValuePairs tags: - v1_alert /v1_alerts/tag-value-tree: get: description: 获取指定资源类的信息TagValueTree operationId: v1_alert_GetPropertyTagValueTree responses: "200": $ref: '#/responses/v1_alert_GetPropertyTagValueTreeOutput' summary: 获取指定资源类的信息TagValueTree tags: - v1_alert produces: - application/json responses: alert_CustomizeDeleteOutput: schema: properties: alert: $ref: '#/definitions/AlertDetails' type: object alert_FetchCustomizeColumnsOutput: schema: properties: alert: $ref: '#/definitions/AlertDetails' type: object alert_GetDetailsClassMetadataOutput: schema: properties: alert: additionalProperties: type: string type: object x-go-name: Output type: object alert_GetDetailsMetadataOutput: schema: properties: alert: additionalProperties: type: string type: object x-go-name: Output type: object alert_GetDetailsStatusOutput: schema: properties: alert: $ref: '#/definitions/GetDetailsStatusOutput' type: object alert_GetPropertyDistinctFieldOutput: {} alert_GetPropertySplitableExportOutput: {} alert_GetPropertySplitableOutput: {} alert_GetPropertyStatisticsOutput: schema: properties: alert: $ref: '#/definitions/StatusStatistic' type: object alert_GetPropertyTagValuePairsOutput: {} alert_GetPropertyTagValueTreeOutput: {} alert_ListItemFilterOutput: 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_PerformClassMetadataOutput: {} alert_PerformDisableOutput: {} alert_PerformEnableOutput: {} alert_PerformPauseOutput: {} alert_PerformPurgeSplitableOutput: {} alert_PerformSetClassMetadataOutput: {} alert_PerformSetUserMetadataOutput: {} alert_PerformStatusOutput: {} alert_PerformTestRunOutput: schema: properties: alert: $ref: '#/definitions/AlertTestRunOutput' type: object alert_ValidateCreateDataOutput: schema: properties: alert: $ref: '#/definitions/AlertDetails' type: object alert_ValidateUpdateDataOutput: schema: properties: alert: $ref: '#/definitions/AlertDetails' type: object alert_dash_board_CustomizeDeleteOutput: schema: properties: alert_dash_board: $ref: '#/definitions/AlertDashBoardDetails' type: object alert_dash_board_FetchCustomizeColumnsOutput: schema: properties: alert_dash_board: $ref: '#/definitions/AlertDashBoardDetails' type: object alert_dash_board_GetDetailsClassMetadataOutput: schema: properties: alert_dash_board: additionalProperties: type: string type: object x-go-name: Output type: object alert_dash_board_GetDetailsMetadataOutput: schema: properties: alert_dash_board: additionalProperties: type: string type: object x-go-name: Output type: object alert_dash_board_GetDetailsStatusOutput: schema: properties: alert_dash_board: $ref: '#/definitions/GetDetailsStatusOutput' type: object alert_dash_board_GetPropertyDistinctFieldOutput: {} alert_dash_board_GetPropertySplitableExportOutput: {} alert_dash_board_GetPropertySplitableOutput: {} alert_dash_board_GetPropertyStatisticsOutput: schema: properties: alert_dash_board: $ref: '#/definitions/StatusStatistic' type: object alert_dash_board_GetPropertyTagValuePairsOutput: {} alert_dash_board_GetPropertyTagValueTreeOutput: {} alert_dash_board_ListItemFilterOutput: schema: properties: alert_dash_boards: 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 alert_dash_board_PerformClassMetadataOutput: {} alert_dash_board_PerformCloneDashboardOutput: {} alert_dash_board_PerformClonePanelOutput: {} alert_dash_board_PerformPurgeSplitableOutput: {} alert_dash_board_PerformSetClassMetadataOutput: {} alert_dash_board_PerformSetScopeOutput: {} alert_dash_board_PerformSetUserMetadataOutput: {} alert_dash_board_PerformStatusOutput: {} alert_dash_board_ValidateCreateDataOutput: schema: properties: alert_dash_board: $ref: '#/definitions/AlertDashBoardDetails' type: object alert_dash_board_ValidateUpdateDataOutput: schema: properties: alert_dash_board: $ref: '#/definitions/AlertDashBoardDetails' type: object alert_dashboard_panel_CustomizeDeleteOutput: schema: properties: alert_dashboard_panel: $ref: '#/definitions/JointResourceBaseDetails' type: object alert_dashboard_panel_FetchCustomizeColumnsOutput: schema: properties: alert_dashboard_panel: $ref: '#/definitions/JointResourceBaseDetails' type: object alert_dashboard_panel_GetPropertyDistinctFieldOutput: {} alert_dashboard_panel_GetPropertySplitableExportOutput: {} alert_dashboard_panel_GetPropertySplitableOutput: {} alert_dashboard_panel_ListItemFilterOutput: schema: properties: alert_dashboard_panels: items: $ref: '#/definitions/JointResourceBaseDetails' 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_dashboard_panel_PerformPurgeSplitableOutput: {} alert_dashboard_panel_ValidateCreateDataOutput: schema: properties: alert_dashboard_panel: $ref: '#/definitions/JointResourceBaseDetails' type: object alert_dashboard_panel_ValidateUpdateDataOutput: schema: properties: alert_dashboard_panel: $ref: '#/definitions/JointResourceBaseDetails' type: object alert_notification_CustomizeDeleteOutput: schema: properties: alert_notification: $ref: '#/definitions/VirtualResourceDetails' type: object alert_notification_FetchCustomizeColumnsOutput: schema: properties: alert_notification: $ref: '#/definitions/VirtualResourceDetails' type: object alert_notification_GetDetailsChangeOwnerCandidateDomainsOutput: schema: properties: alert_notification: $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' type: object alert_notification_GetDetailsClassMetadataOutput: schema: properties: alert_notification: additionalProperties: type: string type: object x-go-name: Output type: object alert_notification_GetDetailsMetadataOutput: schema: properties: alert_notification: additionalProperties: type: string type: object x-go-name: Output type: object alert_notification_GetDetailsStatusOutput: schema: properties: alert_notification: $ref: '#/definitions/GetDetailsStatusOutput' type: object alert_notification_GetPropertyDistinctFieldOutput: {} alert_notification_GetPropertyDomainStatisticsOutput: schema: properties: alert_notification: items: $ref: '#/definitions/ProjectStatistic' type: array x-go-name: Output type: object alert_notification_GetPropertyProjectStatisticsOutput: schema: properties: alert_notification: items: $ref: '#/definitions/ProjectStatistic' type: array x-go-name: Output type: object alert_notification_GetPropertyProjectTagValuePairsOutput: {} alert_notification_GetPropertyProjectTagValueTreeOutput: {} alert_notification_GetPropertySplitableExportOutput: {} alert_notification_GetPropertySplitableOutput: {} alert_notification_GetPropertyStatisticsOutput: schema: properties: alert_notification: $ref: '#/definitions/StatusStatistic' type: object alert_notification_GetPropertyTagValuePairsOutput: {} alert_notification_GetPropertyTagValueTreeOutput: {} alert_notification_ListItemFilterOutput: 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_PerformCancelDeleteOutput: {} alert_notification_PerformChangeOwnerOutput: {} alert_notification_PerformClassMetadataOutput: {} alert_notification_PerformFreezeOutput: {} alert_notification_PerformPurgeSplitableOutput: {} alert_notification_PerformSetClassMetadataOutput: {} alert_notification_PerformSetUserMetadataOutput: {} alert_notification_PerformStatusOutput: {} alert_notification_PerformUnfreezeOutput: {} alert_notification_ValidateCreateDataOutput: schema: properties: alert_notification: $ref: '#/definitions/VirtualResourceDetails' type: object alert_notification_ValidateUpdateDataOutput: schema: properties: alert_notification: $ref: '#/definitions/VirtualResourceDetails' type: object alert_panel_CustomizeDeleteOutput: schema: properties: alert_panel: $ref: '#/definitions/PanelDetails' type: object alert_panel_FetchCustomizeColumnsOutput: schema: properties: alert_panel: $ref: '#/definitions/PanelDetails' type: object alert_panel_GetDetailsClassMetadataOutput: schema: properties: alert_panel: additionalProperties: type: string type: object x-go-name: Output type: object alert_panel_GetDetailsMetadataOutput: schema: properties: alert_panel: additionalProperties: type: string type: object x-go-name: Output type: object alert_panel_GetDetailsStatusOutput: schema: properties: alert_panel: $ref: '#/definitions/GetDetailsStatusOutput' type: object alert_panel_GetPropertyDistinctFieldOutput: {} alert_panel_GetPropertySplitableExportOutput: {} alert_panel_GetPropertySplitableOutput: {} alert_panel_GetPropertyStatisticsOutput: schema: properties: alert_panel: $ref: '#/definitions/StatusStatistic' type: object alert_panel_GetPropertyTagValuePairsOutput: {} alert_panel_GetPropertyTagValueTreeOutput: {} alert_panel_ListItemFilterOutput: schema: properties: alert_panels: 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 alert_panel_PerformClassMetadataOutput: {} alert_panel_PerformPurgeSplitableOutput: {} alert_panel_PerformSetClassMetadataOutput: {} alert_panel_PerformSetUserMetadataOutput: {} alert_panel_PerformStatusOutput: {} alert_panel_ValidateCreateDataOutput: schema: properties: alert_panel: $ref: '#/definitions/PanelDetails' type: object alert_panel_ValidateUpdateDataOutput: schema: properties: alert_panel: $ref: '#/definitions/PanelDetails' type: object alert_record_CustomizeDeleteOutput: schema: properties: alert_record: $ref: '#/definitions/AlertRecordDetails' type: object alert_record_FetchCustomizeColumnsOutput: schema: properties: alert_record: $ref: '#/definitions/AlertRecordDetails' type: object alert_record_GetDetailsClassMetadataOutput: schema: properties: alert_record: additionalProperties: type: string type: object x-go-name: Output type: object alert_record_GetDetailsMetadataOutput: schema: properties: alert_record: additionalProperties: type: string type: object x-go-name: Output type: object alert_record_GetDetailsStatusOutput: schema: properties: alert_record: $ref: '#/definitions/GetDetailsStatusOutput' type: object alert_record_GetPropertyDistinctFieldOutput: {} alert_record_GetPropertySplitableExportOutput: {} alert_record_GetPropertySplitableOutput: {} alert_record_GetPropertyStatisticsOutput: schema: properties: alert_record: $ref: '#/definitions/StatusStatistic' type: object alert_record_GetPropertyTagValuePairsOutput: {} alert_record_GetPropertyTagValueTreeOutput: {} alert_record_GetPropertyTotalAlertOutput: {} alert_record_ListItemFilterOutput: schema: properties: alert_records: 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 alert_record_PerformClassMetadataOutput: {} alert_record_PerformPurgeSplitableOutput: {} alert_record_PerformSetClassMetadataOutput: {} alert_record_PerformSetUserMetadataOutput: {} alert_record_PerformStatusOutput: {} alert_record_ValidateCreateDataOutput: schema: properties: alert_record: $ref: '#/definitions/AlertRecordDetails' type: object alert_record_ValidateUpdateDataOutput: schema: properties: alert_record: $ref: '#/definitions/AlertRecordDetails' type: object alert_record_shield_CustomizeDeleteOutput: schema: properties: alert_record_shield: $ref: '#/definitions/AlertRecordShieldDetails' type: object alert_record_shield_FetchCustomizeColumnsOutput: schema: properties: alert_record_shield: $ref: '#/definitions/AlertRecordShieldDetails' type: object alert_record_shield_GetDetailsClassMetadataOutput: schema: properties: alert_record_shield: additionalProperties: type: string type: object x-go-name: Output type: object alert_record_shield_GetDetailsMetadataOutput: schema: properties: alert_record_shield: additionalProperties: type: string type: object x-go-name: Output type: object alert_record_shield_GetDetailsStatusOutput: schema: properties: alert_record_shield: $ref: '#/definitions/GetDetailsStatusOutput' type: object alert_record_shield_GetPropertyDistinctFieldOutput: {} alert_record_shield_GetPropertySplitableExportOutput: {} alert_record_shield_GetPropertySplitableOutput: {} alert_record_shield_GetPropertyStatisticsOutput: schema: properties: alert_record_shield: $ref: '#/definitions/StatusStatistic' type: object alert_record_shield_GetPropertyTagValuePairsOutput: {} alert_record_shield_GetPropertyTagValueTreeOutput: {} alert_record_shield_ListItemFilterOutput: schema: properties: alert_record_shields: 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 alert_record_shield_PerformClassMetadataOutput: {} alert_record_shield_PerformPurgeSplitableOutput: {} alert_record_shield_PerformSetClassMetadataOutput: {} alert_record_shield_PerformSetUserMetadataOutput: {} alert_record_shield_PerformStatusOutput: {} alert_record_shield_ValidateCreateDataOutput: schema: properties: alert_record_shield: $ref: '#/definitions/AlertRecordShieldDetails' type: object alert_record_shield_ValidateUpdateDataOutput: schema: properties: alert_record_shield: $ref: '#/definitions/AlertRecordShieldDetails' type: object alert_resource_CustomizeDeleteOutput: schema: properties: alert_resource: $ref: '#/definitions/AlertResourceDetails' type: object alert_resource_FetchCustomizeColumnsOutput: schema: properties: alert_resource: $ref: '#/definitions/AlertResourceDetails' type: object alert_resource_GetDetailsClassMetadataOutput: schema: properties: alert_resource: additionalProperties: type: string type: object x-go-name: Output type: object alert_resource_GetDetailsMetadataOutput: schema: properties: alert_resource: additionalProperties: type: string type: object x-go-name: Output type: object alert_resource_GetPropertyDistinctFieldOutput: {} alert_resource_GetPropertySplitableExportOutput: {} alert_resource_GetPropertySplitableOutput: {} alert_resource_GetPropertyTagValuePairsOutput: {} alert_resource_GetPropertyTagValueTreeOutput: {} alert_resource_ListItemFilterOutput: schema: properties: alert_resources: 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 alert_resource_PerformClassMetadataOutput: {} alert_resource_PerformPurgeSplitableOutput: {} alert_resource_PerformSetClassMetadataOutput: {} alert_resource_PerformSetUserMetadataOutput: {} alert_resource_ValidateCreateDataOutput: schema: properties: alert_resource: $ref: '#/definitions/AlertResourceDetails' type: object alert_resource_ValidateUpdateDataOutput: schema: properties: alert_resource: $ref: '#/definitions/AlertResourceDetails' type: object alert_resource_alert_CustomizeDeleteOutput: {} alert_resource_alert_FetchCustomizeColumnsOutput: {} alert_resource_alert_GetPropertyDistinctFieldOutput: {} alert_resource_alert_GetPropertySplitableExportOutput: {} alert_resource_alert_GetPropertySplitableOutput: {} alert_resource_alert_ListItemFilterOutput: {} alert_resource_alert_PerformPurgeSplitableOutput: {} alert_resource_alert_ValidateCreateDataOutput: {} alert_resource_alert_ValidateUpdateDataOutput: {} common_alert_CustomizeDeleteOutput: schema: properties: common_alert: $ref: '#/definitions/CommonAlertDetails' type: object common_alert_FetchCustomizeColumnsOutput: schema: properties: common_alert: $ref: '#/definitions/CommonAlertDetails' type: object common_alert_GetDetailsClassMetadataOutput: schema: properties: common_alert: additionalProperties: type: string type: object x-go-name: Output type: object common_alert_GetDetailsMetadataOutput: schema: properties: common_alert: additionalProperties: type: string type: object x-go-name: Output type: object common_alert_GetDetailsStatusOutput: schema: properties: common_alert: $ref: '#/definitions/GetDetailsStatusOutput' type: object common_alert_GetPropertyDistinctFieldOutput: {} common_alert_GetPropertySplitableExportOutput: {} common_alert_GetPropertySplitableOutput: {} common_alert_GetPropertyStatisticsOutput: schema: properties: common_alert: $ref: '#/definitions/StatusStatistic' type: object common_alert_GetPropertyTagValuePairsOutput: {} common_alert_GetPropertyTagValueTreeOutput: {} common_alert_ListItemFilterOutput: schema: properties: common_alerts: 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 common_alert_PerformClassMetadataOutput: {} common_alert_PerformConfigOutput: {} common_alert_PerformDisableOutput: {} common_alert_PerformEnableOutput: {} common_alert_PerformPauseOutput: {} common_alert_PerformPurgeSplitableOutput: {} common_alert_PerformSetClassMetadataOutput: {} common_alert_PerformSetScopeOutput: {} common_alert_PerformSetUserMetadataOutput: {} common_alert_PerformStatusOutput: {} common_alert_PerformTestRunOutput: schema: properties: common_alert: $ref: '#/definitions/AlertTestRunOutput' type: object common_alert_ValidateCreateDataOutput: schema: properties: common_alert: $ref: '#/definitions/CommonAlertDetails' type: object common_alert_ValidateUpdateDataOutput: schema: properties: common_alert: $ref: '#/definitions/CommonAlertDetails' type: object data_source_CustomizeDeleteOutput: schema: properties: data_source: $ref: '#/definitions/StandaloneResourceDetails' type: object data_source_FetchCustomizeColumnsOutput: schema: properties: data_source: $ref: '#/definitions/StandaloneResourceDetails' type: object data_source_GetDetailsClassMetadataOutput: schema: properties: data_source: additionalProperties: type: string type: object x-go-name: Output type: object data_source_GetDetailsMetadataOutput: schema: properties: data_source: additionalProperties: type: string type: object x-go-name: Output type: object data_source_GetPropertyDistinctFieldOutput: {} data_source_GetPropertySplitableExportOutput: {} data_source_GetPropertySplitableOutput: {} data_source_GetPropertyTagValuePairsOutput: {} data_source_GetPropertyTagValueTreeOutput: {} data_source_ListItemFilterOutput: schema: properties: data_sources: 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 data_source_PerformClassMetadataOutput: {} data_source_PerformPurgeSplitableOutput: {} data_source_PerformSetClassMetadataOutput: {} data_source_PerformSetUserMetadataOutput: {} data_source_ValidateCreateDataOutput: schema: properties: data_source: $ref: '#/definitions/StandaloneResourceDetails' type: object data_source_ValidateUpdateDataOutput: schema: properties: data_source: $ref: '#/definitions/StandaloneResourceDetails' type: object meter_alert_CustomizeDeleteOutput: schema: properties: meter_alert: $ref: '#/definitions/MeterAlertDetails' type: object meter_alert_FetchCustomizeColumnsOutput: schema: properties: meter_alert: $ref: '#/definitions/MeterAlertDetails' type: object meter_alert_GetDetailsClassMetadataOutput: schema: properties: meter_alert: additionalProperties: type: string type: object x-go-name: Output type: object meter_alert_GetDetailsMetadataOutput: schema: properties: meter_alert: additionalProperties: type: string type: object x-go-name: Output type: object meter_alert_GetDetailsStatusOutput: schema: properties: meter_alert: $ref: '#/definitions/GetDetailsStatusOutput' type: object meter_alert_GetPropertyDistinctFieldOutput: {} meter_alert_GetPropertySplitableExportOutput: {} meter_alert_GetPropertySplitableOutput: {} meter_alert_GetPropertyStatisticsOutput: schema: properties: meter_alert: $ref: '#/definitions/StatusStatistic' type: object meter_alert_GetPropertyTagValuePairsOutput: {} meter_alert_GetPropertyTagValueTreeOutput: {} meter_alert_ListItemFilterOutput: schema: properties: limit: format: int64 type: integer x-go-name: Limit meter_alerts: items: $ref: '#/definitions/MeterAlertDetails' 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 meter_alert_PerformClassMetadataOutput: {} meter_alert_PerformDisableOutput: {} meter_alert_PerformEnableOutput: {} meter_alert_PerformPauseOutput: {} meter_alert_PerformPurgeSplitableOutput: {} meter_alert_PerformSetClassMetadataOutput: {} meter_alert_PerformSetUserMetadataOutput: {} meter_alert_PerformStatusOutput: {} meter_alert_PerformTestRunOutput: schema: properties: meter_alert: $ref: '#/definitions/AlertTestRunOutput' type: object meter_alert_ValidateCreateDataOutput: schema: properties: meter_alert: $ref: '#/definitions/MeterAlertDetails' type: object meter_alert_ValidateUpdateDataOutput: schema: properties: meter_alert: $ref: '#/definitions/MeterAlertDetails' type: object metric_CustomizeDeleteOutput: schema: properties: metric: $ref: '#/definitions/JointResourceBaseDetails' type: object metric_FetchCustomizeColumnsOutput: schema: properties: metric: $ref: '#/definitions/JointResourceBaseDetails' type: object metric_GetPropertyDistinctFieldOutput: {} metric_GetPropertySplitableExportOutput: {} metric_GetPropertySplitableOutput: {} metric_ListItemFilterOutput: 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_PerformPurgeSplitableOutput: {} metric_ValidateCreateDataOutput: schema: properties: metric: $ref: '#/definitions/JointResourceBaseDetails' type: object metric_ValidateUpdateDataOutput: schema: properties: metric: $ref: '#/definitions/JointResourceBaseDetails' type: object metric_field_CustomizeDeleteOutput: schema: properties: metric_field: $ref: '#/definitions/MetricFieldDetail' type: object metric_field_FetchCustomizeColumnsOutput: schema: properties: metric_field: $ref: '#/definitions/MetricFieldDetail' type: object metric_field_GetDetailsClassMetadataOutput: schema: properties: metric_field: additionalProperties: type: string type: object x-go-name: Output type: object metric_field_GetDetailsMetadataOutput: schema: properties: metric_field: additionalProperties: type: string type: object x-go-name: Output type: object metric_field_GetDetailsStatusOutput: schema: properties: metric_field: $ref: '#/definitions/GetDetailsStatusOutput' type: object metric_field_GetPropertyDistinctFieldOutput: {} metric_field_GetPropertySplitableExportOutput: {} metric_field_GetPropertySplitableOutput: {} metric_field_GetPropertyStatisticsOutput: schema: properties: metric_field: $ref: '#/definitions/StatusStatistic' type: object metric_field_GetPropertyTagValuePairsOutput: {} metric_field_GetPropertyTagValueTreeOutput: {} metric_field_ListItemFilterOutput: schema: properties: limit: format: int64 type: integer x-go-name: Limit metric_fields: 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 metric_field_PerformClassMetadataOutput: {} metric_field_PerformPurgeSplitableOutput: {} metric_field_PerformSetClassMetadataOutput: {} metric_field_PerformSetUserMetadataOutput: {} metric_field_PerformStatusOutput: {} metric_field_ValidateCreateDataOutput: schema: properties: metric_field: $ref: '#/definitions/MetricFieldDetail' type: object metric_field_ValidateUpdateDataOutput: schema: properties: metric_field: $ref: '#/definitions/MetricFieldDetail' type: object metric_measurement_CustomizeDeleteOutput: schema: properties: metric_measurement: $ref: '#/definitions/MetricDetails' type: object metric_measurement_FetchCustomizeColumnsOutput: schema: properties: metric_measurement: $ref: '#/definitions/MetricDetails' type: object metric_measurement_GetDetailsClassMetadataOutput: schema: properties: metric_measurement: additionalProperties: type: string type: object x-go-name: Output type: object metric_measurement_GetDetailsMetadataOutput: schema: properties: metric_measurement: additionalProperties: type: string type: object x-go-name: Output type: object metric_measurement_GetDetailsStatusOutput: schema: properties: metric_measurement: $ref: '#/definitions/GetDetailsStatusOutput' type: object metric_measurement_GetPropertyDistinctFieldOutput: {} metric_measurement_GetPropertySplitableExportOutput: {} metric_measurement_GetPropertySplitableOutput: {} metric_measurement_GetPropertyStatisticsOutput: schema: properties: metric_measurement: $ref: '#/definitions/StatusStatistic' type: object metric_measurement_GetPropertyTagValuePairsOutput: {} metric_measurement_GetPropertyTagValueTreeOutput: {} metric_measurement_ListItemFilterOutput: schema: properties: limit: format: int64 type: integer x-go-name: Limit metric_measurements: 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 metric_measurement_PerformClassMetadataOutput: {} metric_measurement_PerformPurgeSplitableOutput: {} metric_measurement_PerformSetClassMetadataOutput: {} metric_measurement_PerformSetUserMetadataOutput: {} metric_measurement_PerformStatusOutput: {} metric_measurement_ValidateCreateDataOutput: schema: properties: metric_measurement: $ref: '#/definitions/MetricDetails' type: object metric_measurement_ValidateUpdateDataOutput: schema: properties: metric_measurement: $ref: '#/definitions/MetricDetails' type: object migration_alert_CustomizeDeleteOutput: schema: properties: migration_alert: $ref: '#/definitions/AlertDetails' type: object migration_alert_FetchCustomizeColumnsOutput: schema: properties: migration_alert: $ref: '#/definitions/AlertDetails' type: object migration_alert_GetDetailsClassMetadataOutput: schema: properties: migration_alert: additionalProperties: type: string type: object x-go-name: Output type: object migration_alert_GetDetailsMetadataOutput: schema: properties: migration_alert: additionalProperties: type: string type: object x-go-name: Output type: object migration_alert_GetDetailsStatusOutput: schema: properties: migration_alert: $ref: '#/definitions/GetDetailsStatusOutput' type: object migration_alert_GetPropertyDistinctFieldOutput: {} migration_alert_GetPropertySplitableExportOutput: {} migration_alert_GetPropertySplitableOutput: {} migration_alert_GetPropertyStatisticsOutput: schema: properties: migration_alert: $ref: '#/definitions/StatusStatistic' type: object migration_alert_GetPropertyTagValuePairsOutput: {} migration_alert_GetPropertyTagValueTreeOutput: {} migration_alert_ListItemFilterOutput: schema: properties: limit: format: int64 type: integer x-go-name: Limit migration_alerts: 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 migration_alert_PerformClassMetadataOutput: {} migration_alert_PerformDisableOutput: {} migration_alert_PerformEnableOutput: {} migration_alert_PerformPauseOutput: {} migration_alert_PerformPurgeSplitableOutput: {} migration_alert_PerformSetClassMetadataOutput: {} migration_alert_PerformSetUserMetadataOutput: {} migration_alert_PerformStatusOutput: {} migration_alert_PerformTestRunOutput: schema: properties: migration_alert: $ref: '#/definitions/AlertTestRunOutput' type: object migration_alert_ValidateCreateDataOutput: schema: properties: migration_alert: $ref: '#/definitions/AlertDetails' type: object migration_alert_ValidateUpdateDataOutput: schema: properties: migration_alert: $ref: '#/definitions/AlertDetails' type: object monitor_resource_CustomizeDeleteOutput: schema: properties: monitor_resource: $ref: '#/definitions/MonitorResourceDetails' type: object monitor_resource_FetchCustomizeColumnsOutput: schema: properties: monitor_resource: $ref: '#/definitions/MonitorResourceDetails' type: object monitor_resource_GetDetailsChangeOwnerCandidateDomainsOutput: schema: properties: monitor_resource: $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' type: object monitor_resource_GetDetailsClassMetadataOutput: schema: properties: monitor_resource: additionalProperties: type: string type: object x-go-name: Output type: object monitor_resource_GetDetailsMetadataOutput: schema: properties: monitor_resource: additionalProperties: type: string type: object x-go-name: Output type: object monitor_resource_GetDetailsStatusOutput: schema: properties: monitor_resource: $ref: '#/definitions/GetDetailsStatusOutput' type: object monitor_resource_GetPropertyAlertOutput: {} monitor_resource_GetPropertyDistinctFieldOutput: {} monitor_resource_GetPropertyDomainStatisticsOutput: schema: properties: monitor_resource: items: $ref: '#/definitions/ProjectStatistic' type: array x-go-name: Output type: object monitor_resource_GetPropertyProjectStatisticsOutput: schema: properties: monitor_resource: items: $ref: '#/definitions/ProjectStatistic' type: array x-go-name: Output type: object monitor_resource_GetPropertyProjectTagValuePairsOutput: {} monitor_resource_GetPropertyProjectTagValueTreeOutput: {} monitor_resource_GetPropertySplitableExportOutput: {} monitor_resource_GetPropertySplitableOutput: {} monitor_resource_GetPropertyStatisticsOutput: schema: properties: monitor_resource: $ref: '#/definitions/StatusStatistic' type: object monitor_resource_GetPropertyTagValuePairsOutput: {} monitor_resource_GetPropertyTagValueTreeOutput: {} monitor_resource_ListItemFilterOutput: schema: properties: limit: format: int64 type: integer x-go-name: Limit monitor_resources: 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 monitor_resource_PerformCancelDeleteOutput: {} monitor_resource_PerformChangeOwnerOutput: {} monitor_resource_PerformClassMetadataOutput: {} monitor_resource_PerformFreezeOutput: {} monitor_resource_PerformPurgeSplitableOutput: {} monitor_resource_PerformSetClassMetadataOutput: {} monitor_resource_PerformSetUserMetadataOutput: {} monitor_resource_PerformStatusOutput: {} monitor_resource_PerformUnfreezeOutput: {} monitor_resource_ValidateCreateDataOutput: schema: properties: monitor_resource: $ref: '#/definitions/MonitorResourceDetails' type: object monitor_resource_ValidateUpdateDataOutput: schema: properties: monitor_resource: $ref: '#/definitions/MonitorResourceDetails' type: object monitor_resource_alert_CustomizeDeleteOutput: schema: properties: monitor_resource_alert: $ref: '#/definitions/MonitorResourceJointDetails' type: object monitor_resource_alert_FetchCustomizeColumnsOutput: schema: properties: monitor_resource_alert: $ref: '#/definitions/MonitorResourceJointDetails' type: object monitor_resource_alert_GetPropertyDistinctFieldOutput: {} monitor_resource_alert_GetPropertySplitableExportOutput: {} monitor_resource_alert_GetPropertySplitableOutput: {} monitor_resource_alert_ListItemFilterOutput: schema: properties: limit: format: int64 type: integer x-go-name: Limit monitor_resource_alerts: 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 monitor_resource_alert_PerformPurgeSplitableOutput: {} monitor_resource_alert_ValidateCreateDataOutput: schema: properties: monitor_resource_alert: $ref: '#/definitions/MonitorResourceJointDetails' type: object monitor_resource_alert_ValidateUpdateDataOutput: schema: properties: monitor_resource_alert: $ref: '#/definitions/MonitorResourceJointDetails' type: object node_alert_CustomizeDeleteOutput: schema: properties: node_alert: $ref: '#/definitions/NodeAlertDetails' type: object node_alert_FetchCustomizeColumnsOutput: schema: properties: node_alert: $ref: '#/definitions/NodeAlertDetails' type: object node_alert_GetDetailsClassMetadataOutput: schema: properties: node_alert: additionalProperties: type: string type: object x-go-name: Output type: object node_alert_GetDetailsMetadataOutput: schema: properties: node_alert: additionalProperties: type: string type: object x-go-name: Output type: object node_alert_GetDetailsStatusOutput: schema: properties: node_alert: $ref: '#/definitions/GetDetailsStatusOutput' type: object node_alert_GetPropertyDistinctFieldOutput: {} node_alert_GetPropertySplitableExportOutput: {} node_alert_GetPropertySplitableOutput: {} node_alert_GetPropertyStatisticsOutput: schema: properties: node_alert: $ref: '#/definitions/StatusStatistic' type: object node_alert_GetPropertyTagValuePairsOutput: {} node_alert_GetPropertyTagValueTreeOutput: {} node_alert_ListItemFilterOutput: schema: properties: limit: format: int64 type: integer x-go-name: Limit node_alerts: 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 node_alert_PerformClassMetadataOutput: {} node_alert_PerformConfigOutput: {} node_alert_PerformDisableOutput: {} node_alert_PerformEnableOutput: {} node_alert_PerformPauseOutput: {} node_alert_PerformPurgeSplitableOutput: {} node_alert_PerformSetClassMetadataOutput: {} node_alert_PerformSetScopeOutput: {} node_alert_PerformSetUserMetadataOutput: {} node_alert_PerformStatusOutput: {} node_alert_PerformTestRunOutput: schema: properties: node_alert: $ref: '#/definitions/AlertTestRunOutput' type: object node_alert_ValidateCreateDataOutput: schema: properties: node_alert: $ref: '#/definitions/NodeAlertDetails' type: object node_alert_ValidateUpdateDataOutput: schema: properties: node_alert: $ref: '#/definitions/NodeAlertDetails' type: object v1_alert_CustomizeDeleteOutput: schema: properties: v1_alert: $ref: '#/definitions/AlertV1Details' type: object v1_alert_FetchCustomizeColumnsOutput: schema: properties: v1_alert: $ref: '#/definitions/AlertV1Details' type: object v1_alert_GetDetailsClassMetadataOutput: schema: properties: v1_alert: additionalProperties: type: string type: object x-go-name: Output type: object v1_alert_GetDetailsMetadataOutput: schema: properties: v1_alert: additionalProperties: type: string type: object x-go-name: Output type: object v1_alert_GetDetailsStatusOutput: schema: properties: v1_alert: $ref: '#/definitions/GetDetailsStatusOutput' type: object v1_alert_GetPropertyDistinctFieldOutput: {} v1_alert_GetPropertySplitableExportOutput: {} v1_alert_GetPropertySplitableOutput: {} v1_alert_GetPropertyStatisticsOutput: schema: properties: v1_alert: $ref: '#/definitions/StatusStatistic' type: object v1_alert_GetPropertyTagValuePairsOutput: {} v1_alert_GetPropertyTagValueTreeOutput: {} v1_alert_ListItemFilterOutput: schema: properties: 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 v1_alerts: items: $ref: '#/definitions/AlertV1Details' type: array x-go-name: Output type: object v1_alert_PerformClassMetadataOutput: {} v1_alert_PerformDisableOutput: {} v1_alert_PerformEnableOutput: {} v1_alert_PerformPauseOutput: {} v1_alert_PerformPurgeSplitableOutput: {} v1_alert_PerformSetClassMetadataOutput: {} v1_alert_PerformSetUserMetadataOutput: {} v1_alert_PerformStatusOutput: {} v1_alert_PerformTestRunOutput: schema: properties: v1_alert: $ref: '#/definitions/AlertTestRunOutput' type: object v1_alert_ValidateCreateDataOutput: schema: properties: v1_alert: $ref: '#/definitions/AlertV1Details' type: object v1_alert_ValidateUpdateDataOutput: schema: properties: v1_alert: $ref: '#/definitions/AlertV1Details' type: object schemes: - https - http securityDefinitions: keystone: in: header name: X-Auth-Token type: apiKey swagger: "2.0"