service

func (*APIServer) DeprecatedBy ¶

func (s *APIServer) DeprecatedBy(version string) func(echo.Context) error

DeprecatedBy is a controller used to mark deprecated and used to replace the original controller.

func (*APIServer) RunHttpServer ¶

func (s *APIServer) RunHttpServer(logger utilLog.Logger) error

func (*APIServer) Shutdown ¶

func (s *APIServer) Shutdown() error

func (*DMSController) ActivateUnmaskingWorkflowView ¶

func (ctl *DMSController) ActivateUnmaskingWorkflowView(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/unmasking-workflows/{workflow_id}/activate Masking ActivateUnmaskingWorkflowView

Activate plaintext view window for applicant.

--- parameters:

• name: project_uid in: path required: true type: string
• name: workflow_id in: path required: true type: string

responses:

'200':
  schema:
    "$ref": "#/definitions/ActivateUnmaskingWorkflowViewReply"
default:
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddDBService ¶

func (ctl *DMSController) AddDBService(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/db_services DBService AddDBService

Add DB Service.

--- deprecated: true parameters:

• name: project_uid description: project id in: path required: true type: string
• name: db_service description: Add new db service in: body required: true schema: "$ref": "#/definitions/AddDBServiceReq"

responses:

'200':
  description: AddDBServiceReply
  schema:
    "$ref": "#/definitions/AddDBServiceReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddDBServiceSyncTask ¶

func (ctl *DMSController) AddDBServiceSyncTask(c echo.Context) error

swagger:operation POST /v1/dms/db_service_sync_tasks DBServiceSyncTask AddDBServiceSyncTask

Add database synchronization task.

--- parameters:

• name: db_service_sync_task description: Add new db service sync task in: body required: true schema: "$ref": "#/definitions/AddDBServiceSyncTaskReq"

responses:

'200':
  description: AddDBServiceReply
  schema:
    "$ref": "#/definitions/AddDBServiceReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddDBServiceV2 ¶

func (ctl *DMSController) AddDBServiceV2(c echo.Context) error

swagger:operation POST /v2/dms/projects/{project_uid}/db_services DBService AddDBServiceV2

Add DB Service.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: db_service description: Add new db service in: body required: true schema: "$ref": "#/definitions/AddDBServiceReqV2"

responses:

'200':
  description: AddDBServiceReply
  schema:
    "$ref": "#/definitions/AddDBServiceReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddDataExportTask ¶

func (ctl *DMSController) AddDataExportTask(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/data_export_tasks DataExportTask AddDataExportTask

Add data_export task.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: data_export_tasks description: add data export workflow in: body schema: "$ref": "#/definitions/AddDataExportTaskReq"

responses:

'200':
  description: AddDataExportTaskReply
  schema:
    "$ref": "#/definitions/AddDataExportTaskReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddDataExportWorkflow ¶

func (ctl *DMSController) AddDataExportWorkflow(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/data_export_workflows DataExportWorkflows AddDataExportWorkflow

Add data_export workflow.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: data_export_workflow description: add data export workflow in: body schema: "$ref": "#/definitions/AddDataExportWorkflowReq"

responses:

'200':
  description: AddDataExportWorkflowReply
  schema:
    "$ref": "#/definitions/AddDataExportWorkflowReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddGateway ¶

func (ctl *DMSController) AddGateway(c echo.Context) error

swagger:operation POST /v1/dms/gateways Gateway AddGateway

Add gateways.

--- parameters:

• name: add_gateway description: add gateway in: body required: true schema: "$ref": "#/definitions/AddGatewayReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddMaskingRule ¶

func (ctl *DMSController) AddMaskingRule(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/rules Masking AddMaskingRule

新增脱敏规则。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: rule description: 脱敏规则信息 in: body required: true schema: "$ref": "#/definitions/AddMaskingRuleReq"

responses:

'200':
  description: 成功新增脱敏规则
  schema:
    "$ref": "#/definitions/AddMaskingRuleReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddMaskingTemplate ¶

func (ctl *DMSController) AddMaskingTemplate(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/templates Masking AddMaskingTemplate

新增脱敏模板。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: masking_template description: 脱敏模板信息 in: body required: true schema: "$ref": "#/definitions/AddMaskingTemplateReq"

responses:

'200':
  description: 成功新增脱敏模板
  schema:
    "$ref": "#/definitions/AddMaskingTemplateReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddMember ¶

func (ctl *DMSController) AddMember(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/members Member AddMember

Add member.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: member description: Add new member in: body required: true schema: "$ref": "#/definitions/AddMemberReq"

responses:

'200':
  description: AddMemberReply
  schema:
    "$ref": "#/definitions/AddMemberReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddMemberGroup ¶

func (ctl *DMSController) AddMemberGroup(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/member_groups MemberGroup AddMemberGroup

Add member group.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: member_group description: Add new member group in: body required: true schema: "$ref": "#/definitions/AddMemberGroupReq"

responses:

'200':
  description: AddMemberGroupReply
  schema:
    "$ref": "#/definitions/AddMemberGroupReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddOperationRecord ¶

func (ctl *DMSController) AddOperationRecord(c echo.Context) error

swagger:operation POST /v1/dms/operation_records OperationRecord AddOperationRecord

Add operation record.

--- parameters:

• name: operation_record in: body required: true description: Add new operation record schema: "$ref": "#/definitions/AddOperationRecordReq"

responses:

'200':
  description: AddOperationRecordReply
  schema:
    "$ref": "#/definitions/AddOperationRecordReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddProject ¶

func (ctl *DMSController) AddProject(c echo.Context) error

swagger:operation POST /v1/dms/projects Project AddProject

Add project.

--- deprecated: true parameters:

• name: project description: Add new Project in: body required: true schema: "$ref": "#/definitions/AddProjectReq"

responses:

'200':
  description: AddProjectReply
  schema:
    "$ref": "#/definitions/AddProjectReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddProjectV2 ¶

func (ctl *DMSController) AddProjectV2(c echo.Context) error

swagger:operation POST /v2/dms/projects Project AddProjectV2

Add project.

--- parameters:

• name: project description: Add new Project in: body required: true schema: "$ref": "#/definitions/AddProjectReqV2"

responses:

'200':
  description: AddProjectReplyV2
  schema:
    "$ref": "#/definitions/AddProjectReplyV2"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddRole ¶

func (ctl *DMSController) AddRole(c echo.Context) error

swagger:operation POST /v1/dms/roles Role AddRole

Add role.

--- parameters:

• name: role description: Add new role in: body required: true schema: "$ref": "#/definitions/AddRoleReq"

responses:

'200':
  description: AddRoleReply
  schema:
    "$ref": "#/definitions/AddRoleReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddSensitiveDataDiscoveryTask ¶

func (ctl *DMSController) AddSensitiveDataDiscoveryTask(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/sensitive-data-discovery-tasks Masking AddSensitiveDataDiscoveryTask

新增敏感数据发现任务。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: task description: 敏感数据发现任务信息 in: body required: true schema: "$ref": "#/definitions/AddSensitiveDataDiscoveryTaskReq"

responses:

'200':
  description: 成功新增敏感数据发现任务
  schema:
    "$ref": "#/definitions/AddSensitiveDataDiscoveryTaskReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddSensitiveDataType ¶

func (ctl *DMSController) AddSensitiveDataType(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/sensitive-types Masking AddSensitiveDataType

创建自定义敏感数据类型（不创建脱敏规则）。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: body description: 敏感数据类型定义 in: body required: true schema: "$ref": "#/definitions/AddSensitiveDataTypeReq"

responses:

'200':
  description: 成功创建敏感数据类型
  schema:
    "$ref": "#/definitions/AddSensitiveDataTypeReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddSession ¶

func (ctl *DMSController) AddSession(c echo.Context) error

swagger:operation POST /v1/dms/sessions Session AddSession

Add a session.

--- parameters:

• name: session in: body required: true description: Add a new session schema: "$ref": "#/definitions/AddSessionReq"

responses:

'200':
  description: AddSessionReply
  schema:
    "$ref": "#/definitions/AddSessionReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddUser ¶

func (ctl *DMSController) AddUser(c echo.Context) error

swagger:operation POST /v1/dms/users User AddUser

Add user.

--- parameters:

• name: user in: body required: true description: Add new user schema: "$ref": "#/definitions/AddUserReq"

responses:

'200':
  description: AddUserReply
  schema:
    "$ref": "#/definitions/AddUserReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) AddUserGroup ¶

func (ctl *DMSController) AddUserGroup(c echo.Context) error

swagger:operation POST /v1/dms/user_groups UserGroup AddUserGroup

Add user group.

--- parameters:

• name: user_group description: Add new user group in: body required: true schema: "$ref": "#/definitions/AddUserGroupReq"

responses:

'200':
  description: AddUserGroupReply
  schema:
    "$ref": "#/definitions/AddUserGroupReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ApproveDataExportWorkflow ¶

func (ctl *DMSController) ApproveDataExportWorkflow(c echo.Context) error

swagger:route POST /v1/dms/projects/{project_uid}/data_export_workflows/{data_export_workflow_uid}/approve DataExportWorkflows ApproveDataExportWorkflow

Approve data_export workflow.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) ApproveUnmaskingWorkflow ¶

func (ctl *DMSController) ApproveUnmaskingWorkflow(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/unmasking-workflows/{workflow_id}/approve Masking ApproveUnmaskingWorkflow

Approve unmasking workflow.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: workflow_id description: workflow id in: path required: true type: string
• name: approve_unmasking_workflow description: approve unmasking workflow info (optional, only carries approve_reason) in: body required: false schema: "$ref": "#/definitions/ApproveUnmaskingWorkflow"

responses:

'200':
  description: Approve unmasking workflow successfully
  schema:
    "$ref": "#/definitions/ApproveUnmaskingWorkflowReply"
default:
  description: Generic error response
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ArchiveProject ¶

func (ctl *DMSController) ArchiveProject(c echo.Context) error

swagger:route PUT /v1/dms/projects/{project_uid}/archive Project ArchiveProject

Archive a project.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) BackChannelLogout ¶

func (ctl *DMSController) BackChannelLogout(c echo.Context) error

BackChannelLogout is a hidden interface for third-party platform callbacks for logout event https://openid.net/specs/openid-connect-backchannel-1_0.html#BCRequest

func (*DMSController) BatchGetDataExportTask ¶

func (ctl *DMSController) BatchGetDataExportTask(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/data_export_tasks DataExportTask BatchGetDataExportTask

Batch get data_export task.

responses:
  200: body:BatchGetDataExportTaskReply
  default: body:GenericResp

func (*DMSController) BindOauth2User ¶

func (ctl *DMSController) BindOauth2User(c echo.Context) error

swagger:operation POST /v1/dms/oauth2/user/bind OAuth2 BindOauth2User

Bind Oauth2 User.

--- parameters:

• name: BindOauth2UserReq required: true in: body schema: "$ref": "#/definitions/BindOauth2UserReq"

responses:

'200':
  description: BindOauth2UserReply
  schema:
    "$ref": "#/definitions/BindOauth2UserReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) CancelDataExportWorkflow ¶

func (ctl *DMSController) CancelDataExportWorkflow(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/data_export_workflows/cancel DataExportWorkflows CancelDataExportWorkflow

Cancel data export workflows.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: payload required: true in: body schema: "$ref": "#/definitions/CancelDataExportWorkflowReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) CancelUnmaskingWorkflow ¶

func (ctl *DMSController) CancelUnmaskingWorkflow(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/unmasking-workflows/{workflow_id}/cancel Masking CancelUnmaskingWorkflow

Cancel unmasking workflow.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: workflow_id description: workflow id in: path required: true type: string

responses:

'200':
  description: Cancel unmasking workflow successfully
  schema:
    "$ref": "#/definitions/CancelUnmaskingWorkflowReply"
default:
  description: Generic error response
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) CheckDBServiceIsConnectable ¶

func (ctl *DMSController) CheckDBServiceIsConnectable(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/db_services/connection DBService CheckDBServiceIsConnectable

check if the db_service is connectable.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: db_service in: body description: check db_service is connectable schema: "$ref": "#/definitions/CheckDBServiceIsConnectableReq"

responses:

'200':
  description: CheckDBServiceIsConnectableReply
  schema:
    "$ref": "#/definitions/CheckDBServiceIsConnectableReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) CheckDBServiceIsConnectableById ¶

func (ctl *DMSController) CheckDBServiceIsConnectableById(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/db_services/{db_service_uid}/connection DBService CheckDBServiceIsConnectableById

check if the db_service is connectable.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: db_service_uid description: db service uid in: path required: true type: string

responses:

'200':
  description: CheckDBServiceIsConnectableReply
  schema:
    "$ref": "#/definitions/CheckDBServiceIsConnectableReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) CheckDBServicesPrivileges ¶

func (ctl *DMSController) CheckDBServicesPrivileges(c echo.Context) error

swagger:operation POST /v1/dms/projects/check_db_services_privileges Project CheckDBServicesPrivileges

check if the db_services hava enough privileges.

--- parameters:

• name: db_services in: body description: check db_services have enough privileges schema: "$ref": "#/definitions/CheckDBServicesPrivilegesReq"

responses:

'200':
  description: CheckDBServicesPrivilegesReply
  schema:
    "$ref": "#/definitions/CheckDBServicesPrivilegesReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) CheckGlobalDBServicesConnections ¶

func (ctl *DMSController) CheckGlobalDBServicesConnections(c echo.Context) error

swagger:operation POST /v1/dms/projects/db_services_connections Project CheckGlobalDBServicesConnections

check if the global db_services is connectable.

--- parameters:

• name: db_services description: check db_services is connectable in: body schema: "$ref": "#/definitions/DBServicesConnectionReq"

responses:

'200':
  description: DBServicesConnectionReqReply
  schema:
    "$ref": "#/definitions/DBServicesConnectionReqReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) CheckLicense ¶

func (ctl *DMSController) CheckLicense(c echo.Context) error

swagger:route POST /v1/dms/configurations/license/check Configuration CheckLicense

notify message.

 Consumes:
 - multipart/form-data

responses:
  200: body:CheckLicenseReply
  default: body:GenericResp

func (*DMSController) CheckProjectDBServicesConnections ¶

func (ctl *DMSController) CheckProjectDBServicesConnections(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/db_services/connections DBService CheckProjectDBServicesConnections

check if the project db_services is connectable.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: db_services description: check db_services is connectable in: body schema: "$ref": "#/definitions/CheckDBServicesIsConnectableReq"

responses:

'200':
  description: CheckDBServicesIsConnectableReply
  schema:
    "$ref": "#/definitions/CheckDBServicesIsConnectableReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ConfigureMaskingRules ¶

func (ctl *DMSController) ConfigureMaskingRules(c echo.Context) error

swagger:operation PUT /v1/dms/projects/{project_uid}/masking/rule-configs Masking ConfigureMaskingRules

批量配置脱敏规则。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: masking_rule_configs_req description: 批量创建或更新脱敏规则的配置 in: body required: true schema: "$ref": "#/definitions/ConfigureMaskingRulesReq"

responses:

'200':
  description: 成功批量配置脱敏规则
  schema:
    "$ref": "#/definitions/ConfigureMaskingRulesReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) CreateBusinessTag ¶

func (ctl *DMSController) CreateBusinessTag(c echo.Context) error

swagger:operation POST /v1/dms/projects/business_tags Project CreateBusinessTag

Create a new business tag.

--- parameters:

• name: business_tag description: business tag to be created in: body required: true schema: "$ref": "#/definitions/CreateBusinessTagReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) CreateEnvironmentTag ¶

func (ctl *DMSController) CreateEnvironmentTag(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/environment_tags Project CreateEnvironmentTag

Create a new environment tag.

--- parameters:

• name: project_uid description: project uid in: path required: true type: string
• name: environment_name description: the name of environment tag to be created in: body required: true type: string

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) CreateUnmaskingWorkflow ¶

func (ctl *DMSController) CreateUnmaskingWorkflow(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/unmasking-workflows Masking CreateUnmaskingWorkflow

Create unmasking workflow.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: unmasking_workflow description: unmasking workflow info in: body required: true schema: "$ref": "#/definitions/CreateUnmaskingWorkflowReq"

responses:

'200':
  description: Create unmasking workflow successfully
  schema:
    "$ref": "#/definitions/CreateUnmaskingWorkflowReply"
default:
  description: Generic error response
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) DBServicesConnection ¶

func (ctl *DMSController) DBServicesConnection(c echo.Context) error

todo 该接口已废弃 swagger:operation POST /v1/dms/projects/db_services_connection Project DBServicesConnection

DBServices Connection.

--- parameters:

• name: db_services description: check db_service is connectable in: body schema: "$ref": "#/definitions/DBServiceConnectionReq"

responses:

'200':
  description: DBServicesConnectionReply
  schema:
    "$ref": "#/definitions/DBServicesConnectionReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) DelDBService ¶

func (ctl *DMSController) DelDBService(c echo.Context) error

swagger:route DELETE /v1/dms/projects/{project_uid}/db_services/{db_service_uid} DBService DelDBService

Delete a DB Service.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) DelMember ¶

func (ctl *DMSController) DelMember(c echo.Context) error

swagger:route DELETE /v1/dms/projects/{project_uid}/members/{member_uid} Member DelMember

Delete a member.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) DelProject ¶

func (ctl *DMSController) DelProject(c echo.Context) error

swagger:route DELETE /v1/dms/projects/{project_uid} Project DelProject

Delete a project

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) DelRole ¶

func (ctl *DMSController) DelRole(c echo.Context) error

swagger:route DELETE /v1/dms/roles/{role_uid} Role DelRole

Delete a role.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) DelSession ¶

func (ctl *DMSController) DelSession(c echo.Context) error

swagger:route DELETE /v1/dms/sessions Session DelSession

del a session.

responses:
  200: body:DelSessionReply
  default: body:GenericResp

func (*DMSController) DelUser ¶

func (ctl *DMSController) DelUser(c echo.Context) error

swagger:route DELETE /v1/dms/users/{user_uid} User DelUser

Delete a user.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) DelUserGroup ¶

func (ctl *DMSController) DelUserGroup(c echo.Context) error

swagger:route DELETE /v1/dms/user_groups/{user_group_uid} UserGroup DelUserGroup

Delete a user group.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) DeleteBusinessTag ¶

func (ctl *DMSController) DeleteBusinessTag(c echo.Context) error

swagger:route DELETE /v1/dms/projects/business_tags/{business_tag_uid} Project DeleteBusinessTag

Delete an existing business tag.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) DeleteDBServiceSyncTask ¶

func (ctl *DMSController) DeleteDBServiceSyncTask(c echo.Context) error

swagger:operation DELETE /v1/dms/db_service_sync_tasks/{db_service_sync_task_uid} DBServiceSyncTask DeleteDBServiceSyncTask

Delete database synchronization task.

--- parameters:

• name: db_service_sync_task_uid description: db service sync task uid in: path required: true type: string

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) DeleteEnvironmentTag ¶

func (ctl *DMSController) DeleteEnvironmentTag(c echo.Context) error

swagger:route DELETE /v1/dms/projects/{project_uid}/environment_tags/{environment_tag_uid} Project DeleteEnvironmentTag

Delete an existing environment tag.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) DeleteGateway ¶

func (ctl *DMSController) DeleteGateway(c echo.Context) error

swagger:route DELETE /v1/dms/gateways/{gateway_id} Gateway DeleteGateway

Delete gateways.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) DeleteMaskingRule ¶

func (ctl *DMSController) DeleteMaskingRule(c echo.Context) error

swagger:operation DELETE /v1/dms/projects/{project_uid}/masking/rules/{rule_id} Masking DeleteMaskingRule

删除脱敏规则。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: rule_id description: 脱敏规则 ID in: path required: true type: integer

responses:

'200':
  description: 成功删除脱敏规则
  schema:
    "$ref": "#/definitions/DeleteMaskingRuleReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) DeleteMaskingTemplate ¶

func (ctl *DMSController) DeleteMaskingTemplate(c echo.Context) error

swagger:operation DELETE /v1/dms/projects/{project_uid}/masking/templates/{template_id} Masking DeleteMaskingTemplate

删除脱敏模板。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: template_id description: 脱敏模板 ID in: path required: true type: integer

responses:

'200':
  description: 成功删除脱敏模板
  schema:
    "$ref": "#/definitions/DeleteMaskingTemplateReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) DeleteMemberGroup ¶

func (ctl *DMSController) DeleteMemberGroup(c echo.Context) error

swagger:route DELETE /v1/dms/projects/{project_uid}/member_groups/{member_group_uid} MemberGroup DeleteMemberGroup

delete member group, for front page.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) DeleteSensitiveDataDiscoveryTask ¶

func (ctl *DMSController) DeleteSensitiveDataDiscoveryTask(c echo.Context) error

swagger:operation DELETE /v1/dms/projects/{project_uid}/masking/sensitive-data-discovery-tasks/{task_id} Masking DeleteSensitiveDataDiscoveryTask

删除敏感数据发现任务。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: task_id description: 敏感数据发现任务 ID in: path required: true type: integer

responses:

'200':
  description: 成功删除敏感数据发现任务
  schema:
    "$ref": "#/definitions/DeleteSensitiveDataDiscoveryTaskReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) DeleteSensitiveDataType ¶

func (ctl *DMSController) DeleteSensitiveDataType(c echo.Context) error

swagger:operation DELETE /v1/dms/projects/{project_uid}/masking/sensitive-types/{sensitive_data_type_id} Masking DeleteSensitiveDataType

删除自定义敏感数据类型（未被任何脱敏规则引用时方可删除）。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: sensitive_data_type_id description: 敏感数据类型 ID（自定义类型的主键） in: path required: true type: integer

responses:

'200':
  description: 成功删除敏感数据类型
  schema:
    "$ref": "#/definitions/DeleteSensitiveDataTypeReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) DownloadDataExportTask ¶

func (ctl *DMSController) DownloadDataExportTask(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/data_export_tasks/{data_export_task_uid}/download DataExportTask DownloadDataExportTask

download task file.

responses:
  200: DownloadDataExportTaskReply
  default: body:GenericResp

func (*DMSController) DownloadDataExportTaskSQLs ¶

func (ctl *DMSController) DownloadDataExportTaskSQLs(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/data_export_tasks/{data_export_task_uid}/data_export_task_sqls/download DataExportTask DownloadDataExportTaskSQLs

dowload data_export sqls.

responses:
  200: DownloadDataExportTaskSQLsReply
  default: body:GenericResp

func (*DMSController) DownloadOriginalDataExportWorkflow ¶

func (ctl *DMSController) DownloadOriginalDataExportWorkflow(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/data_export_workflows/{data_export_workflow_uid}/original-export/download DataExportWorkflows DownloadOriginalDataExportWorkflow

Download unmasked SQL query results as a zip file. Each request runs export in memory; files are not persisted.

responses:
  200: DownloadOriginalDataExportWorkflowReply
  default: body:GenericResp

func (*DMSController) DownloadResourceOverviewList ¶

func (d *DMSController) DownloadResourceOverviewList(c echo.Context) error

swagger:route GET /v1/dms/resource_overview/download ResourceOverview DownloadResourceOverviewList

download resource overview list csv file.

responses:
  200: DownloadResourceOverviewListRes
  default: body:GenericResp

func (*DMSController) ExportCBOperationLogs ¶

func (ctl *DMSController) ExportCBOperationLogs(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/cb_operation_logs/export CBOperationLogs ExportCBOperationLogs

Export cb operation logs.

responses:
  200: ExportCBOperationLogsReply
  default: body:GenericResp

func (*DMSController) ExportDataExportWorkflow ¶

func (ctl *DMSController) ExportDataExportWorkflow(c echo.Context) error

swagger:route POST /v1/dms/projects/{project_uid}/data_export_workflows/{data_export_workflow_uid}/export DataExportWorkflows ExportDataExportWorkflow

exec data_export workflow.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) ExportOperationRecordList ¶

func (ctl *DMSController) ExportOperationRecordList(c echo.Context) error

swagger:operation GET /v1/dms/operation_records/exports OperationRecord ExportOperationRecordList

Export operation record list.

--- parameters:

• name: filter_operate_time_from in: query type: string
• name: filter_operate_time_to in: query type: string
• name: filter_operate_project_name in: query type: string
• name: fuzzy_search_operate_user_name in: query type: string
• name: filter_operate_type_name in: query type: string
• name: filter_operate_action in: query type: string

responses:

'200':
  description: ExportOperationRecordListReply
  schema:
    type: file
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ExportProjects ¶

func (ctl *DMSController) ExportProjects(c echo.Context) error

swagger:route GET /v1/dms/projects/export Project ExportProjects

Export projects file.

responses:
  200: ExportProjectsReply
  default: body:GenericResp

func (*DMSController) GenAccessToken ¶

func (ctl *DMSController) GenAccessToken(c echo.Context) error

swagger:operation POST /v1/dms/users/gen_token User GenAccessToken

Gen user access token.

--- parameters:

• name: expiration_days in: body required: true schema: "$ref": "#/definitions/GenAccessToken"

responses:

'200':
  description: GenAccessTokenReply
  schema:
    "$ref": "#/definitions/GenAccessTokenReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) GetBasicInfo ¶

func (ctl *DMSController) GetBasicInfo(c echo.Context) error

swagger:route GET /v1/dms/basic_info BasicInfo GetBasicInfo

get basic info.

responses:
  200: body:GetBasicInfoReply
  default: body:GenericResp

func (*DMSController) GetCBOperationLogTips ¶

func (ctl *DMSController) GetCBOperationLogTips(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/cb_operation_logs/tips CBOperationLogs GetCBOperationLogTips

Get cb operation log tips.

responses:
  200: GetCBOperationLogTipsReply
  default: body:GenericResp

func (*DMSController) GetCompanyNotice ¶

func (ctl *DMSController) GetCompanyNotice(c echo.Context) error

swagger:operation GET /v1/dms/company_notice CompanyNotice GetCompanyNotice

get company notice info

--- parameters:

• name: include_latest_outside_period description: when true, return the latest notice regardless of display window (for admin edit) in: query required: false type: boolean

responses:

'200':
  description: GetCompanyNoticeReply
  schema:
    "$ref": "#/definitions/GetCompanyNoticeReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) GetDBServiceSyncTask ¶

func (ctl *DMSController) GetDBServiceSyncTask(c echo.Context) error

swagger:operation GET /v1/dms/db_service_sync_tasks/{db_service_sync_task_uid} DBServiceSyncTask GetDBServiceSyncTask

Get database synchronization task.

--- parameters:

• name: db_service_sync_task_uid description: db service sync task uid in: path required: true type: string

responses:

'200':
  description: GetDBServiceSyncTaskReply
  schema:
    "$ref": "#/definitions/GetDBServiceSyncTaskReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) GetDataExportWorkflow ¶

func (ctl *DMSController) GetDataExportWorkflow(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/data_export_workflows/{data_export_workflow_uid} DataExportWorkflows GetDataExportWorkflow

Get data_export workflow.

responses:
  200: body:GetDataExportWorkflowReply
  default: body:GenericResp

func (*DMSController) GetFeishuConfiguration ¶

func (ctl *DMSController) GetFeishuConfiguration(c echo.Context) error

swagger:route GET /v1/dms/configurations/feishu Configuration GetFeishuConfiguration

get feishu configuration.

responses:
  200: body:GetFeishuConfigurationReply
  default: body:GenericResp

func (*DMSController) GetGateway ¶

func (ctl *DMSController) GetGateway(c echo.Context) error

swagger:route GET /v1/dms/gateways/{gateway_id} Gateway GetGateway

Get gateways.

responses:
  200: body:GetGatewayReply
  default: body:GenericResp

func (*DMSController) GetGatewayTips ¶

func (ctl *DMSController) GetGatewayTips(c echo.Context) error

swagger:route GET /v1/dms/gateways/tips Gateway GetGatewayTips

Get gateway tips.

responses:
  200: body:GetGatewayTipsReply
  default: body:GenericResp

func (*DMSController) GetGlobalDataExportWorkflows ¶

func (ctl *DMSController) GetGlobalDataExportWorkflows(c echo.Context) error

func (*DMSController) GetImportDBServicesTemplate ¶

func (ctl *DMSController) GetImportDBServicesTemplate(c echo.Context) error

swagger:route GET /v1/dms/projects/import_db_services_template Project GetImportDBServicesTemplate

Get import DBServices template.

responses:
  200: GetImportDBServicesTemplateReply
  default: body:GenericResp

func (*DMSController) GetImportProjectsTemplate ¶

func (ctl *DMSController) GetImportProjectsTemplate(c echo.Context) error

swagger:route GET /v1/dms/projects/import_template Project GetImportProjectsTemplate

Get import projects template.

responses:
  200: GetImportProjectsTemplateReply
  default: body:GenericResp

func (*DMSController) GetLDAPConfiguration ¶

func (ctl *DMSController) GetLDAPConfiguration(c echo.Context) error

swagger:route GET /v1/dms/configurations/ldap Configuration GetLDAPConfiguration

Get ldap configuration.

responses:
  200: body:GetLDAPConfigurationResDataReply
  default: body:GenericResp

func (*DMSController) GetLicense ¶

func (ctl *DMSController) GetLicense(c echo.Context) error

swagger:route GET /v1/dms/configurations/license Configuration GetLicense

get license.

responses:
  200: body:GetLicenseReply
  default: body:GenericResp

func (*DMSController) GetLicenseInfo ¶

func (ctl *DMSController) GetLicenseInfo(c echo.Context) error

swagger:route GET /v1/dms/configurations/license/info Configuration GetLicenseInfo

get generate license info.

responses:
  200: GetLicenseInfoReply
  default: body:GenericResp

func (*DMSController) GetLicenseUsage ¶

func (ctl *DMSController) GetLicenseUsage(c echo.Context) error

swagger:route GET /v1/dms/configurations/license/usage Configuration GetLicenseUsage

get license usage.

responses:
  200: body:GetLicenseUsageReply
  default: body:GenericResp

func (*DMSController) GetLoginTips ¶

func (ctl *DMSController) GetLoginTips(c echo.Context) error

swagger:route GET /v1/dms/configurations/login/tips Configuration GetLoginTips

get login configuration.

responses:
  200: body:GetLoginTipsReply
  default: body:GenericResp

func (*DMSController) GetMaskingOverviewTree ¶

func (ctl *DMSController) GetMaskingOverviewTree(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/overview Masking GetMaskingOverviewTree

获取脱敏概览树。

responses:
  200: body:GetMaskingOverviewTreeReply
  default: body:GenericResp

func (*DMSController) GetMaskingRuleDetail ¶

func (ctl *DMSController) GetMaskingRuleDetail(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/rules/{rule_id} Masking GetMaskingRuleDetail

获取脱敏规则详情。

responses:
  200: body:GetMaskingRuleDetailReply
  default: body:GenericResp

func (*DMSController) GetMemberGroup ¶

func (ctl *DMSController) GetMemberGroup(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/member_groups/{member_group_uid} MemberGroup GetMemberGroup

Get member group, for front page.

responses:
  200: body:GetMemberGroupReply
  default: body:GenericResp

func (*DMSController) GetOauth2Configuration ¶

func (ctl *DMSController) GetOauth2Configuration(c echo.Context) error

swagger:route GET /v1/dms/configurations/oauth2 Configuration GetOauth2Configuration

Get Oauth2 configuration.

responses:
  200: body:GetOauth2ConfigurationResDataReply
  default: body:GenericResp

func (*DMSController) GetOauth2Tips ¶

func (ctl *DMSController) GetOauth2Tips(c echo.Context) error

swagger:route GET /v1/dms/oauth2/tips OAuth2 GetOauth2Tips

Get Oauth2 Tips.

responses:
  200: body:GetOauth2TipsReply
  default: body:GenericResp

func (*DMSController) GetOperationRecordList ¶

func (ctl *DMSController) GetOperationRecordList(c echo.Context) error

swagger:operation GET /v1/dms/operation_records OperationRecord GetOperationRecordList

Get operation record list.

--- parameters:

• name: filter_operate_time_from in: query type: string
• name: filter_operate_time_to in: query type: string
• name: filter_operate_project_name in: query type: string
• name: fuzzy_search_operate_user_name in: query type: string
• name: filter_operate_type_name in: query type: string
• name: filter_operate_action in: query type: string
• name: page_index in: query required: true type: integer
• name: page_size in: query required: true type: integer

responses:

'200':
  description: GetOperationRecordListReply
  schema:
    "$ref": "#/definitions/GetOperationRecordListReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) GetProjectTips ¶

func (ctl *DMSController) GetProjectTips(c echo.Context) error

swagger:route GET /v1/dms/projects/tips Project GetProjectTips

Get project tips.

responses:
  200: body:GetProjectTipsReply
  default: body:GenericResp

deprecated: true

func (*DMSController) GetResourceOverviewResourceList ¶

func (d *DMSController) GetResourceOverviewResourceList(c echo.Context) error

swagger:operation GET /v1/dms/resource_overview/resource_list ResourceOverview GetResourceOverviewResourceListV1

Get resource overview resource list.

--- responses:

'200':
  description: resource overview resource list response body
  schema:
    "$ref": "#/definitions/ResourceOverviewResourceListResV1"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) GetResourceOverviewResourceTypeDistribution ¶

func (d *DMSController) GetResourceOverviewResourceTypeDistribution(c echo.Context) error

swagger:operation GET /v1/dms/resource_overview/resource_type_distribution ResourceOverview GetResourceOverviewResourceTypeDistributionV1

Get resource overview resource type distribution.

--- responses:

'200':
  description: resource overview resource type distribution response body
  schema:
    "$ref": "#/definitions/ResourceOverviewResourceTypeDistributionResV1"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) GetResourceOverviewStatistics ¶

func (d *DMSController) GetResourceOverviewStatistics(c echo.Context) error

swagger:operation GET /v1/dms/resource_overview/statistics ResourceOverview GetResourceOverviewStatisticsV1

Get resource overview statistics.

--- responses:

'200':
  description: resource overview statistics response body
  schema:
    "$ref": "#/definitions/ResourceOverviewStatisticsResV1"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) GetResourceOverviewTopology ¶

func (d *DMSController) GetResourceOverviewTopology(c echo.Context) error

swagger:operation GET /v1/dms/resource_overview/topology ResourceOverview GetResourceOverviewTopologyV1

Get resource overview topology.

--- responses:

'200':
  description: resource overview topology response body
  schema:
    "$ref": "#/definitions/ResourceOverviewTopologyResV1"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) GetSMTPConfiguration ¶

func (ctl *DMSController) GetSMTPConfiguration(c echo.Context) error

swagger:route GET /v1/dms/configurations/smtp Configuration GetSMTPConfiguration

get smtp configuration.

responses:
  200: body:GetSMTPConfigurationReply
  default: body:GenericResp

func (*DMSController) GetSmsConfiguration ¶

func (ctl *DMSController) GetSmsConfiguration(c echo.Context) error

swagger:route GET /v1/dms/configurations/sms Configuration GetSmsConfiguration

get sms configuration.

responses:
  200: body:GetSmsConfigurationReply
  default: body:GenericResp

func (*DMSController) GetStaticLogo ¶

func (ctl *DMSController) GetStaticLogo(c echo.Context) error

swagger:route GET /v1/dms/personalization/logo BasicInfo GetStaticLogo

get logo

Produces:
- application/octet-stream

responses:
  200: GetStaticLogoReply
  default: body:GenericResp

func (*DMSController) GetSystemVariables ¶

func (ctl *DMSController) GetSystemVariables(c echo.Context) error

swagger:route GET /v1/dms/configurations/system_variables Configuration GetSystemVariables

获取系统变量配置

responses:
  200: body:GetSystemVariablesReply
  default: body:GenericResp

func (*DMSController) GetTableColumnMaskingDetails ¶

func (ctl *DMSController) GetTableColumnMaskingDetails(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/tables/{table_id}/column-masking-details Masking GetTableColumnMaskingDetails

获取表字段脱敏详情。

responses:
  200: body:GetTableColumnMaskingDetailsReply
  default: body:GenericResp

func (*DMSController) GetUnmaskingWorkflow ¶

func (ctl *DMSController) GetUnmaskingWorkflow(c echo.Context) error

swagger:operation GET /v1/dms/projects/{project_uid}/masking/unmasking-workflows/{workflow_id} Masking GetUnmaskingWorkflow

Get unmasking workflow detail.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: workflow_id description: workflow id in: path required: true type: string

responses:

'200':
  description: Get unmasking workflow detail successfully
  schema:
    "$ref": "#/definitions/GetUnmaskingWorkflowReply"
default:
  description: Generic error response
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) GetUnmaskingWorkflowPlaintext ¶

func (ctl *DMSController) GetUnmaskingWorkflowPlaintext(c echo.Context) error

swagger:operation GET /v1/dms/projects/{project_uid}/masking/unmasking-workflows/{workflow_id}/plaintext Masking GetUnmaskingWorkflowPlaintext

Get plaintext query snapshot during active view window.

--- parameters:

• name: project_uid in: path required: true type: string
• name: workflow_id in: path required: true type: string

responses:

'200':
  schema:
    "$ref": "#/definitions/GetUnmaskingWorkflowPlaintextReply"
default:
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) GetUser ¶

func (ctl *DMSController) GetUser(c echo.Context) error

swagger:route GET /v1/dms/users/{user_uid} User GetUser

Get user info, This API is used by other component such as sqle&auth to get user info.

responses:
  200: body:GetUserReply
  default: body:GenericResp

func (*DMSController) GetUserBySession ¶

func (ctl *DMSController) GetUserBySession(c echo.Context) error

swagger:route GET /v1/dms/sessions/user Session GetUserBySession

Get current user.

responses:
  200: body:GetUserBySessionReply
  default: body:GenericResp

func (*DMSController) GetUserOpPermission ¶

func (ctl *DMSController) GetUserOpPermission(c echo.Context) error

swagger:route GET /v1/dms/users/{user_uid}/op_permission User GetUserOpPermission

Get user op permission info, This API is used by other component such as sqle&auth to check user permissions.

responses:
  200: body:GetUserOpPermissionReply
  default: body:GenericResp

func (*DMSController) GetWeChatConfiguration ¶

func (ctl *DMSController) GetWeChatConfiguration(c echo.Context) error

swagger:route GET /v1/dms/configurations/wechat Configuration GetWeChatConfiguration

get wechat configuration.

responses:
  200: body:GetWeChatConfigurationReply
  default: body:GenericResp

func (*DMSController) GetWebHookConfiguration ¶

func (ctl *DMSController) GetWebHookConfiguration(c echo.Context) error

swagger:route GET /v1/dms/configurations/webhook Configuration GetWebHookConfiguration

get webhook configuration.

responses:
  200: body:GetWebHookConfigurationReply
  default: body:GenericResp

func (*DMSController) ImportDBServicesOfOneProject ¶

func (ctl *DMSController) ImportDBServicesOfOneProject(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/db_services/import DBService ImportDBServicesOfOneProject

Import DBServices.

--- deprecated: true parameters:

• name: project_uid description: project id in: path required: true type: string
• name: db_services description: new db services in: body required: true schema: "$ref": "#/definitions/ImportDBServicesOfOneProjectReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ImportDBServicesOfOneProjectCheck ¶

func (ctl *DMSController) ImportDBServicesOfOneProjectCheck(c echo.Context) error

swagger:route POST /v1/dms/projects/{project_uid}/db_services/import_check DBService ImportDBServicesOfOneProjectCheck

Import DBServices.

Consumes:
- multipart/form-data

Produces:
- application/json
- text/csv

responses:
  200: ImportDBServicesCheckCsvReply
  default: body:ImportDBServicesCheckReply

deprecated: true

func (*DMSController) ImportDBServicesOfOneProjectCheckV2 ¶

func (ctl *DMSController) ImportDBServicesOfOneProjectCheckV2(c echo.Context) error

swagger:route POST /v2/dms/projects/{project_uid}/db_services/import_check DBService ImportDBServicesOfOneProjectCheckV2

Import DBServices.

Consumes:
- multipart/form-data

Produces:
- application/json
- text/csv

responses:
  200: ImportDBServicesCheckCsvReply
  default: body:ImportDBServicesCheckReply

func (*DMSController) ImportDBServicesOfOneProjectV2 ¶

func (ctl *DMSController) ImportDBServicesOfOneProjectV2(c echo.Context) error

swagger:operation POST /v2/dms/projects/{project_uid}/db_services/import DBService ImportDBServicesOfOneProjectV2

Import DBServices.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: db_services description: new db services in: body required: true schema: "$ref": "#/definitions/ImportDBServicesOfOneProjectReqV2"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ImportDBServicesOfProjects ¶

func (ctl *DMSController) ImportDBServicesOfProjects(c echo.Context) error

swagger:operation POST /v1/dms/projects/import_db_services Project ImportDBServicesOfProjects

Import DBServices.

--- parameters:

• name: db_services description: new db services in: body required: true schema: "$ref": "#/definitions/ImportDBServicesOfProjectsReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

deprecated: true

func (*DMSController) ImportDBServicesOfProjectsCheck ¶

func (ctl *DMSController) ImportDBServicesOfProjectsCheck(c echo.Context) error

swagger:route POST /v1/dms/projects/import_db_services_check Project ImportDBServicesOfProjectsCheck

Import DBServices.

	Consumes:
	- multipart/form-data

	Produces:
	- application/json
	- text/csv

responses:
  200: ImportDBServicesCheckCsvReply
  default: body:ImportDBServicesCheckReply

deprecated: true

func (*DMSController) ImportDBServicesOfProjectsCheckV2 ¶

func (ctl *DMSController) ImportDBServicesOfProjectsCheckV2(c echo.Context) error

swagger:route POST /v2/dms/projects/import_db_services_check Project ImportDBServicesOfProjectsCheckV2

Import DBServices.

	Consumes:
	- multipart/form-data

	Produces:
	- application/json
	- text/csv

responses:
  200: ImportDBServicesCheckCsvReply
  default: body:ImportDBServicesCheckReply

func (*DMSController) ImportDBServicesOfProjectsV2 ¶

func (ctl *DMSController) ImportDBServicesOfProjectsV2(c echo.Context) error

swagger:operation POST /v2/dms/projects/import_db_services Project ImportDBServicesOfProjectsV2

Import DBServices.

--- parameters:

• name: db_services description: new db services in: body required: true schema: "$ref": "#/definitions/ImportDBServicesOfProjectsReqV2"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ImportProjects ¶

func (ctl *DMSController) ImportProjects(c echo.Context) error

swagger:operation POST /v1/dms/projects/import Project ImportProjects

Import projects.

--- deprecated: true parameters:

• name: projects description: import projects in: body required: true schema: "$ref": "#/definitions/ImportProjectsReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ImportProjectsV2 ¶

func (ctl *DMSController) ImportProjectsV2(c echo.Context) error

swagger:operation POST /v2/dms/projects/import Project ImportProjectsV2

Import projects.

--- parameters:

• name: projects description: import projects in: body required: true schema: "$ref": "#/definitions/ImportProjectsReqV2"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ListAllDataExportWorkflows ¶

func (ctl *DMSController) ListAllDataExportWorkflows(c echo.Context) error

swagger:route GET /v1/dms/projects/data_export_workflows DataExportWorkflows ListAllDataExportWorkflows

List all data_export workflow.

responses:
  200: body:ListDataExportWorkflowsReply
  default: body:GenericResp

func (*DMSController) ListBusinessTags ¶

func (ctl *DMSController) ListBusinessTags(c echo.Context) error

swagger:route GET /v1/dms/projects/business_tags Project ListBusinessTags

List business tags.

responses:
  200: body:ListBusinessTagsReply
  default: body:GenericResp

func (*DMSController) ListCBOperationLogs ¶

func (ctl *DMSController) ListCBOperationLogs(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/cb_operation_logs CBOperationLogs ListCBOperationLogs

List cb operation logs.

responses:
  200: body:ListCBOperationLogsReply
  default: body:GenericResp

func (*DMSController) ListCreatableDBServicesForMaskingTask ¶

func (ctl *DMSController) ListCreatableDBServicesForMaskingTask(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/sensitive-data-discovery-tasks/creatable-db-services Masking ListCreatableDBServicesForMaskingTask

查询可用于创建敏感数据发现任务的数据源列表。

responses:
  200: body:ListCreatableDBServicesForMaskingTaskReply
  default: body:GenericResp

func (*DMSController) ListDBServiceDriverOption ¶

func (ctl *DMSController) ListDBServiceDriverOption(c echo.Context) error

swagger:route GET /v1/dms/db_services/driver_options DBService ListDBServiceDriverOption

List db service driver option.

responses:
  200: body:ListDBServiceDriverOptionReply
  default: body:GenericResp

func (*DMSController) ListDBServiceSchemasForMaskingTask ¶

func (ctl *DMSController) ListDBServiceSchemasForMaskingTask(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/sensitive-data-discovery-tasks/db-service-schemas Masking ListDBServiceSchemasForMaskingTask

查询指定数据源下可用于配置敏感数据发现任务的 schema（数据库）列表。

responses:
  200: body:ListDBServiceSchemasForMaskingTaskReply
  default: body:GenericResp

func (*DMSController) ListDBServiceSyncTaskTips ¶

func (ctl *DMSController) ListDBServiceSyncTaskTips(c echo.Context) error

swagger:operation GET /v1/dms/db_service_sync_tasks/tips DBServiceSyncTask ListDBServiceSyncTaskTips

List database synchronization task tips.

--- responses:

'200':
  description: ListDBServiceSyncTaskTipsReply
  schema:
    "$ref": "#/definitions/ListDBServiceSyncTaskTipsReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ListDBServiceSyncTasks ¶

func (ctl *DMSController) ListDBServiceSyncTasks(c echo.Context) error

swagger:operation GET /v1/dms/db_service_sync_tasks DBServiceSyncTask ListDBServiceSyncTasks

List database synchronization tasks.

--- responses:

'200':
  description: ListDBServiceSyncTasksReply
  schema:
    "$ref": "#/definitions/ListDBServiceSyncTasksReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ListDBServiceTablesForMaskingTask ¶

func (ctl *DMSController) ListDBServiceTablesForMaskingTask(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/sensitive-data-discovery-tasks/db-service-tables Masking ListDBServiceTablesForMaskingTask

查询指定数据源与 schema 下可用于配置敏感数据发现任务的表列表。

responses:
  200: body:ListDBServiceTablesForMaskingTaskReply
  default: body:GenericResp

func (*DMSController) ListDBServiceTips ¶

func (ctl *DMSController) ListDBServiceTips(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/db_services/tips DBService ListDBServiceTips

List db service tip.

responses:
  200: body:ListDBServiceTipsReply
  default: body:GenericResp

func (*DMSController) ListDBServices ¶

func (ctl *DMSController) ListDBServices(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/db_services DBService ListDBServices

List db service.

responses:
  200: body:ListDBServiceReply
  default: body:GenericResp

deprecated: true

func (*DMSController) ListDBServicesV2 ¶

func (ctl *DMSController) ListDBServicesV2(c echo.Context) error

swagger:route GET /v2/dms/projects/{project_uid}/db_services DBService ListDBServicesV2

List db service.

responses:
  200: body:ListDBServiceReplyV2
  default: body:GenericResp

func (*DMSController) ListDataExportTaskSQLs ¶

func (ctl *DMSController) ListDataExportTaskSQLs(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/data_export_tasks/{data_export_task_uid}/data_export_task_sqls DataExportTask ListDataExportTaskSQLs

List data_export workflow.

responses:
  200: body:ListDataExportTaskSQLsReply
  default: body:GenericResp

func (*DMSController) ListDataExportWorkflows ¶

func (ctl *DMSController) ListDataExportWorkflows(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/data_export_workflows DataExportWorkflows ListDataExportWorkflows

List data_export workflow.

responses:
  200: body:ListDataExportWorkflowsReply
  default: body:GenericResp

func (*DMSController) ListEnvironmentTags ¶

func (ctl *DMSController) ListEnvironmentTags(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/environment_tags Project ListEnvironmentTags

List environment tags.

responses:
  200: body:ListEnvironmentTagsReply
  default: body:GenericResp

func (*DMSController) ListGateways ¶

func (ctl *DMSController) ListGateways(c echo.Context) error

swagger:route GET /v1/dms/gateways Gateway ListGateways

List gateways.

responses:
  200: body:ListGatewaysReply
  default: body:GenericResp

func (*DMSController) ListGlobalDBServices ¶

func (ctl *DMSController) ListGlobalDBServices(c echo.Context) error

swagger:route GET /v1/dms/db_services DBService ListGlobalDBServices

list global DBServices

responses:
  200: body:ListGlobalDBServicesReply
  default: body:GenericResp

deprecated: true

func (*DMSController) ListGlobalDBServicesTips ¶

func (ctl *DMSController) ListGlobalDBServicesTips(c echo.Context) error

swagger:route GET /v1/dms/db_services/tips DBService ListGlobalDBServicesTips

list global DBServices tips

responses:
  200: body:ListGlobalDBServicesTipsReply
  default: body:GenericResp

func (*DMSController) ListGlobalDBServicesV2 ¶

func (ctl *DMSController) ListGlobalDBServicesV2(c echo.Context) error

swagger:route GET /v2/dms/db_services DBService ListGlobalDBServicesV2

list global DBServices

responses:
  200: body:ListGlobalDBServicesReplyV2
  default: body:GenericResp

func (*DMSController) ListMaskingRules ¶

func (ctl *DMSController) ListMaskingRules(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/rules Masking ListMaskingRules

查询项目下的脱敏规则列表（内置与自定义）。

responses:
  200: body:ListMaskingRulesReply
  default: body:GenericResp

func (*DMSController) ListMaskingRulesWithoutProject ¶

func (ctl *DMSController) ListMaskingRulesWithoutProject(c echo.Context) error

swagger:operation GET /v1/dms/masking/rules Masking ListMaskingRulesWithoutProject

查询脱敏规则列表（兼容旧入口，仅返回内置规则，可携带筛选参数）。

--- parameters:

• name: source description: 规则来源筛选，builtin 或 custom，为空时返回全部 in: query type: string
• name: keywords description: 模糊搜索关键字，匹配规则名称、描述或敏感数据类型名称 in: query type: string
• name: page_size description: 分页大小，默认 20 in: query type: integer
• name: page_index description: 页码（从1开始），默认 1 in: query type: integer

responses:

'200':
  description: 查询脱敏规则列表成功
  schema:
    "$ref": "#/definitions/ListMaskingRulesReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ListMaskingTemplates ¶

func (ctl *DMSController) ListMaskingTemplates(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/templates Masking ListMaskingTemplates

查询脱敏模板列表。

responses:
  200: body:ListMaskingTemplatesReply
  default: body:GenericResp

func (*DMSController) ListMemberGroupTips ¶

func (ctl *DMSController) ListMemberGroupTips(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/member_groups/tips MemberGroup ListMemberGroupTips

List member group tips.

responses:
  200: body:ListMemberGroupTipsReply
  default: body:GenericResp

func (*DMSController) ListMemberGroups ¶

func (ctl *DMSController) ListMemberGroups(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/member_groups MemberGroup ListMemberGroups

List member group, for front page.

responses:
  200: body:ListMemberGroupsReply
  default: body:GenericResp

func (*DMSController) ListMemberTips ¶

func (ctl *DMSController) ListMemberTips(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/members/tips Member ListMemberTips

List member tips.

responses:
  200: body:ListMemberTipsReply
  default: body:GenericResp

func (*DMSController) ListMembers ¶

func (ctl *DMSController) ListMembers(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/members Member ListMembers

List member, for front page.

responses:
  200: body:ListMemberReply
  default: body:GenericResp

func (*DMSController) ListMembersForInternal ¶

func (ctl *DMSController) ListMembersForInternal(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/members/internal Member ListMembersForInternal

List members, for internal backend service.

responses:
  200: body:ListMembersForInternalReply
  default: body:GenericResp

func (*DMSController) ListOpPermissions ¶

func (ctl *DMSController) ListOpPermissions(c echo.Context) error

swagger:route GET /v1/dms/op_permissions OpPermission ListOpPermissions

List op permission.

responses:
  200: body:ListOpPermissionReply
  default: body:GenericResp

func (*DMSController) ListProjects ¶

func (ctl *DMSController) ListProjects(c echo.Context) error

swagger:route GET /v1/dms/projects Project ListProjects

List projects.

responses:
  200: body:ListProjectReply
  default: body:GenericResp

deprecated: true

func (*DMSController) ListProjectsV2 ¶

func (ctl *DMSController) ListProjectsV2(c echo.Context) error

swagger:route GET /v2/dms/projects Project ListProjectsV2

List projects.

responses:
  200: body:ListProjectReplyV2
  default: body:GenericResp

func (*DMSController) ListRoles ¶

func (ctl *DMSController) ListRoles(c echo.Context) error

swagger:route GET /v1/dms/roles Role ListRoles

List roles.

responses:
  200: body:ListRoleReply
  default: body:GenericResp

func (*DMSController) ListSensitiveDataDiscoveryTaskHistories ¶

func (ctl *DMSController) ListSensitiveDataDiscoveryTaskHistories(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/sensitive-data-discovery-tasks/{task_id}/histories Masking ListSensitiveDataDiscoveryTaskHistories

查询敏感数据发现任务执行历史。

responses:
  200: body:ListSensitiveDataDiscoveryTaskHistoriesReply
  default: body:GenericResp

func (*DMSController) ListSensitiveDataDiscoveryTasks ¶

func (ctl *DMSController) ListSensitiveDataDiscoveryTasks(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/sensitive-data-discovery-tasks Masking ListSensitiveDataDiscoveryTasks

查询敏感数据发现任务列表。

responses:
  200: body:ListSensitiveDataDiscoveryTasksReply
  default: body:GenericResp

func (*DMSController) ListSensitiveTypes ¶

func (ctl *DMSController) ListSensitiveTypes(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/masking/sensitive-types Masking ListSensitiveTypes

查询敏感数据类型列表（内置与自定义）。

responses:
  200: body:ListSensitiveTypesReply
  default: body:GenericResp

func (*DMSController) ListTableColumns ¶

func (ctl *DMSController) ListTableColumns(c echo.Context) error

swagger:route GET /v1/dms/projects/{project_uid}/db_services/{db_service_uid}/schemas/{schema_name}/tables/{table_name}/columns DBStructure ListTableColumns

List table columns (internal API for lineage analysis).

responses:
  200: body:ListTableColumnsReply
  default: body:GenericResp

func (*DMSController) ListUnmaskingWorkflows ¶

func (ctl *DMSController) ListUnmaskingWorkflows(c echo.Context) error

swagger:operation GET /v1/dms/projects/{project_uid}/masking/unmasking-workflows Masking ListUnmaskingWorkflows

List unmasking workflows.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: page_size description: the maximum count of workflows to be returned in: query required: true type: integer format: uint32
• name: page_index description: the offset of workflows to be returned, default is 0 in: query required: false type: integer format: uint32
• name: filter_by_approval_status description: filter the approval status in: query required: false type: string enum: [pending, approved, rejected, cancelled]
• name: filter_by_usage_status description: filter the usage status in: query required: false type: string enum: [unviewed, viewed]
• name: filter_by_db_service_uid description: filter db_service id in: query required: false type: string

responses:

'200':
  description: List unmasking workflows successfully
  schema:
    "$ref": "#/definitions/ListUnmaskingWorkflowsReply"
default:
  description: Generic error response
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) ListUserGroups ¶

func (ctl *DMSController) ListUserGroups(c echo.Context) error

swagger:route GET /v1/dms/user_groups UserGroup ListUserGroups

List user groups.

responses:
  200: body:ListUserGroupReply
  default: body:GenericResp

func (*DMSController) ListUsers ¶

func (ctl *DMSController) ListUsers(c echo.Context) error

swagger:route GET /v1/dms/users User ListUsers

List users.

responses:
  200: body:ListUserReply
  default: body:GenericResp

func (*DMSController) Notify ¶

func (ctl *DMSController) Notify(c echo.Context) error

swagger:route POST /v1/dms/notifications Notification Notification

notify message.

responses:
  200: body:NotificationReply
  default: body:GenericResp

func (*DMSController) Oauth2LinkOrCallback ¶

func (ctl *DMSController) Oauth2LinkOrCallback(c echo.Context) error

swagger:route GET /v1/dms/oauth2/link OAuth2 Oauth2LinkOrCallback

Oauth2 Link or Callback.

func (*DMSController) Personalization ¶

func (ctl *DMSController) Personalization(c echo.Context) error

swagger:operation POST /v1/dms/personalization BasicInfo Personalization

personalize [title, logo].

--- parameters:

• name: title description: title in: formData required: false type: string
• name: file description: file upload in: formData required: false type: file

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) PreviewImportProjects ¶

func (ctl *DMSController) PreviewImportProjects(c echo.Context) error

swagger:route POST /v1/dms/projects/preview_import Project PreviewImportProjects

Preview import projects.

Consumes:
- multipart/form-data

responses:
  200: PreviewImportProjectsReply
  default: body:GenericResp

deprecated: true

func (*DMSController) PreviewImportProjectsV2 ¶

func (ctl *DMSController) PreviewImportProjectsV2(c echo.Context) error

swagger:route POST /v2/dms/projects/preview_import Project PreviewImportProjectsV2

Preview import projects.

Consumes:
- multipart/form-data

responses:
  200: PreviewImportProjectsReplyV2
  default: body:GenericResp

func (*DMSController) PreviewMaskingEffect ¶

func (ctl *DMSController) PreviewMaskingEffect(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/preview Masking PreviewMaskingEffect

预览脱敏效果。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: preview_req description: 脱敏效果预览请求体 in: body required: true schema: "$ref": "#/definitions/PreviewMaskingEffectReq"

responses:

'200':
  description: 成功返回脱敏效果预览
  schema:
    "$ref": "#/definitions/PreviewMaskingEffectReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) RefreshSession ¶

func (ctl *DMSController) RefreshSession(c echo.Context) error

swagger:operation POST /v1/dms/sessions/refresh Session RefreshSession

refresh a session.

--- responses:

'200':
  description: RefreshSession reply
  schema:
    "$ref": "#/definitions/AddSessionReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) RegisterDMSPlugin ¶

func (ctl *DMSController) RegisterDMSPlugin(c echo.Context) error

swagger:operation POST /v1/dms/plugins DMSPlugin RegisterDMSPlugin

Register dms plugin.

--- parameters:

• name: plugin description: Register dms plugin required: true in: body schema: "$ref": "#/definitions/RegisterDMSPluginReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) RegisterDMSProxyTarget ¶

func (ctl *DMSController) RegisterDMSProxyTarget(c echo.Context) error

swagger:operation POST /v1/dms/proxys DMSProxy RegisterDMSProxyTarget

Register dms proxy target.

--- parameters:

• name: dms_proxy_target description: register dms proxy required: true in: body schema: "$ref": "#/definitions/RegisterDMSProxyTargetReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) RejectDataExportWorkflow ¶

func (ctl *DMSController) RejectDataExportWorkflow(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/data_export_workflows/{data_export_workflow_uid}/reject DataExportWorkflows RejectDataExportWorkflow

Reject data_export workflow.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: data_export_workflow_uid in: path required: true type: string
• name: payload required: true in: body schema: "$ref": "#/definitions/RejectDataExportWorkflowReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) RejectUnmaskingWorkflow ¶

func (ctl *DMSController) RejectUnmaskingWorkflow(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/unmasking-workflows/{workflow_id}/reject Masking RejectUnmaskingWorkflow

Reject unmasking workflow.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: workflow_id description: workflow id in: path required: true type: string
• name: reject_unmasking_workflow description: reject unmasking workflow info in: body required: true schema: "$ref": "#/definitions/RejectUnmaskingWorkflow"

responses:

'200':
  description: Reject unmasking workflow successfully
  schema:
    "$ref": "#/definitions/RejectUnmaskingWorkflowReply"
default:
  description: Generic error response
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) SendSmsCode ¶

func (ctl *DMSController) SendSmsCode(context echo.Context) error

swagger:operation POST /v1/dms/configurations/sms/send_code SMS SendSmsCode

send sms code.

--- parameters:

• name: username description: user name required: true in: body schema: "$ref": "#/definitions/SendSmsCodeReq"

responses:

'200':
  description: SendSmsCodeReply
  schema:
    "$ref": "#/definitions/SendSmsCodeReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) SetLicense ¶

func (ctl *DMSController) SetLicense(c echo.Context) error

swagger:route POST /v1/dms/configurations/license Configuration SetLicense

import license.

 Consumes:
 - multipart/form-data

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) Shutdown ¶

func (ctl *DMSController) Shutdown() error

func (*DMSController) SwaggerHandler ¶

func (ctl *DMSController) SwaggerHandler(c echo.Context) error

func (*DMSController) SyncDBServices ¶

func (ctl *DMSController) SyncDBServices(c echo.Context) error

swagger:operation POST /v1/dms/db_service_sync_tasks/{db_service_sync_task_uid}/sync DBServiceSyncTask SyncDBServices

Sync db service.

--- parameters:

• name: db_service_sync_task_uid description: db service sync task uid in: path required: true type: string

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) SyncGateways ¶

func (ctl *DMSController) SyncGateways(c echo.Context) error

func (*DMSController) TestFeishuConfig ¶

func (ctl *DMSController) TestFeishuConfig(c echo.Context) error

swagger:operation POST /v1/dms/configurations/feishu/test Configuration TestFeishuConfiguration

test feishu configuration.

--- parameters:

• name: test_feishu_configuration description: test feishu configuration required: true in: body schema: "$ref": "#/definitions/TestFeishuConfigurationReq"

responses:

'200':
  description: TestFeishuConfigurationReply
  schema:
    "$ref": "#/definitions/TestFeishuConfigurationReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) TestSMTPConfiguration ¶

func (ctl *DMSController) TestSMTPConfiguration(c echo.Context) error

swagger:operation POST /v1/dms/configurations/smtp/test Configuration TestSMTPConfiguration

test smtp configuration.

--- parameters:

• name: test_smtp_configuration description: test smtp configuration required: true in: body schema: "$ref": "#/definitions/TestSMTPConfigurationReq"

responses:

'200':
  description: TestSMTPConfigurationReply
  schema:
    "$ref": "#/definitions/TestSMTPConfigurationReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) TestSensitiveDataTypeMatch ¶

func (ctl *DMSController) TestSensitiveDataTypeMatch(c echo.Context) error

swagger:operation POST /v1/dms/projects/{project_uid}/masking/sensitive-types/match-test Masking TestSensitiveDataTypeMatch

测试样例值是否匹配敏感数据类型规则（关键词与/或样例正则）。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: body description: 匹配测试请求体 in: body required: true schema: "$ref": "#/definitions/TestSensitiveDataTypeMatchReq"

responses:

'200':
  description: 匹配测试完成
  schema:
    "$ref": "#/definitions/TestSensitiveDataTypeMatchReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) TestSmsConfiguration ¶

func (ctl *DMSController) TestSmsConfiguration(context echo.Context) error

swagger:operation POST /v1/dms/configurations/sms/test Configuration TestSmsConfiguration

test smtp configuration.

--- parameters:

• name: test_sms_configuration description: test sms configuration required: true in: body schema: "$ref": "#/definitions/TestSmsConfigurationReq"

responses:

'200':
  description: TestSmsConfigurationReply
  schema:
    "$ref": "#/definitions/TestSmsConfigurationReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) TestWeChatConfiguration ¶

func (ctl *DMSController) TestWeChatConfiguration(c echo.Context) error

swagger:operation POST /v1/dms/configurations/wechat/test Configuration TestWeChatConfiguration

test wechat configuration.

--- parameters:

• name: test_wechat_configuration description: test wechat configuration in: body schema: "$ref": "#/definitions/TestWeChatConfigurationReq"

responses:

'200':
  description: TestWeChatConfigurationReply
  schema:
    "$ref": "#/definitions/TestWeChatConfigurationReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) TestWebHookConfiguration ¶

func (ctl *DMSController) TestWebHookConfiguration(c echo.Context) error

swagger:route POST /v1/dms/configurations/webhook/test Configuration TestWebHookConfiguration

test webhook configuration.

responses:
  200: body:TestWebHookConfigurationReply
  default: body:GenericResp

func (*DMSController) UnarchiveProject ¶

func (ctl *DMSController) UnarchiveProject(c echo.Context) error

swagger:route PUT /v1/dms/projects/{project_uid}/unarchive Project UnarchiveProject

Unarchive a project.

responses:
  200: body:GenericResp
  default: body:GenericResp

func (*DMSController) UpdateBusinessTag ¶

func (ctl *DMSController) UpdateBusinessTag(c echo.Context) error

swagger:operation PUT /v1/dms/projects/business_tags/{business_tag_uid} Project UpdateBusinessTag

Update an existing business tag.

--- parameters:

• name: business_tag_uid description: business tag id in: path required: true type: string
• name: business_tag description: the business tag to be updated required: true in: body schema: "$ref": "#/definitions/UpdateBusinessTagReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateCompanyNotice ¶

func (ctl *DMSController) UpdateCompanyNotice(c echo.Context) error

swagger:operation PATCH /v1/dms/company_notice CompanyNotice UpdateCompanyNotice

update company notice info

--- parameters:

• name: company_notice description: Update a companynotice required: true in: body schema: "$ref": "#/definitions/UpdateCompanyNoticeReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateCurrentUser ¶

func (ctl *DMSController) UpdateCurrentUser(c echo.Context) error

swagger:operation PUT /v1/dms/users User UpdateCurrentUser

Update current user.

--- parameters:

• name: current_user description: Update current user required: true in: body schema: "$ref": "#/definitions/UpdateCurrentUserReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateDBService ¶

func (ctl *DMSController) UpdateDBService(c echo.Context) error

swagger:operation PUT /v1/dms/projects/{project_uid}/db_services/{db_service_uid} DBService UpdateDBService

update a DB Service.

--- deprecated: true parameters:

• name: project_uid description: project id in: path required: true type: string
• name: db_service_uid description: db_service_uid id in: path required: true type: string
• name: db_service description: Update a DB service in: body schema: "$ref": "#/definitions/UpdateDBServiceReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateDBServiceSyncTask ¶

func (ctl *DMSController) UpdateDBServiceSyncTask(c echo.Context) error

swagger:operation PUT /v1/dms/db_service_sync_tasks/{db_service_sync_task_uid} DBServiceSyncTask UpdateDBServiceSyncTask

update database synchronization task.

--- parameters:

• name: db_service_sync_task_uid description: db service sync task uid in: path required: true type: string
• name: db_service_sync_task description: update db service sync task in: body required: true schema: "$ref": "#/definitions/UpdateDBServiceSyncTaskReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateDBServiceV2 ¶

func (ctl *DMSController) UpdateDBServiceV2(c echo.Context) error

swagger:operation PUT /v2/dms/projects/{project_uid}/db_services/{db_service_uid} DBService UpdateDBServiceV2

update a DB Service.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: db_service_uid description: db_service_uid id in: path required: true type: string
• name: db_service description: Update a DB service in: body schema: "$ref": "#/definitions/UpdateDBServiceReqV2"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateEnvironmentTag ¶

func (ctl *DMSController) UpdateEnvironmentTag(c echo.Context) error

swagger:operation PUT /v1/dms/projects/{project_uid}/environment_tags/{environment_tag_uid} Project UpdateEnvironmentTag

Update an existing environment tag.

--- parameters:

• name: project_uid description: project uid in: path required: true type: string
• name: environment_tag_uid description: environment tag id in: path required: true type: string
• name: environment_name description: the name of environment tag to be updated required: true in: body type: string

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateFeishuConfiguration ¶

func (ctl *DMSController) UpdateFeishuConfiguration(c echo.Context) error

swagger:operation PATCH /v1/dms/configurations/feishu Configuration UpdateFeishuConfiguration

update feishu configuration.

--- parameters:

• name: update_feishu_configuration description: update feishu configuration in: body schema: "$ref": "#/definitions/UpdateFeishuConfigurationReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateGateway ¶

func (ctl *DMSController) UpdateGateway(c echo.Context) error

swagger:operation PUT /v1/dms/gateways/{gateway_id} Gateway UpdateGateway

update gateways.

--- parameters:

• name: gateway_id description: gateway id in: path required: true type: string
• name: update_gateway description: update gateway in: body required: true schema: "$ref": "#/definitions/UpdateGatewayReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateLDAPConfiguration ¶

func (ctl *DMSController) UpdateLDAPConfiguration(c echo.Context) error

swagger:operation PATCH /v1/dms/configurations/ldap Configuration UpdateLDAPConfiguration

Update ldap configuration.

--- parameters:

• name: ldap description: update ldap configuration required: true in: body schema: "$ref": "#/definitions/UpdateLDAPConfigurationReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateLoginConfiguration ¶

func (ctl *DMSController) UpdateLoginConfiguration(c echo.Context) error

swagger:operation PATCH /v1/dms/configurations/login Configuration UpdateLoginConfiguration

Update login configuration.

--- parameters:

• name: login description: update login configuration required: true in: body schema: "$ref": "#/definitions/UpdateLoginConfigurationReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateMaskingRule ¶

func (ctl *DMSController) UpdateMaskingRule(c echo.Context) error

swagger:operation PUT /v1/dms/projects/{project_uid}/masking/rules/{rule_id} Masking UpdateMaskingRule

更新脱敏规则。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: rule_id description: 脱敏规则 ID in: path required: true type: integer
• name: rule description: 脱敏规则更新信息 in: body required: true schema: "$ref": "#/definitions/UpdateMaskingRuleReq"

responses:

'200':
  description: 成功更新脱敏规则
  schema:
    "$ref": "#/definitions/UpdateMaskingRuleReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateMaskingTemplate ¶

func (ctl *DMSController) UpdateMaskingTemplate(c echo.Context) error

swagger:operation PUT /v1/dms/projects/{project_uid}/masking/templates/{template_id} Masking UpdateMaskingTemplate

更新脱敏模板。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: template_id description: 脱敏模板 ID in: path required: true type: integer
• name: masking_template description: 脱敏模板信息 in: body required: true schema: "$ref": "#/definitions/UpdateMaskingTemplateReq"

responses:

'200':
  description: 成功更新脱敏模板
  schema:
    "$ref": "#/definitions/UpdateMaskingTemplateReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateMember ¶

func (ctl *DMSController) UpdateMember(c echo.Context) error

swagger:operation PUT /v1/dms/projects/{project_uid}/members/{member_uid} Member UpdateMember

Update a member.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: member_uid description: Member uid in: path required: true type: string
• name: member description: Update a member required: true in: body schema: "$ref": "#/definitions/UpdateMemberReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateMemberGroup ¶

func (ctl *DMSController) UpdateMemberGroup(c echo.Context) error

swagger:operation PUT /v1/dms/projects/{project_uid}/member_groups/{member_group_uid} MemberGroup UpdateMemberGroup

update member group, for front page.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: member_group_uid description: Member group id in: path required: true type: string
• name: member_group description: Update a member group required: true in: body schema: "$ref": "#/definitions/UpdateMemberGroupReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateOauth2Configuration ¶

func (ctl *DMSController) UpdateOauth2Configuration(c echo.Context) error

swagger:operation PATCH /v1/dms/configurations/oauth2 Configuration UpdateOauth2Configuration

Update Oauth2 configuration..

--- parameters:

• name: oauth2 description: update oauth2 configuration required: true in: body schema: "$ref": "#/definitions/Oauth2ConfigurationReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateProject ¶

func (ctl *DMSController) UpdateProject(c echo.Context) error

swagger:operation PUT /v1/dms/projects/{project_uid} Project UpdateProject

update a project.

--- deprecated: true parameters:

• name: project_uid description: project id in: path required: true type: string
• name: project description: Update a project required: true in: body schema: "$ref": "#/definitions/UpdateProjectReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateProjectV2 ¶

func (ctl *DMSController) UpdateProjectV2(c echo.Context) error

swagger:operation PUT /v2/dms/projects/{project_uid} Project UpdateProjectV2

update a project.

--- parameters:

• name: project_uid description: project id in: path required: true type: string
• name: project description: Update a project required: true in: body schema: "$ref": "#/definitions/UpdateProjectReqV2"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateRole ¶

func (ctl *DMSController) UpdateRole(c echo.Context) error

swagger:operation PUT /v1/dms/roles/{role_uid} Role UpdateRole

Update a role.

--- parameters:

• name: role_uid description: Role uid in: path required: true type: string
• name: role description: Update a role required: true in: body schema: "$ref": "#/definitions/UpdateRoleReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateSMTPConfiguration ¶

func (ctl *DMSController) UpdateSMTPConfiguration(c echo.Context) error

swagger:operation PATCH /v1/dms/configurations/smtp Configuration UpdateSMTPConfiguration

Update smtp configuration.

--- parameters:

• name: smtp_configuration description: update smtp configuration required: true in: body schema: "$ref": "#/definitions/UpdateSMTPConfigurationReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateSensitiveDataDiscoveryTask ¶

func (ctl *DMSController) UpdateSensitiveDataDiscoveryTask(c echo.Context) error

swagger:operation PUT /v1/dms/projects/{project_uid}/masking/sensitive-data-discovery-tasks/{task_id} Masking UpdateSensitiveDataDiscoveryTask

更新敏感数据发现任务。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: task_id description: 敏感数据发现任务 ID in: path required: true type: integer
• name: task description: 敏感数据发现任务信息 in: body required: true schema: "$ref": "#/definitions/UpdateSensitiveDataDiscoveryTaskReq"

responses:

'200':
  description: 成功更新敏感数据发现任务
  schema:
    "$ref": "#/definitions/UpdateSensitiveDataDiscoveryTaskReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateSensitiveDataType ¶

func (ctl *DMSController) UpdateSensitiveDataType(c echo.Context) error

swagger:operation PUT /v1/dms/projects/{project_uid}/masking/sensitive-types/{sensitive_data_type_id} Masking UpdateSensitiveDataType

更新自定义敏感数据类型的识别条件（字段关键词、抽样正则、示例数据）。

--- parameters:

• name: project_uid description: 项目 UID in: path required: true type: string
• name: sensitive_data_type_id description: 敏感数据类型 ID（自定义类型的主键） in: path required: true type: integer
• name: body description: 更新内容 in: body required: true schema: "$ref": "#/definitions/UpdateSensitiveDataTypeReq"

responses:

'200':
  description: 成功更新敏感数据类型
  schema:
    "$ref": "#/definitions/UpdateSensitiveDataTypeReply"
default:
  description: 通用错误响应
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateSmsConfiguration ¶

func (ctl *DMSController) UpdateSmsConfiguration(context echo.Context) error

swagger:operation PATCH /v1/dms/configurations/sms Configuration UpdateSmsConfiguration

update sms configuration.

--- parameters:

• name: update_sms_configuration description: update sms configuration required: true in: body schema: "$ref": "#/definitions/UpdateSmsConfigurationReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateSystemVariables ¶

func (ctl *DMSController) UpdateSystemVariables(c echo.Context) error

swagger:operation PATCH /v1/dms/configurations/system_variables Configuration UpdateSystemVariables

更新系统变量配置

--- parameters:

• name: system_variables description: 更新系统变量配置 required: true in: body schema: "$ref": "#/definitions/UpdateSystemVariablesReqV1"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateUser ¶

func (ctl *DMSController) UpdateUser(c echo.Context) error

swagger:operation PUT /v1/dms/users/{user_uid} User UpdateUser

Update a user.

--- parameters:

• name: user_uid description: User uid in: path required: true type: string
• name: user description: Update a user in: body schema: "$ref": "#/definitions/UpdateUserReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateUserGroup ¶

func (ctl *DMSController) UpdateUserGroup(c echo.Context) error

swagger:operation PUT /v1/dms/user_groups/{user_group_uid} UserGroup UpdateUserGroup

Update a user group.

--- parameters:

• name: user_group_uid description: UserGroup uid in: path required: true type: string
• name: user_group description: Update a user group required: true in: body schema: "$ref": "#/definitions/UpdateUserGroupReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateWeChatConfiguration ¶

func (ctl *DMSController) UpdateWeChatConfiguration(c echo.Context) error

swagger:operation PATCH /v1/dms/configurations/wechat Configuration UpdateWeChatConfiguration

update wechat configuration.

--- parameters:

• name: update_wechat_configuration description: update wechat configuration in: body schema: "$ref": "#/definitions/UpdateWeChatConfigurationReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) UpdateWebHookConfiguration ¶

func (ctl *DMSController) UpdateWebHookConfiguration(c echo.Context) error

swagger:operation PATCH /v1/dms/configurations/webhook Configuration UpdateWebHookConfiguration

update webhook configuration.

--- parameters:

• name: webhook_config description: webhook configuration in: body schema: "$ref": "#/definitions/UpdateWebHookConfigurationReq"

responses:

'200':
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) VerifySmsCode ¶

func (ctl *DMSController) VerifySmsCode(context echo.Context) error

swagger:operation POST /v1/dms/configurations/sms/verify_code SMS VerifySmsCode

verify sms code.

--- parameters:

• name: code description: verify sms code required: true in: body schema: "$ref": "#/definitions/VerifySmsCodeReq"
• name: username description: user name required: true in: body schema: "$ref": "#/definitions/VerifySmsCodeReq"

responses:

'200':
  description: VerifySmsCodeReply
  schema:
    "$ref": "#/definitions/VerifySmsCodeReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) VerifyUserLogin ¶

func (ctl *DMSController) VerifyUserLogin(c echo.Context) error

swagger:operation POST /v1/dms/users/verify_user_login User VerifyUserLogin

Verify user login.

--- parameters:

• name: session in: body required: true description: Add a new session schema: "$ref": "#/definitions/AddSessionReq"

responses:

'200':
  description: VerifyUserLoginReply
  schema:
    "$ref": "#/definitions/VerifyUserLoginReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*DMSController) WebHookSendMessage ¶

func (ctl *DMSController) WebHookSendMessage(c echo.Context) error

swagger:operation POST /v1/dms/webhooks Webhook WebHookSendMessage

webhook send message.

--- parameters:

• name: webhook_message description: webhooks required: true in: body schema: "$ref": "#/definitions/WebHookSendMessageReq"

responses:

'200':
  description: WebHookSendMessageReply
  schema:
    "$ref": "#/definitions/WebHookSendMessageReply"
default:
  description: GenericResp
  schema:
    "$ref": "#/definitions/GenericResp"

func (*SqlWorkbenchController) GetSQLQueryConfiguration ¶

func (cc *SqlWorkbenchController) GetSQLQueryConfiguration(c echo.Context) error

swagger:route GET /v1/dms/configurations/sql_query CloudBeaver GetSQLQueryConfiguration

get sql_query configuration.

responses:
  200: body:GetSQLQueryConfigurationReply
  default: body:GenericResp

func (*SqlWorkbenchController) Shutdown ¶

func (cc *SqlWorkbenchController) Shutdown() error