API standards and multilingual preset SDKs
The OpenAPI of this product (dms-enterprise/2018-11-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
User management
|
API |
Title |
Description |
| AddInstance | AddInstance | This operation adds a database instance to Data Management (DMS) and lets you enable security hosting for the instance. |
| ModifyInstance | ModifyInstance | Modifies the basic and advanced information about a database instance in Data Management (DMS). The basic information includes the hosting mode of the instance, the instance account username and password, and features that are enabled for the instance. The advanced information includes the environment type, the instance name in DMS, and the timeout period for querying and exporting data. |
| RegisterInstance | RegisterInstance | Register a database instance in DMS. |
Instance management
|
API |
Title |
Description |
| GetOpLog | GetOpLog | Queries the details of operation logs that are generated in a specified period of time. |
| ListSQLExecAuditLog | ListSQLExecAuditLog | Queries the audit logs of SQL statements that are executed in Data Management (DMS). |
Operation audit
|
API |
Title |
Description |
| SetWorkflowExtraInfo | SetWorkflowExtraInfo | Configures whether the operation buttons, such as Agree, Revoke, and Sign, are displayed in the ticket approval section of the DMS console. |
Approval process
|
API |
Title |
Description |
| Logical databases and tables | Logical databases and tables | |
| CreateLogicDatabase | Create a Logical Database | Create a DMS logical database. |
| EditLogicDatabase | Return details of a logical database | Edit logical database information. |
| Data lake databases and tables | Data lake databases and tables | |
| ListDataLakeDatabase | ListDataLakeDatabase | Queries the list of databases in the data lake. |
| GetDataLakeDatabase | GetDataLakeDatabase | Queries the information about the database in the data lake. |
| ListDataLakeCatalog | ListDataLakeCatalog | Queries a list of data catalogs in a data lake. |
| GetDataLakeCatalog | GetDataLakeCatalog | Queries the data catalog of the data lake. |
| ListDataLakeTablebaseInfo | ListDataLakeTablebaseInfo | Queries basic information about tables in the data lake. |
| GetDataLakeTable | GetDataLakeTable | Queries basic information about tables in the data lake. |
| BatchCreateDataLakePartitions | BatchCreateDataLakePartitions | Creates data lake table partitions in batches. |
| UpdateDataLakeTable | UpdateDataLakeTable | Updates the information about a table in a data lakehouse. |
| UpdateDataLakePartition | UpdateDataLakePartition | Updates the partition information of a table in a data lakehouse. |
| UpdateDataLakeDatabase | UpdateDataLakeDatabase | Updates the information about a database in a data lakehouse. |
| ListDataLakeTableName | ListDataLakeTableName | Queries a list of names of tables in a data lake. |
| ListDataLakeTable | ListDataLakeTable | Queries a list of tables in a data lake. |
| ListDataLakePartitionName | ListDataLakePartitionName | Queries a list of partition names of a table in a data lake. |
| ListDataLakePartitionByFilter | ListDataLakePartitionByFilter | Lists data lake table partitions that match a filter condition. |
| ListDataLakePartition | ListDataLakePartition | Queries the partitions of a data lake table. |
| GetDataLakePartition | GetDataLakePartition | Call this API to retrieve details of a lake house table partition. |
| DeleteDataLakeTable | DeleteDataLakeTable | Deletes a table from a data lakehouse. |
| DeleteDataLakePartition | DeleteDataLakePartition | Deletes a partition from a table in a data lakehouse. |
| DeleteDataLakeDatabase | DeleteDataLakeDatabase | Deletes a database from a data lakehouse. |
| CreateDataLakeTable | CreateDataLakeTable | Creates a table in a data lakehouse. |
| CreateDataLakePartition | CreateDataLakePartition | Creates a partition for a table in a data lakehouse. |
| CreateDataLakeDatabase | CreateDataLakeDatabase | Creates a database in a data lakehouse. |
| BatchUpdateDataLakePartitions | BatchUpdateDataLakePartitions | Updates multiple partitions of a table in a data lakehouse at a time. |
| BatchDeleteDataLakePartitions | BatchDeleteDataLakePartitions | Deletes multiple partitions of a table in a data lakehouse at a time. |
| CreateDataLakeFunction | CreateDataLakeFunction | Call this API to create a new data lake user-defined function. |
| GetDataLakeFunction | GetDataLakeFunction | Call this API to retrieve the details of a data lake user-defined function. |
| UpdateDataLakeFunction | UpdateDataLakeFunction | Updates a user-defined function in a data lakehouse. |
| DeleteDataLakeFunction | DeleteDataLakeFunction | Deletes a user-defined function in a data lakehouse. |
| ListDataLakeFunction | ListDataLakeFunction | Queries data lake functions. |
| ListDataLakeFunctionName | ListDataLakeFunctionName | Gets a list of data lake function names. |
| SearchDatabase | SearchDatabase | Index Details. |
| ListTableColumns | ListTableColumns | Queries the details about fields in a table. |
| GetMetaTableDetailInfo | GetMetaTableDetailInfo | Call the GetMetaTableDetailInfo operation to get details about a table, such as its fields and indexes. |
| GetMetaTableColumn | GetMetaTableColumn | Queries the details of columns in a table. |
| GetTableKnowledgeInfo | GetTableKnowledgeInfo | Gets metadata knowledge for a specified GUID. |
| EditMetaKnowledgeAsset | EditMetaKnowledgeAsset | Edits the metadata business knowledge for specified GUIDs. |
Database and table metadata
|
API |
Title |
Description |
| Logical databases and tables | Logical databases and tables | |
| GetApprovalDetail | GetApprovalDetail | Queries the approval details of a ticket. |
| PreviewWorkflow | PreviewWorkflow | Previews the approval process of a ticket before the ticket is submitted. |
| Data lake databases and tables | Data lake databases and tables | |
| GetPermApplyOrderDetail | Obtain the details of a ticket for requesting operation permission | Invoke GetPermApplyOrderDetail to obtain the ticket details of a permission request. |
| Data change | Data change | |
| CreateDataCronClearOrder | Create a Historical Data Cleanup ticket | Create a Historical Data Cleanup ticket. |
| CreateDataImportOrder | Create a Data Import ticket | Create a Data Import ticket. |
| CreateFreeLockCorrectOrder | Create a lockless change ticket | Create a lockless change ticket. |
| ModifyDataCorrectExecSQL | Modify the SQL script of a data change ticket | Modify the SQL script submitted in a data change ticket. |
| GetDataCorrectBackupFiles | Obtain the backup file download URL | Obtain the download URL of the backup file for a data change ticket. |
| ExecuteDataCorrect | ExecuteDataCorrect | Execute a data change ticket. |
| RetryDataCorrectPreCheck | Re-execute the precheck of a data change ticket | Re-execute the precheck step of a data change ticket. |
| RestartDataCorrectSQLJob | Retry a failed data change SQL job | Retry a data change SQL job that has already failed to execute. |
| SkipDataCorrectRowCheck | Skip the row count validation in the data change precheck | Skip the row count validation in the data change precheck. |
| CreateProcCorrectOrder | CreateProcCorrectOrder | Creates a programmable object ticket. |
| Schema design | Schema design | |
| ListDDLPublishRecords | ListDDLPublishRecords | Queries the publishing details of a schema design ticket. |
| GetTableDesignProjectFlow | GetTableDesignProjectFlow | Queries the information about a schema design ticket, such as the current node of the ticket, whether the ticket can be returned to the schema design node, and the publishing strategy. |
| GetTableDesignProjectInfo | GetTableDesignProjectInfo | Queries the information about the project and change base database of a schema design ticket, such as the state of the ticket, the ID of the user who created the ticket, and the name and ID of the change base database. |
| Data export | Data export | |
| CreateDatabaseExportOrder | CreateDatabaseExportOrder | Creates a database export ticket. |
| CreateDataExportOrder | CreateDataExportOrder | Creates a ticket to export an SQL result set. |
| GetDatabaseExportOrderDetail | GetDatabaseExportOrderDetail | Queries the details of a database export ticket. |
| GetDbExportDownloadURL | GetDbExportDownloadURL | Queries the download URL of the results of a database export ticket. |
| SuspendDataExportJob | SuspendDataExportJob | Suspends an ongoing or scheduled SQL result set export task. |
| PauseDataExportJob | PauseDataExportJob | Terminates a SQL result set export task. |
| RemoveDataExportJob | RemoveDataExportJob | Deletes a data export task. |
| RestartDataExportJob | RestartDataExportJob | Restarts a SQL result set export task. |
| SQL review | SQL review | |
| CreateSQLReviewOrder | CreateSQLReviewOrder | Creates a SQL review ticket. |
| GetSQLReviewOptimizeDetail | GetSQLReviewOptimizeDetail | Queries the details of optimization suggestions. The operation applies only to the tickets for the data changes and SQL review. |
| Data tracking | Data tracking | |
| CreateDataTrackOrder | CreateDataTrackOrder | Creates a data tracking ticket. |
| Data archiving | Data archiving | |
| CreateDataArchiveOrder | CreateDataArchiveOrder | Creates a data archiving ticket to archive data to destinations such as dedicated storage space or ApsaraDB RDS for MySQL instances. |
| GetDataArchiveOrderDetail | GetDataArchiveOrderDetail | Queries the details of a data archiving ticket, including the time when the ticket was created, the scheduling information of the data archiving task, the logs of the data archiving task, and the database to which data is archived. |
| GetPagedInstance | GetPagedInstance | Queries the task information about a ticket. |
Ticket operations
|
API |
Title |
Description |
| ListDBTaskSQLJobDetail | ListDBTaskSQLJobDetail | Gets the details of the SQL task. |
| Database and table synchronization | Database and table synchronization | |
| Data change | Data change | |
| Schema design | Schema design | |
| Data export | Data export | |
| SQL review | SQL review | |
| Data tracking | Data tracking | |
| Attachment upload | Attachment upload | |
| Data archiving | Data archiving |
SQL tasks
|
API |
Title |
Description |
| ListInstanceUserPermissions | ListInstanceUserPermissions | Queries the permissions of a user on an instance. |
| ListUserPermissions | ListUserPermissions | Queries the permissions of a user on databases and tables. |
| ListAuthorizedInstancesForUser | ListAuthorizedInstancesForUser | Queries the instances on which the specified user has permissions. |
| ListAuthorizedUsersForInstance | ListAuthorizedUsersForInstance | Queries a list of users that have permissions on the specified instance. |
| ListAuthorizedDatabasesForUser | ListAuthorizedDatabasesForUser | Queries the databases on which the specified user has permissions. |
| ListAuthorizedUsersForDatabase | ListAuthorizedUsersForDatabase | Queries a list of users that have permissions on the specified database. |
Permission management
|
API |
Title |
Description |
| Security rules | Security rules | |
| CreateStandardGroup | CreateStandardGroup | Creates a security rule set. |
| ListStandardGroups | ListStandardGroups | Queries security rule sets. |
| UpdateStandardGroup | UpdateStandardGroup | Modifies the name and description of a specific security rule set. |
| DeleteStandardGroup | DeleteStandardGroup | Deletes a security rule set. |
| GetStandardGroup | GetStandardGroup | Queries the information about security rule sets of a tenant. The information includes the name and description of security rules, and instances associated with security rules. |
| Sensitive data management | Sensitive data management | |
| AddDesensitizationRule | AddDesensitizationRule | Adds a masking rule. |
| ListDesensitizationRule | ListDesensitizationRule | Queries a list of masking rules. |
| ListSensitiveDataAuditLog | ListSensitiveDataAuditLog | Queries the audit logs for sensitive information. |
| ChangeColumnSecurityLevel | ChangeColumnSecurityLevel | Changes the security level of a column. |
| GetClassificationTemplate | GetClassificationTemplate | Queries the information about the classification and grading template associated with an instance. |
| ListSensitiveColumnInfo | ListSensitiveColumnInfo | Queries the information about a sensitive field. The information includes the masking algorithm ID, masking algorithm name, and field security level. |
| Secure access proxy | Secure access proxy | |
| CreateProxy | CreateProxy | Enables the secure access proxy feature for a database instance. |
| ListProxyAccesses | ListProxyAccesses | Queries information about users that are authorized to access a database instance by using the secure access proxy feature. |
| GetProxyAccess | GetProxyAccess | Queries the authorization information about the secure access proxy feature. |
| Permission templates | Permission templates | |
| GrantTemplateAuthority | GrantTemplateAuthority | Grants permissions on resources to users by using a permission template. |
| CreateAuthorityTemplate | CreateAuthorityTemplate | Creates a permission template |
| UpdateAuthorityTemplate | UpdateAuthorityTemplate | Modifies a permission template. |
| AddAuthorityTemplateItems | AddAuthorityTemplateItems | Adds instances, databases, and tables to the specified permission template. |
| GetAuthorityTemplate | GetAuthorityTemplate | Queries the information about a permission template. |
| ListAuthorityTemplate | ListAuthorityTemplate | Queries the information about permission templates, including the template creator, template name, and total number of templates. |
| DeleteAuthorityTemplate | DeleteAuthorityTemplate | Deletes a permission template. |
| Permission policies | Permission policies | |
| CreateAbacPolicy | CreateAbacPolicy | Creates a policy to manage the permissions on DMS features and data resources managed in DMS in a fine-grained manner. |
| ListAbacPolicies | ListAbacPolicies | Queries a list of policies that are created by a user. |
| UpdateAbacPolicy | UpdateAbacPolicy | Updates the name, description, or content of a policy. |
| DeleteAbacPolicy | DeleteAbacPolicy | Deletes a created permission policy. |
| GetAbacPolicy | GetAbacPolicy | Queries the details of a policy, including the name, content, and the user who created the policy. |
| CreateAbacAuthorization | CreateAbacAuthorization | Attaches a system policy or custom policy to a DMS user or custom role. |
| ListAbacAuthorizations | ListAbacAuthorizations | Queries a list of users to which the specified policy is attached and the number of the users. |
| DeleteAbacAuthorization | DeleteAbacAuthorization | Detaches a policy from a user or role. |
Security management
|
API |
Title |
Description |
| ExecuteScript | Execute SQL script | Executes an SQL script. |
| Sensitive data management | Sensitive data management | |
| Secure access proxy | Secure access proxy | |
| Permission templates | Permission templates | |
| Access policies | Access policies |
Data query
|
API |
Title |
Description |
| Task orchestration | Task orchestration | |
| UpdateScenario | UpdateScenario | Updates the name and description of the business scenario for a specified task flow. |
| ListTaskFlowsByPage | ListTaskFlowsByPage | Queries the details of task flows by page. |
| ListTaskFlowTimeVariables | ListTaskFlowTimeVariables | Lists the time variables for a task flow. |
| CreateScenario | CreateScenario | Creates a business scenario to group task flows by business scenario. |
| UpdateTaskOutput | UpdateTaskOutput | Updates the output variables for a task node. |
| ListTasksInTaskFlow | ListTasksInTaskFlow | Queries the tasks in a specified task flow. |
| CreateTaskFlow | CreateTaskFlow | Creates a task flow. |
| UpdateTaskContentV2 | UpdateTaskContentV2 | Updates the node content in large SQL files. |
| TryRunTaskFlow | TryRunTaskFlow | Tests the task flow of task orchestration. |
| Data warehouse development | Data warehouse development | |
| CreateLakeHouseSpace | CreateLakeHouseSpace | Creates a workspace for data warehouse development in Data Management (DMS). |
| AddLhMembers | Add project space administrators, space members, or task stream developers | Invoke the AddLhMembers API to add administrators, members, or task stream developers to a DMS data warehouse development project space. |
| DeleteLhMembers | Delete a project space member or a task stream developer | Invoke the DeleteLhMembers API to delete members from a DMS data warehouse development project space or developers from a task stream. |
Data development
|
API |
Title |
Description |
| ListEffectiveOrders | ListEffectiveOrders | Queries valid orders. |
| Data warehouse development | Data warehouse development |
Sales orders
|
API |
Title |
Description |
| CreateMetaCategory | Create an asset category | Create an asset category. |
| ListMetaCategory | ListMetaCategory | Queries a list of categories |
| UpdateMetaCategory | Update Asset Category Information | Update asset category information. |
| DeleteMetaCategory | DeleteMetaCategory | Deletes an asset category. |
| ListTablesInCategory | ListTablesInCategory | Obtains the list of tables in a category. |
| AddTableToCategory | AddTableToCategory | Add a table to an asset category. |
| RemoveTableFromCategory | RemoveTableFromCategory | Removes table from the asset category. |
Asset categories
|
API |
Title |
Description |
| OptimizeSqlByMetaAgent | OptimizeSqlByMetaAgent | Analyzes and optimizes the SQL statements in the specified database. |
| FixSqlByMetaAgent | FixSqlByMetaAgent | Uses the specified SQL statement, error message, and database ID to analyze and fix the SQL error. |
| AnswerSqlSyntaxByMetaAgent | AnswerSqlSyntaxByMetaAgent | Answers the syntax questions of the corresponding engine according to the specified database ID. |
| ListUserOwnedResources | ListUserOwnedResources | Obtains |
| CheckBatchTableAccessPermission | CheckBatchTableAccessPermission | Batch verify table permissions. |
| AddLogicTableRouteConfig | AddLogicTableRouteConfig | Adds a routing algorithm to a logical table. |
| AddTaskFlowEdges | AddTaskFlowEdges | Creates directed edges for the existing task nodes of a task flow. |
| AddWorkspaceUser | AddWorkspaceUser | Adds a user to a workspace. |
| ApproveOrder | ApproveOrder | Reviews a ticket. |
| BackFill | BackFill | Backfills data for a task flow. |
| ChangeColumnSecLevel | ChangeColumnSecLevel | Adjusts the sensitivity level of fields. |
| ChangeLhDagOwner | ChangeLhDagOwner | Transfers the ownership of a task flow in a workspace of Data Management (DMS). |
| CheckInventoryJob | CheckInventoryJob | Queries the execution status and progress of an asset inventory task. |
| CloseOrder | CloseOrder | Closes a ticket. |
| ConfirmInventoryKnowledge | ConfirmInventoryKnowledge | Marks a specific knowledge entity from an inventory task as certified. |
| CreateDataCorrectOrder | CreateDataCorrectOrder | Creates a ticket for changing data in Data Management (DMS). |
| CreateForecastAgent | CreateForecastAgent | Creates a forecast agent. |
| CreateInventoryJob | Create an inventory task | Creates an asset inventory task to perform knowledge inventory on specified instances, databases, or tables. |
| CreateOrder | Create Ticket | Create a ticket. |
| CreateProxyAccess | CreateProxyAccess | Grants a user the permissions to access a database instance by using the secure access proxy feature. |
| CreatePublishGroupTask | CreatePublishGroupTask | Executes a schema design ticket. |
| CreateStructSyncOrder | CreateStructSyncOrder | Creates a schema synchronization ticket. |
| CreateTask | CreateTask | Creates a task node for a task flow. |
| CreateUploadFileJob | CreateUploadFileJob | Creates a task to upload an attachment file. |
| CreateUploadOSSFileJob | CreateUploadOSSFileJob | Creates a task to upload an Object Storage Service (OSS) file and obtain the key of the task. |
| CreateWorkspace | CreateWorkspace | Creates a workspace. |
| DeleteInstance | DeleteInstance | Removes a database instance from Data Management (DMS). |
| DeleteLakeHouseSpace | DeleteLakeHouseSpace | Deletes a workspace. |
| DeleteLogicDatabase | DeleteLogicDatabase | Deletes a logical database from Data Management (DMS). This operation only deletes the specified logical database but does not delete physical databases. |
| DeleteLogicTableRouteConfig | DeleteLogicTableRouteConfig | Deletes a routing algorithm from a logical table. |
| DeleteProxy | DeleteProxy | You can call this operation to disable the data security protection proxy of a DB instance. |
| DeleteProxyAccess | DeleteProxyAccess | Revokes the permissions to access a database instance by using the secure access proxy feature from a user. |
| DeleteScenario | DeleteScenario | Deletes a business scenario. |
| DeleteTask | DeleteTask | Deletes a task in a specified task flow. |
| DeleteTaskFlow | DeleteTaskFlow | Deletes a task flow. |
| DeleteTaskFlowEdgesByCondition | DeleteTaskFlowEdgesByCondition | Deletes task flow edges based on multiple conditions. |
| DeleteUser | DeleteUser | Deletes an Alibaba Cloud account that is no longer used. |
| DeleteWorkspace | DeleteWorkspace | Deletes a workspace. |
| DescribeInventoryFileUploadSignature | Retrieve upload credentials for asset information collection | Retrieves OSS direct upload credentials for asset information collection files. |
| DisableUser | DisableUser | Disables a user that is temporarily not used in Data Management (DMS). |
| DownloadDataTrackResult | DownloadDataTrackResult | Downloads the parsing result of a data tracking task. |
| EnableUser | EnableUser | Enables a user that is disabled. |
| ExecuteDataExport | ExecuteDataExport | Executes a data export ticket. |
| ExecuteStructSync | ExecuteStructSync | Executes a schema synchronization task. |
| ExportInventoryAsset | Export inventory asset knowledge | Exports the full list of table assets under an inventory task as an XLSX file. |
| ExportInventoryKnowledge | Export knowledge from inventory results | Exports the full list of knowledge produced by an inventory task as an XLSX file. |
| GetAIOrderApprovalCommentSSE | GetAIOrderApprovalCommentSSE | Gets approval suggestions for a ticket from a Large Language Model (LLM). |
| GetAuthorityTemplateItem | GetAuthorityTemplateItem | Queries the resources in a permission template. |
| GetDBTaskSQLJobLog | GetDBTaskSQLJobLog | Queries the log that records the scheduling details of an SQL task. |
| GetDBTopology | GetDBTopology | Queries the topologies of a logical database and its physical database shards. |
| GetDataArchiveCount | GetDataArchiveCount | Queries the statistics on the number of data archiving tickets, including the number of tickets of successful data archiving, failed data archiving,and in-progress data archiving, and the total number of data archiving tickets. |
| GetDataCorrectOrderDetail | GetDataCorrectOrderDetail | Queries the information about a data change ticket in Data Management (DMS). |
| GetDataCorrectRollbackFile | GetDataCorrectRollbackFile | Queries the download URL of the rollback attachment submitted along with a data change ticket. |
| GetDataCorrectSQLFile | GetDataCorrectSQLFile | Queries the download URL of the SQL script for a data change task. |
| GetDataCorrectTaskDetail | GetDataCorrectTaskDetail | Queries the information about a data change, lock-free data change, or data import task. |
| GetDataCronClearConfig | GetDataCronClearConfig | Queries the scheduling configuration of a ticket for cleaning up historical data. |
| GetDataCronClearTaskDetailList | GetDataCronClearTaskDetailList | Queries the details of a historical data cleansing ticket. |
| GetDataExportDownloadURL | GetDataExportDownloadURL | Queries the download URL of export results for a data export ticket. |
| GetDataExportOrderDetail | GetDataExportOrderDetail | Queries the information about a data export ticket. |
| GetDataExportPreCheckDetail | GetDataExportPreCheckDetail | Queries the precheck details of an SQL result set export ticket. |
| GetDataImportSQL | GetDataImportSQL | Queries the SQL statements used for data import in a ticket. |
| GetDataTrackJobDegree | GetDataTrackJobDegree | Queries the progress of a data tracking task. |
| GetDataTrackJobTableMeta | GetDataTrackJobTableMeta | Queries the metadata of tables involved in a data tracking task. |
| GetDataTrackOrderDetail | GetDataTrackOrderDetail | Queries the details of a data tracking ticket. |
| GetDatabase | Obtain detailed information about a specific database. | Gets the details of a specified Database. |
| GetForecastAgentInstance | GetForecastAgentInstance | Retrieves a list of forecast agent instances. |
| GetInstance | GetInstance | Gets the details of a specified instance. |
| GetIntervalLimitOfSLA | GetIntervalLimitOfSLA | Queries the minimum scheduling cycle of a task flow when a service level agreement (SLA) timeout rule is configured for the task flow. |
| GetLhSpaceByName | GetLhSpaceByName | Queries the information about a workspace based on the workspace name in Data Management (DMS). |
| GetLogicDatabase | GetLogicDatabase | Queries the details of a logical database. |
| GetOnlineDDLProgress | GetOnlineDDLProgress | Queries the details and progress of an OnlineDDL task. |
| GetOrderAttachmentFile | GetOrderAttachmentFile | Queries the download URL of the attachment of a ticket. |
| GetOrderBaseInfo | GetOrderBaseInfo | Queries the basic information about a ticket. |
| GetOwnerApplyOrderDetail | GetOwnerApplyOrderDetail | Queries the details of the Database-OWNER, Table-OWNER, and Instance-OWNER tickets. |
| GetPhysicalDatabase | GetPhysicalDatabase | Queries the details of a physical database. |
| GetProxy | GetProxy | Queries the details of a secure access proxy. |
| GetRuleNumLimitOfSLA | GetRuleNumLimitOfSLA | Queries the maximum number of custom service-level agreement (SLA) rules for task orchestration. |
| GetSQLReviewCheckResultStatus | GetSQLReviewCheckResultStatus | Queries the result of an SQL review. |
| GetStructSyncExecSqlDetail | GetStructSyncExecSqlDetail | Queries the SQL statements that are involved in a schema synchronization ticket. |
| GetStructSyncJobAnalyzeResult | GetStructSyncJobAnalyzeResult | Queries the analysis result of a schema synchronization task. |
| GetStructSyncJobDetail | GetStructSyncJobDetail | Queries the information of a schema synchronization task. |
| GetStructSyncOrderDetail | GetStructSyncOrderDetail | Queries the details of a schema synchronization ticket. |
| GetTableColumnList | GetTableColumnList | Retrieves the details for each column in a table, including metadata, business descriptions, and security level. |
| GetTableDBTopology | GetTableDBTopology | Queries the topology of a data table. |
| GetTableInstructions | GetTableInstructions | Retrieves usage instructions and business context for a table, including its business description, summary, and related assets. |
| GetTableKnowledgeDetails | GetTableKnowledgeDetails | Retrieves the asset knowledge details for a table, including its metadata, business description, and a list of fields. |
| GetTableTopology | GetTableTopology | Queries the topology of a table. |
| GetTask | GetTask | Queries the configurations, including time variables, of a specified task node based on the task node ID. |
| GetTaskFlowGraph | GetTaskFlowGraph | Queries the Directed Acyclic Graph (DAG) of a task flow. |
| GetTaskFlowNotification | GetTaskFlowNotification | Queries the notification settings for task flows. |
| GetTaskInstanceRelation | GetTaskInstanceRelation | Queries the task nodes of a task flow instance. |
| GetUser | GetUser | Queries the information about a user. |
| GetUserActiveTenant | GetUserActiveTenant | Queries details of the active tenant. |
| GetUserUploadFileJob | GetUserUploadFileJob | Obtains the information of a file upload task. |
| GetWorkspace | GetWorkspace | Queries the details of a workspace. |
| GrantUserPermission | GrantUserPermission | Grants permissions on an instance, a database, or a table to a user. |
| InspectProxyAccessSecret | InspectProxyAccessSecret | You can call this operation to obtain the authorization password of the security protection agent InspectProxyAccessSecret. |
| ListClassificationTemplates | ListClassificationTemplates | Queries the classification templates. |
| ListColumns | ListColumns | Returns the column information of a table. |
| ListDAGVersions | ListDAGVersions | Queries the published versions of a task flow. |
| ListDBTaskSQLJob | ListDBTaskSQLJob | Queries a list of SQL tasks. |
| ListDataCorrectPreCheckDB | ListDataCorrectPreCheckDB | Queries the databases that are involved in the precheck of a data change ticket. |
| ListDataCorrectPreCheckSQL | ListDataCorrectPreCheckSQL | Queries the information about SQL statements that are involved in the precheck of a data change ticket. |
| ListDataImportSQLPreCheckDetail | ListDataImportSQLPreCheckDetail | Queries the precheck information of SQL statements used for data import in a ticket. |
| ListDataImportSQLType | ListDataImportSQLType | Queries the types of SQL statements used for data import in a ticket. |
| ListDatabaseUserPermssions | ListDatabaseUserPermssions | Queries the permissions of users on a database. |
| ListDatabases | ListDatabases | Invoke ListDatabases to retrieve the list of databases for an instance. |
| ListDefaultSLARules | ListDefaultSLARules | Queries the default service level agreement (SLA) timeout rules. |
| ListIndexes | ListIndexes | Queries the indexes of a table. |
| ListInstanceLoginAuditLog | ListInstanceLoginAuditLog | Queries the logon records of an instance. |
| ListInstances | List instances | Retrieves a list of instances by calling the ListInstances operation. |
| ListInventoryJobs | ListInventoryJobs | Retrieves a paginated list of asset inventory jobs. |
| ListLhTaskFlowAndScenario | ListLhTaskFlowAndScenario | Queries the information about task flows in the business scenarios of a workspace in Data Management (DMS). |
| ListLogicDatabases | ListLogicDatabases | Queries the detailed information about logical databases. |
| ListLogicTableRouteConfig | ListLogicTableRouteConfig | Queries the routing algorithms of a logical table. |
| ListLogicTables | ListLogicTables | Queries the details of the logical tables in a logical database. |
| ListOrders | ListOrders | You can call ListOrders to retrieve a list of tickets. |
| ListProxies | ListProxies | Queries the proxies that are generated by the secure access proxy feature. |
| ListProxySQLExecAuditLog | ListProxySQLExecAuditLog | Queries the audit logs generated by the secure access proxy feature. |
| ListSLARules | ListSLARules | Queries the custom service level agreement (SLA) rules of a task flow. |
| ListSQLReviewOriginSQL | ListSQLReviewOriginSQL | Queries the details of the SQL statements that are involved in an SQL review ticket. |
| ListScenarios | ListScenarios | Queries business scenarios. |
| ListSensitiveColumns | ListSensitiveColumns | Queries sensitive fields in a table of a database. |
| ListSensitiveColumnsDetail | ListSensitiveColumnsDetail | Queries the details of a sensitive field. |
| ListSensitivityLevel | ListSensitivityLevel | Queries the sensitivity levels of a classification template. |
| ListTables | ListTables | Lists the details of all tables in a database. |
| ListTagMetaAsset | ListTagMetaAsset | Lists Database and Table assets associated with a specific Tag in a DataAgent Workspace. |
| ListTaskFlow | ListTaskFlow | Queries a list of task flows. |
| ListTaskFlowConstants | ListTaskFlowConstants | Queries the constants for a task flow. |
| ListTaskFlowCooperators | ListTaskFlowCooperators | Queries a list of users that are involved in a task flow. |
| ListTaskFlowEdgesByCondition | ListTaskFlowEdgesByCondition | Queries the edges of the directed acyclic graph (DAG) for a task flow based on multiple conditions. |
| ListTaskFlowInstance | ListTaskFlowInstance | Queries the execution records of a task flow. |
| ListUserTenants | ListUserTenants | Queries tenants. |
| ListUsers | ListUsers | Queries the details of users. |
| ListWorkFlowNodes | ListWorkFlowNodes | Queries approval nodes. |
| ListWorkFlowTemplates | ListWorkFlowTemplates | Queries approval templates. |
| ListWorkspaceUsers | ListWorkspaceUsers | Lists the users in a specified workspace. |
| ListWorkspaces | ListWorkspaces | Queries a list of workspaces of the tenant. |
| MakeTaskFlowInstanceSuccess | MakeTaskFlowInstanceSuccess | Sets the status of a task flow to "Successful". |
| ModifyDesensitizationStrategy | ModifyDesensitizationStrategy | Modifies the masking rule bound to a specified field. |
| MoveTaskFlowToScenario | MoveTaskFlowToScenario | Migrates a task flow to a specified business scenario. |
| OfflineTaskFlow | OfflineTaskFlow | Unpublishes a published task flow in Data Management (DMS). |
| PauseDataCorrectSQLJob | PauseDataCorrectSQLJob | Pauses a SQL task for data change. |
| PublishAndDeployTaskFlow | PublishAndDeployTaskFlow | Publishes and deploys a task flow. |
| QueryDataTrackResultDownloadStatus | QueryDataTrackResultDownloadStatus | Queries the download and parsing progress of data tracking logs. |
| ReDeployLhDagVersion | ReDeployLhDagVersion | Redeploys the published versions of a task flow. |
| ReRunTaskFlowInstance | ReRunTaskFlowInstance | Reruns a task flow instance. |
| RefundPayAsYouGoOrder | RefundPayAsYouGoOrder | Unsubscribes from a pay-as-you-go Data Management (DMS) resource. |
| RegisterUser | RegisterUser | Adds a user of your enterprise. |
| RemoveWorkspaceUser | RemoveWorkspaceUser | Removes a user from a workspace. |
| ResumeTaskFlowInstance | ResumeTaskFlowInstance | Resumes a suspended task flow instance. |
| RevokeTemplateAuthority | RevokeTemplateAuthority | Revokes permissions on resources from Data Management (DMS) users by using a permission template. |
| RevokeUserPermission | RevokeUserPermission | Revokes the permissions on instances, databases, and tables from a user. |
| SearchDataTrackResult | SearchDataTrackResult | Searches for the parsing result of a data tracking task. |
| SearchInventoryAsset | SearchInventoryAsset | Retrieves a paginated list of table assets from a specific inventory task. |
| SearchInventoryKnowledge | SearchInventoryKnowledge | Retrieves a paginated list of knowledge generated by an inventory task. You can filter the results by keyword, knowledge type, and other criteria. |
| SearchTable | SearchTable | Queries detailed information about tables. |
| SearchTableAssetKnowledge | SearchTableAssetKnowledge | Queries a paginated list of asset knowledge related to a specific table. This knowledge includes information about tables, columns, SQL statements, and snippets. |
| SearchTableKnowledge | SearchTableKnowledge | Searches for Table Knowledge based on a user's query. |
| SearchWorkspaceRoles | SearchWorkspaceRoles | Searches for roles in a workspace. |
| SetForecastAgentInstance | SetForecastAgentInstance | Sets the credentials for an instance. |
| SetOwners | SetOwners | Configures the owner of an instance, a database, or a table. |
| StopTaskFlowInstance | StopTaskFlowInstance | Stops a task flow instance. |
| SubmitOrderApproval | SubmitOrderApproval | Submits a ticket for approval. |
| SubmitStructSyncOrderApproval | SubmitStructSyncOrderApproval | Submits a schema synchronization ticket for approval. |
| SuspendTaskFlowInstance | SuspendTaskFlowInstance | Suspends a task flow instance. |
| SyncDatabaseMeta | SyncDatabaseMeta | Synchronizes the metadata of a database. |
| SyncInstanceMeta | SyncInstanceMeta | Synchronizes the metadata of all databases in a database instance. |
| UpdateInstance | UpdateInstance | Updates the information about a database instance and checks the connectivity of the database instance. |
| UpdateSLARules | UpdateSLARules | Updates the timeout reminder for the service level agreement (SLA) rules of a task flow. |
| UpdateTaskConfig | UpdateTaskConfig | Updates the advanced configuration of a task node. |
| UpdateTaskContent | UpdateTaskContent | Updates tasks in a task flow. |
| UpdateTaskFlowConstants | UpdateTaskFlowConstants | Updates the constants for a specified task flow. |
| UpdateTaskFlowCooperators | UpdateTaskFlowCooperators | Updates the IDs of the users that are involved in a task flow. |
| UpdateTaskFlowEdges | UpdateTaskFlowEdges | Updates the start node and end node of multiple edges at a time for a task flow. |
| UpdateTaskFlowNameAndDesc | UpdateTaskFlowNameAndDesc | Updates the name and description of a task flow. |
| UpdateTaskFlowNotification | UpdateTaskFlowNotification | Updates the notification settings for a task flow. |
| UpdateTaskFlowOwner | UpdateTaskFlowOwner | Changes the owner of a task flow. |
| UpdateTaskFlowRelations | UpdateTaskFlowRelations | Fully updates the edges of a task flow. |
| UpdateTaskFlowSchedule | UpdateTaskFlowSchedule | Updates the scheduling properties for a task flow. |
| UpdateTaskFlowTimeVariables | UpdateTaskFlowTimeVariables | Updates the time variables for a task flow. |
| UpdateTaskName | UpdateTaskName | Updates the name of a specified task. |
| UpdateTaskTimeVariables | UpdateTaskTimeVariables | Updates time variables for a task. |
| UpdateUser | UpdateUser | Updates user information. |
| UpdateWorkspace | UpdateWorkspace | Updates the information about a workspace. |
| UpdateWorkspaceUser | UpdateWorkspaceUser | Updates the roles of a user in a workspace. |