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 |
| DeleteUser | DeleteUser | Deletes an Alibaba Cloud account that is no longer used. |
| UpdateUser | UpdateUser | Updates user information. |
| DisableUser | DisableUser | Disables a user that is temporarily not used in Data Management (DMS). |
| EnableUser | EnableUser | Enables a user that is disabled. |
| ListUsers | ListUsers | Queries the details of users. |
| GetUser | GetUser | Queries the information about a user. |
| GetUserActiveTenant | GetUserActiveTenant | Queries details of the active tenant. |
| ListUserTenants | ListUserTenants | Queries tenants. |
| RegisterUser | RegisterUser | Adds a user of your enterprise. |
Instance management
|
API |
Title |
Description |
| AddInstance | Register a database instance | Registers a database instance in Data Management Service (DMS) and enables 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. |
| ListInstances | Retrieve instance list | Retrieves a list of instances. |
| GetInstance | GetInstance | Gets the details of a specified instance. |
| DeleteInstance | DeleteInstance | Removes a database instance from Data Management (DMS). |
| RegisterInstance | RegisterInstance | Register a database instance in DMS. |
| UpdateInstance | UpdateInstance | Updates the information about a database instance and checks the connectivity of the database instance. |
Operation audit
|
API |
Title |
Description |
| GetOpLog | GetOpLog | Queries the details of operation logs that are generated in a specified period of time. |
| ListInstanceLoginAuditLog | ListInstanceLoginAuditLog | Queries the logon records of an instance. |
| ListProxySQLExecAuditLog | ListProxySQLExecAuditLog | Queries the audit logs generated by the secure access proxy feature. |
| ListSQLExecAuditLog | ListSQLExecAuditLog | Queries the audit logs of SQL statements that are executed in Data Management (DMS). |
Approval process
|
API |
Title |
Description |
| ListWorkFlowTemplates | ListWorkFlowTemplates | Queries approval templates. |
| ListWorkFlowNodes | ListWorkFlowNodes | Queries approval nodes. |
| SetWorkflowExtraInfo | SetWorkflowExtraInfo | Configures whether the operation buttons, such as Agree, Revoke, and Sign, are displayed in the ticket approval section of the DMS console. |
Database and table metadata
|
API |
Title |
Description |
| Logical databases and tables | Logical databases and tables | |
| CreateLogicDatabase | Create a Logical Database | Create a DMS logical database. |
| AddLogicTableRouteConfig | AddLogicTableRouteConfig | Adds a routing algorithm to a logical table. |
| 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. |
| ListLogicDatabases | ListLogicDatabases | Queries the detailed information about logical databases. |
| GetLogicDatabase | GetLogicDatabase | Queries the details of a logical database. |
| ListLogicTables | ListLogicTables | Queries the details of the logical tables in a logical database. |
| GetDBTopology | GetDBTopology | Queries the topologies of a logical database and its physical database shards. |
| GetTableDBTopology | GetTableDBTopology | Queries the topology of a data table. |
| ListLogicTableRouteConfig | ListLogicTableRouteConfig | Queries the routing algorithms of a logical table. |
| 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. |
| SearchTable | SearchTable | Queries detailed information about tables. |
| ListDatabases | ListDatabases | Invoke ListDatabases to retrieve the list of databases for an instance. |
| ListTables | ListTables | Lists the details of all tables in a database. |
| ListTableColumns | ListTableColumns | Queries the details about fields in a table. |
| ListColumns | ListColumns | Returns the column information of a table. |
| ListIndexes | ListIndexes | Queries the indexes of a table. |
| GetDatabase | Obtain detailed information about a specific database. | Gets the details of a specified Database. |
| GetPhysicalDatabase | GetPhysicalDatabase | Queries the details of a physical database. |
| GetTableTopology | GetTableTopology | Queries the topology of 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. |
| SyncInstanceMeta | SyncInstanceMeta | Synchronizes the metadata of all databases in a database instance. |
| SyncDatabaseMeta | SyncDatabaseMeta | Synchronizes the metadata of a database. |
| GetTableKnowledgeInfo | GetTableKnowledgeInfo | Gets metadata knowledge for a specified GUID. |
| EditMetaKnowledgeAsset | EditMetaKnowledgeAsset | Edits the metadata business knowledge for specified GUIDs. |
Ticket operations
|
API |
Title |
Description |
| General | General | |
| CreateOrder | Create a ticket | Creates a ticket. |
| GetApprovalDetail | GetApprovalDetail | Queries the approval details of a ticket. |
| ListOrders | ListOrders | You can call ListOrders to retrieve a list of tickets. |
| GetOrderBaseInfo | GetOrderBaseInfo | Queries the basic information about a ticket. |
| SubmitOrderApproval | SubmitOrderApproval | Submits a ticket for approval. |
| ApproveOrder | ApproveOrder | Reviews a ticket. |
| CloseOrder | CloseOrder | Closes a ticket. |
| GetOrderAttachmentFile | GetOrderAttachmentFile | Queries the download URL of the attachment of a ticket. |
| PreviewWorkflow | PreviewWorkflow | Previews the approval process of a ticket before the ticket is submitted. |
| Permission application | Permission application | |
| GetOwnerApplyOrderDetail | GetOwnerApplyOrderDetail | Queries the details of the Database-OWNER, Table-OWNER, and Instance-OWNER tickets. |
| GetPermApplyOrderDetail | Obtain the details of a ticket for requesting operation permission | Invoke GetPermApplyOrderDetail to obtain the ticket details of a permission request. |
| Database and table synchronization | Database and table synchronization | |
| CreateStructSyncOrder | CreateStructSyncOrder | Creates a schema synchronization ticket. |
| GetStructSyncOrderDetail | GetStructSyncOrderDetail | Queries the details of a schema synchronization ticket. |
| GetStructSyncJobDetail | GetStructSyncJobDetail | Queries the information of a schema synchronization task. |
| GetStructSyncJobAnalyzeResult | GetStructSyncJobAnalyzeResult | Queries the analysis result of a schema synchronization task. |
| GetStructSyncExecSqlDetail | GetStructSyncExecSqlDetail | Queries the SQL statements that are involved in a schema synchronization ticket. |
| SubmitStructSyncOrderApproval | SubmitStructSyncOrderApproval | Submits a schema synchronization ticket for approval. |
| ExecuteStructSync | ExecuteStructSync | Executes a schema synchronization task. |
| Data change | Data change | |
| CreateDataCorrectOrder | CreateDataCorrectOrder | Creates a ticket for changing data in Data Management (DMS). |
| 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. |
| PauseDataCorrectSQLJob | PauseDataCorrectSQLJob | Pauses a SQL task for data change. |
| GetDataCorrectTaskDetail | GetDataCorrectTaskDetail | Queries the information about a data change, lock-free data change, or data import task. |
| GetDataCronClearTaskDetailList | GetDataCronClearTaskDetailList | Queries the details of a historical data cleansing ticket. |
| GetDataCorrectRollbackFile | GetDataCorrectRollbackFile | Queries the download URL of the rollback attachment submitted along with a data change ticket. |
| GetDataCorrectBackupFiles | Obtain the backup file download URL | Obtain the download URL of the backup file for a data change ticket. |
| GetDataCorrectOrderDetail | GetDataCorrectOrderDetail | Queries the information about a data change ticket in Data Management (DMS). |
| GetDataCronClearConfig | GetDataCronClearConfig | Queries the scheduling configuration of a ticket for cleaning up historical data. |
| GetDataCorrectSQLFile | GetDataCorrectSQLFile | Queries the download URL of the SQL script for a data change task. |
| ListDataCorrectPreCheckSQL | ListDataCorrectPreCheckSQL | Queries the information about SQL statements that are involved in the precheck of a data change ticket. |
| ListDataCorrectPreCheckDB | ListDataCorrectPreCheckDB | Queries the databases that are involved in the precheck of 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. |
| 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. |
| GetDataImportSQL | GetDataImportSQL | Queries the SQL statements used for data import in a ticket. |
| 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 | |
| CreatePublishGroupTask | CreatePublishGroupTask | Executes a schema design ticket. |
| 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. |
| ExecuteDataExport | ExecuteDataExport | Executes a data export ticket. |
| GetDataExportPreCheckDetail | GetDataExportPreCheckDetail | Queries the precheck details of an SQL result set export ticket. |
| GetDataExportDownloadURL | GetDataExportDownloadURL | Queries the download URL of export results for a data export ticket. |
| GetDatabaseExportOrderDetail | GetDatabaseExportOrderDetail | Queries the details of a database export ticket. |
| GetDataExportOrderDetail | GetDataExportOrderDetail | Queries the information about a data 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. |
| GetSQLReviewCheckResultStatus | GetSQLReviewCheckResultStatus | Queries the result of an SQL review. |
| ListSQLReviewOriginSQL | ListSQLReviewOriginSQL | Queries the details of the SQL statements that are involved in an 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. |
| 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. |
| SearchDataTrackResult | SearchDataTrackResult | Searches for the parsing result of a data tracking task. |
| DownloadDataTrackResult | DownloadDataTrackResult | Downloads the parsing result of a data tracking task. |
| QueryDataTrackResultDownloadStatus | QueryDataTrackResultDownloadStatus | Queries the download and parsing progress of data tracking logs. |
| Attachment upload | Attachment upload | |
| 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. |
| GetUserUploadFileJob | GetUserUploadFileJob | Obtains the information of a file upload task. |
| 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. |
| 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. |
| GetPagedInstance | GetPagedInstance | Queries the task information about a ticket. |
SQL tasks
|
API |
Title |
Description |
| ListDBTaskSQLJob | ListDBTaskSQLJob | Queries a list of SQL tasks. |
| ListDBTaskSQLJobDetail | ListDBTaskSQLJobDetail | Gets the details of the SQL task. |
| GetDBTaskSQLJobLog | GetDBTaskSQLJobLog | Queries the log that records the scheduling details of an SQL task. |
| GetOnlineDDLProgress | GetOnlineDDLProgress | Queries the details and progress of an OnlineDDL task. |
Permission management
|
API |
Title |
Description |
| SetOwners | SetOwners | Configures the owner of an instance, a database, or a table. |
| ListInstanceUserPermissions | ListInstanceUserPermissions | Queries the permissions of a user on an instance. |
| ListDatabaseUserPermssions | ListDatabaseUserPermssions | Queries the permissions of users on a database. |
| ListUserPermissions | ListUserPermissions | Queries the permissions of a user on databases and tables. |
| GrantUserPermission | GrantUserPermission | Grants permissions on an instance, a database, or a table to a user. |
| RevokeUserPermission | RevokeUserPermission | Revokes the permissions on instances, databases, and tables from a user. |
| 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. |
Security 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. |
| ModifyDesensitizationStrategy | ModifyDesensitizationStrategy | Modifies the masking rule bound to a specified field. |
| ListClassificationTemplates | ListClassificationTemplates | Queries the classification templates. |
| ListSensitiveDataAuditLog | ListSensitiveDataAuditLog | Queries the audit logs for sensitive information. |
| ListSensitiveColumns | ListSensitiveColumns | Queries sensitive fields in a table of a database. |
| ListSensitiveColumnsDetail | ListSensitiveColumnsDetail | Queries the details of a sensitive field. |
| ChangeColumnSecLevel | ChangeColumnSecLevel | Adjusts the sensitivity level of fields. |
| ChangeColumnSecurityLevel | ChangeColumnSecurityLevel | Changes the security level of a column. |
| GetClassificationTemplate | GetClassificationTemplate | Queries the information about the classification and grading template associated with an instance. |
| ListSensitivityLevel | ListSensitivityLevel | Queries the sensitivity levels of a classification template. |
| 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. |
| DeleteProxy | DeleteProxy | You can call this operation to disable the data security protection proxy of a DB instance. |
| ListProxies | ListProxies | Queries the proxies that are generated by the secure access proxy feature. |
| GetProxy | GetProxy | Queries the details of a secure access proxy. |
| CreateProxyAccess | CreateProxyAccess | Grants a user the permissions to access a database instance by using the secure access proxy feature. |
| DeleteProxyAccess | DeleteProxyAccess | Revokes the permissions to access a database instance by using the secure access proxy feature from a user. |
| ListProxyAccesses | ListProxyAccesses | Queries information about users that are authorized to access a database instance by using the secure access proxy feature. |
| InspectProxyAccessSecret | InspectProxyAccessSecret | You can call this operation to obtain the authorization password of the security protection agent InspectProxyAccessSecret. |
| 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. |
| RevokeTemplateAuthority | RevokeTemplateAuthority | Revokes permissions on resources from Data Management (DMS) 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. |
| GetAuthorityTemplateItem | GetAuthorityTemplateItem | Queries the resources in a 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. |
Data query
|
API |
Title |
Description |
| ExecuteScript | Execute SQL script | Executes an SQL script. |
Data development
|
API |
Title |
Description |
| Task orchestration | Task orchestration | |
| UpdateTaskFlowConstants | Update task flow constant list | Calls the UpdateTaskFlowConstants operation to update the constant list of a task flow. |
| DeleteTaskFlow | DeleteTaskFlow | Deletes a task flow. |
| OfflineTaskFlow | OfflineTaskFlow | Unpublishes a published task flow in Data Management (DMS). |
| ListTaskFlow | ListTaskFlow | Queries a list of task flows. |
| GetTaskInstanceRelation | GetTaskInstanceRelation | Queries the task nodes of a task flow instance. |
| ListTaskFlowInstance | ListTaskFlowInstance | Queries the execution records of a task flow. |
| ListDAGVersions | ListDAGVersions | Queries the published versions of a task flow. |
| ReDeployLhDagVersion | ReDeployLhDagVersion | Redeploys the published versions of a task flow. |
| UpdateScenario | Update task flow business scenario name and description | Calls the UpdateScenario operation to update the name and description of a task flow business scenario. |
| ResumeTaskFlowInstance | Resume a paused task flow | Resumes a paused task flow instance. |
| UpdateTaskContent | Update a node in a task flow | Updates a node in a task flow by calling the UpdateTaskContent operation. |
| ListTaskFlowsByPage | ListTaskFlowsByPage | Queries the details of task flows by page. |
| ListScenarios | ListScenarios | Queries business scenarios. |
| UpdateTaskConfig | Update node advanced configuration | Updates the advanced configuration of a node by calling the UpdateTaskConfig operation. |
| ListTaskFlowConstants | ListTaskFlowConstants | Queries the constants for a task flow. |
| BackFill | Backfill data for a task flow | Calls the BackFill operation to backfill data for a task flow. |
| UpdateTaskTimeVariables | Update node time variables | Updates the time variables of a node. |
| ListTaskFlowTimeVariables | ListTaskFlowTimeVariables | Lists the time variables for a task flow. |
| UpdateTaskFlowTimeVariables | Update task flow time variables | Calls the UpdateTaskFlowTimeVariables operation to update the time variables of a task flow. |
| UpdateTaskFlowCooperators | Update task flow collaborators | Updates the list of collaborators for a task flow by calling the UpdateTaskFlowCooperators operation. |
| CreateScenario | CreateScenario | Creates a business scenario to group task flows by business scenario. |
| DeleteScenario | DeleteScenario | Deletes a business scenario. |
| UpdateSLARules | Update task flow SLA timeout alert | Updates the SLA timeout alert for a task flow. |
| GetRuleNumLimitOfSLA | GetRuleNumLimitOfSLA | Queries the maximum number of custom service-level agreement (SLA) rules for task orchestration. |
| 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. |
| ListDefaultSLARules | ListDefaultSLARules | Queries the default service level agreement (SLA) timeout rules. |
| ListTaskFlowCooperators | ListTaskFlowCooperators | Queries a list of users that are involved in a task flow. |
| ListSLARules | ListSLARules | Queries the custom service level agreement (SLA) rules of a task flow. |
| GetTask | GetTask | Queries the configurations, including time variables, of a specified task node based on the task node ID. |
| MoveTaskFlowToScenario | Move a task flow to a specified business scenario | Moves a task flow to a specified business scenario. |
| GetTaskFlowNotification | GetTaskFlowNotification | Queries the notification settings for task flows. |
| UpdateTaskName | Update node name | Updates the name of a node by calling the UpdateTaskName operation. |
| UpdateTaskOutput | Update output variables of a node | Calls the UpdateTaskOutput operation to update the output variables of a node. |
| DeleteTaskFlowEdgesByCondition | DeleteTaskFlowEdgesByCondition | Deletes task flow edges based on multiple conditions. |
| ListTaskFlowEdgesByCondition | ListTaskFlowEdgesByCondition | Queries the edges of the directed acyclic graph (DAG) for a task flow based on multiple conditions. |
| AddTaskFlowEdges | Create directed edges for task flow nodes | Creates directed edges for existing nodes in a task flow. |
| UpdateTaskFlowNameAndDesc | Update task flow name and description | Calls the UpdateTaskFlowNameAndDesc operation to update the name and description of a task flow. |
| GetTaskFlowGraph | GetTaskFlowGraph | Queries the Directed Acyclic Graph (DAG) of a task flow. |
| UpdateTaskFlowEdges | Update start nodes of specified task flow edges | Batch updates the start node and end node of specified edges in a specified task flow. |
| UpdateTaskFlowOwner | Update task flow owner | Updates the owner of a task flow by calling the UpdateTaskFlowOwner operation. |
| UpdateTaskFlowSchedule | Update task flow scheduling configuration | Updates the scheduling configuration of a task flow by calling the UpdateTaskFlowSchedule operation. |
| UpdateTaskFlowRelations | Fully update task flow edges | Performs a full update of task flow edges by calling the UpdateTaskFlowRelations operation. |
| UpdateTaskFlowNotification | Update task flow notification settings | Calls the UpdateTaskFlowNotification operation to update the notification settings of a task flow. |
| ListTasksInTaskFlow | ListTasksInTaskFlow | Queries the tasks in a specified task flow. |
| CreateTaskFlow | CreateTaskFlow | Creates a task flow. |
| SuspendTaskFlowInstance | Suspend a task flow instance | Suspends a running task flow instance by calling the SuspendTaskFlowInstance operation. |
| ReRunTaskFlowInstance | Re-run a task flow instance | Re-runs a task flow instance by calling the ReRunTaskFlowInstance operation. |
| MakeTaskFlowInstanceSuccess | Set the status of a specified task flow to successful | Sets the status of a specified task flow to successful by calling the MakeTaskFlowInstanceSuccess operation. |
| DeleteTask | DeleteTask | Deletes a task in a specified task flow. |
| PublishAndDeployTaskFlow | Publish and deploy a specified task flow | Publishes and deploys a specified task flow. |
| StopTaskFlowInstance | StopTaskFlowInstance | Stops a task flow instance. |
| CreateTask | CreateTask | Creates a task node for a task flow. |
| UpdateTaskContentV2 | Update a large node in a task flow | Accepts large SQL files to update node content. |
| TryRunTaskFlow | Dry run a task flow | Performs a dry run of a task flow in a task orchestration. |
| Data warehouse development | Data warehouse development | |
| CreateLakeHouseSpace | CreateLakeHouseSpace | Creates a workspace for data warehouse development in Data Management (DMS). |
| GetLhSpaceByName | Query project workspace information | Queries the information about a DMS data warehouse development project workspace by workspace name. |
| DeleteLakeHouseSpace | Delete a project space | Calls the DeleteLakeHouseSpace operation to delete a project space in data warehouse development. |
| ListLhTaskFlowAndScenario | Query task flows by business scenario in a project workspace | Queries the task flow list corresponding to business scenarios in a DMS data warehouse development project workspace. |
| AddLhMembers | Add workspace administrators, workspace members, or node flow developers | Invokes the AddLhMembers operation to add storage management administrators, workspace members, or node flow developers to a Data Management Service (DMS) data warehouse development project workspace. |
| DeleteLhMembers | Delete project workspace members or task flow developers | Deletes members or task flow developers from a DMS data warehouse development project workspace. |
| ChangeLhDagOwner | Transfer task flow owner | Transfers the owner of a task flow in a DMS data warehouse development workspace. |
Sales orders
|
API |
Title |
Description |
| ListEffectiveOrders | ListEffectiveOrders | Queries valid orders. |
| RefundPayAsYouGoOrder | RefundPayAsYouGoOrder | Unsubscribes from a pay-as-you-go Data Management (DMS) resource. |
Asset categories
|
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. |
Workspace
|
API |
Title |
Description |
| CreateWorkspace | CreateWorkspace | Creates a workspace. |
| DeleteWorkspace | DeleteWorkspace | Deletes a workspace. |
| GetWorkspace | GetWorkspace | Queries the details of a workspace. |
| ListWorkspaces | ListWorkspaces | Queries a list of workspaces of the tenant. |
| UpdateWorkspace | UpdateWorkspace | Updates the information about a workspace. |
Others
|
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. |
| ListTagMetaAsset | ListTagMetaAsset | Lists Database and Table assets associated with a specific Tag in a DataAgent Workspace. |
| SearchTableKnowledge | SearchTableKnowledge | Searches for Table Knowledge based on a user's query. |
| GetAIOrderApprovalCommentSSE | GetAIOrderApprovalCommentSSE | Gets approval suggestions for a ticket from a Large Language Model (LLM). |
| AddWorkspaceUser | AddWorkspaceUser | Adds a user to a workspace. |
| UpdateWorkspaceUser | UpdateWorkspaceUser | Updates the roles of a user in a workspace. |
| ListWorkspaceUsers | ListWorkspaceUsers | Lists the users in a specified workspace. |
| RemoveWorkspaceUser | RemoveWorkspaceUser | Removes a user from a workspace. |
| SearchWorkspaceRoles | SearchWorkspaceRoles | Searches for roles in a workspace. |
| ConfirmInventoryKnowledge | Adopt inventory result | Confirms a single knowledge item in an inventory task and marks it as certified. |
| CreateInventoryJob | Create an inventory task | Creates an asset inventory task to perform knowledge inventory on specified instances, databases, or tables. |
| 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. |
| CheckInventoryJob | View inventory task status | Queries the execution status and progress information of an asset information collection task. |
| 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. |
| GetTableKnowledgeDetails | GetTableKnowledgeDetails | Retrieves the asset knowledge details for a table, including its metadata, business description, and a list of fields. |
| GetTableColumnList | GetTableColumnList | Retrieves the details for each column in a table, including metadata, business descriptions, and security level. |
| GetTableInstructions | GetTableInstructions | Retrieves usage instructions and business context for a table, including its business description, summary, and related assets. |
| ListInventoryJobs | ListInventoryJobs | Retrieves a paginated list of asset inventory jobs. |
| SearchInventoryAsset | SearchInventoryAsset | Retrieves a paginated list of table assets from a specific inventory task. |
| CreateForecastAgent | CreateForecastAgent | Creates a forecast agent. |
| SetForecastAgentInstance | SetForecastAgentInstance | Sets the credentials for an instance. |
| DescribeForecastAgent | Retrieve forecast agent instance details | Retrieves the details of a forecast agent instance. |
| GetForecastAgentInstance | GetForecastAgentInstance | Retrieves a list of forecast agent instances. |
| DescribeInventoryFileUploadSignature | Retrieve upload credentials for asset inventory | Retrieves OSS direct upload credentials for asset inventory files. |
| ExportInventoryKnowledge | Export knowledge from inventory results | Exports the full list of knowledge produced by an inventory task as an XLSX file. |
| ExportInventoryAsset | Export inventory asset knowledge | Exports the full list of table assets under an inventory task as an XLSX file. |
| AsyncExportInventoryAsset | Asynchronously export inventory results | Asynchronously submits a full asset export task for an inventory table. |
| AsyncExportInventoryKnowledge | Submit an asynchronous export task for inventory assets | Submits an asynchronous commit for a full export node of inventory knowledge. |
| GetInventoryExportTaskStatus | Get asynchronous export task status | Queries the status of an asynchronous export task for inventory results. |
| AssetAnswerSSE | Perform asset Q&A via SSE | Performs asset-related Q&A through the SSE interface of MetaAgent. |
| ClearCategoryMountedTables | Unmount all tables from a specified folder | Unmounts all tables from a specified category folder. |
| CloneStandardGroup | Clone a security rule set | Clones a security rule set. |
| CreateWorkFlowNode | Create an approval node | Creates a list of approval nodes. |
| CreateWorkFlowTemplate | Create an approval template | Creates an approval template. |
| EditTableAssetInfo | Edit table knowledge | Edits the business knowledge (AI-enhanced description and summary) of a table, which affects the accuracy of semantic table search. |
| ListAssetCategories | List asset category tree | Lists the asset category tree (up to 4 levels) to confirm the target folder ID before mounting. |
| MountTableToCategory | Correct table folder mounting | Manually mounts a table to a specified business folder to correct an incorrect folder mounting. When Replace is set to true, existing folder relationships of the table are unbound first (remount). |
| SearchTenantTableKnowledge | Search table knowledge by natural language | Searches for tables across databases at the tenant level using natural language and returns a list of table knowledge entries. |
| TestInstanceConnection | Test instance connectivity | Tests the connectivity of an instance. |
| UpdateWorkFlowNode | Update approval node information | Updates the list of approval nodes. |
| UpdateWorkFlowTemplate | Update approval template information | Updates an approval template. |