API overview-Data Management-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (dms/2025-04-14) 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.

Airflow

API	Title	Description
CreateAirflowLoginToken	CreateAirflowLoginToken	Obtains logon credentials for an Airflow instance hosted by Data Management Service (DMS). Use the returned token and host endpoint to construct a logon URL for the Airflow web UI.
CreateAirflow	CreateAirflow	Creates an Airflow instance in a workspace.
UpdateAirflow	UpdateAirflow	Updates the properties of an Airflow instance.
GetAirflow	GetAirflow	Queries the configuration and status of an Airflow instance.
ListAirflows	ListAirflows	Retrieves a list of Airflow instances in a workspace.
DeleteAirflow	DeleteAirflow	Deletes an Airflow instance.

Databases and Tables in a Data Lake

API	Title	Description
ListDataLakeDatabase	ListDataLakeDatabase	Retrieves a list of databases in a data lake.
GetDataLakeDatabase	GetDataLakeDatabase	Retrieves information about a database in a data lake.
ListDataLakeCatalog	ListDataLakeCatalog	Retrieves a list of data lake catalogs.
GetDataLakeCatalog	GetDataLakeCatalog	Retrieves the data catalog of a data lake.
ListDataLakeTablebaseInfo	ListDataLakeTablebaseInfo	Retrieves the basic information about tables in a data lake.
GetDataLakeTable	GetDataLakeTable	Retrieves information about a table in a data lake.
BatchCreateDataLakePartitions	BatchCreateDataLakePartitions	Creates partitions for a data lake table in a batch.
UpdateDataLakeTable	UpdateDataLakeTable	Updates the information of a data lake table.
UpdateDataLakePartition	UpdateDataLakePartition	Updates the partition information of a data lake table.
UpdateDataLakeDatabase	UpdateDataLakeDatabase	Updates the information of a data lakehouse database.
ListDataLakeTableName	ListDataLakeTableName	Retrieves a list of data lake table names.
ListDataLakeTable	ListDataLakeTable	Retrieves a list of data lake tables.
ListDataLakePartitionName	ListDataLakePartitionName	Retrieves a list of partition names for a data lake table.
ListDataLakePartitionByFilter	ListDataLakePartitionByFilter	Retrieves a list of partitions for a data lake table based on filter conditions.
ListDataLakePartition	ListDataLakePartition	Retrieves the list of partitions of a data lake table.
GetDataLakePartition	GetDataLakePartition	Retrieves the details of a data lakehouse table partition.
DeleteDataLakeTable	DeleteDataLakeTable	Deletes a data lake table.
DeleteDataLakePartition	DeleteDataLakePartition	Deletes a partition from a data lake table.
DeleteDataLakeDatabase	DeleteDataLakeDatabase	Deletes a data lake database.
CreateDataLakeTable	CreateDataLakeTable	Creates a data lake table in Data Management (DMS).
CreateDataLakePartition	CreateDataLakePartition	Creates a partition for a data lake table.
CreateDataLakeDatabase	CreateDataLakeDatabase	Creates a data lake database.
BatchUpdateDataLakePartitions	BatchUpdateDataLakePartitions	Update partitions in a data lake table in batch.
BatchDeleteDataLakePartitions	BatchDeleteDataLakePartitions	Batch deletes partitions from a data lake table.
CreateDataLakeFunction	CreateDataLakeFunction	Creates a user-defined function (UDF) for a data lake.
GetDataLakeFunction	GetDataLakeFunction	Retrieves the details of a user-defined function in a data lake.
UpdateDataLakeFunction	UpdateDataLakeFunction	Update a user-defined function in a data lake.
DeleteDataLakeFunction	DeleteDataLakeFunction	Deletes a user-defined function in a data lake.
ListDataLakeFunction	ListDataLakeFunction	Retrieves a list of data lake functions.
ListDataLakeFunctionName	ListDataLakeFunctionName	Retrieves a list of data lake function names.

Others

API	Title	Description
AddUserToDataAgentWorkspace	AddUserToDataAgentWorkspace	Adds a user to a specified workspace.
ConfigAirflow	ConfigAirflow	Update an Airflow instance's custom configuration
CreateCustomAgent	CreateCustomAgent	Create a custom agent in your personal space or a workspace.
CreateDataAgentKnowledgeBase	CreateDataAgentKnowledgeBase	Creates a DataAgent knowledge base. The knowledge base creator has read and write permissions. Other workspace members have permission to use it.
CreateDataAgentSession	CreateDataAgentSession	Create a DataAgent session
CreateDataAgentWorkspace	Create collaborative workspace	Creates a DataAgent collaborative workspace.
DeleteCustomAgent	DeleteCustomAgent	Delete a custom agent in your personal workspace or a shared workspace. Note: Only custom agents that are newly created or offline can be deleted.
DeleteDataAgentKnowledgeBase	DeleteDataAgentKnowledgeBase	Deletes a DataAgent knowledge base.
DeleteDataAgentWorkspace	DeleteDataAgentWorkspace	Deletes a DataAgent workspace.
DeleteDocument	DeleteDocument	Deletes a document from a specified knowledge base.
DeleteDocumentChunks	DeleteDocumentChunks	Deletes chunks from a document in a knowledge base.
DeleteFileUpload	DeleteFileUpload	DeleteFileUpload
DeleteWorkspaceCode	DeleteWorkspaceCode	Deletes a code file or directory from a workspace.
DescribeCustomAgent	DescribeCustomAgent	`DescribeCustomAgent` retrieves the details of a custom agent by its agent ID.
DescribeDataAgentSession	Retrieve dataAgent session description	Retrieves the description of a DataAgent session.
DescribeDocument	DescribeDocument	Retrieves the details of a specific document.
DescribeFileUploadSignature	DescribeFileUploadSignature	DescribeFileUploadSignature
DescribeKnowledgeBaseStats	DescribeKnowledgeBaseStats	Retrieves the statistics of a knowledge base.
DescribeKnowledgeBaseUploadSignature	DescribeKnowledgeBaseUploadSignature	Generates a signature to upload a document to a knowledge base.
FileUploadCallback	FileUploadCallback	FileUploadCallback
GetChatContent	GetChatContent	Retrieves chat content from a specific checkpoint by specifying a session ID and an agent ID.
GetDataAgentSubAccountInfo	GetDataAgentSubAccountInfo	Retrieves information about a RAM user that belongs to an Alibaba Cloud account.
GetDataAgentWorkspaceInfo	Retrieve collaborative workspace details	Retrieves the details of a collaborative workspace.
GetNotebookAndSubmitTask	GetNotebookAndSubmitTask	Submits a task to schedule and run a Notebook file.
GetNotebookTaskStatus	GetNotebookTaskStatus	Retrieves the execution status of a Notebook task.
GetSqlConsoleOperationLog	Query SQL window operation logs	Queries the operation logs of the SQL window.
GetWorkspaceCode	Reads the content of a file in the workspace.	Reads the content of a code file in the workspace and returns the file content along with mtime (in the header).
GetWorkspaceCodePublishSetting	GetWorkspaceCodePublishSetting	Retrieves the deployment configuration of a workspace.
GetWorkspaceQuota	GetWorkspaceQuota	Returns the quota for a workspace.
ListAirflowVersions	ListAirflowVersions	Lists the available Airflow versions.
ListCustomAgent	ListCustomAgent	ListCustomAgent returns a list of all custom agents from the personal space and workspaces.
ListDataAgentSession	ListDataAgentSession	Retrieve a list of Data Agent session descriptions.
ListDataAgentWorkspace	Retrieve collaborative workspaces under the primary account	Retrieves the collaborative workspaces under the primary account with pagination.
ListDataAgentWorkspaceMember	ListDataAgentWorkspaceMember	Lists all members in a workspace.
ListDataCenterDatabase	ListDataCenterDatabase	Lists user-uploaded files in a data center, excluding databases.
ListDataCenterTable	ListDataCenterTable	Retrieves a list of user-uploaded tables from the data center, for file types only.
ListDocumentChunks	ListDocumentChunks	Queries a list of chunks.
ListDocuments	ListDocuments	Lists the documents in a knowledge base.
ListFileUpload	ListFileUpload	ListFileUpload
ListKnowledgeBases	ListKnowledgeBases	Returns a paginated list of knowledge bases.
ListWorkspaceCode	ListWorkspaceCode	Lists code files and directories at a specified path in a workspace.
ModifyCustomAgent	ModifyCustomAgent	Modify a custom agent in a personal space or workspace
OperateCustomAgent	OperateCustomAgent	Operate custom agents in personal spaces and workspaces.
RedeployAirflow	RedeployAirflow	Redeploy an Airflow instance
RemoveUserToDataAgentWorkspace	RemoveUserToDataAgentWorkspace	Removes a user from a workspace.
RetrieveKnowledgeBase	RetrieveKnowledgeBase	Query a knowledge base
SaveWorkspaceCode	Save workspace code (create or edit)	Saves workspace code. If the file does not exist, a new file is automatically created.
SendChatMessage	Send chat message	Sends a user message to a specified session or cancels a session.
SetWorkspaceCodePublishSetting	SetWorkspaceCodePublishSetting	Sets the code deployment configuration for a workspace. This is an asynchronous operation that returns a key. Use this key to query the operation's status by calling the WorkspaceActionStatus operation.
SetWorkspaceQuota	SetWorkspaceQuota	Sets the quota for a workspace.
UpdateDataAgentSpaceInfo	UpdateDataAgentSpaceInfo	Updates workspace information.
UpdateDataAgentWorkspaceMemberRole	UpdateDataAgentWorkspaceMemberRole	Changes the role of a workspace member.
UpdateDocument	UpdateDocument	Updates the description of a document.
UpdateKnowledgeBase	UpdateKnowledgeBase	Updates a knowledge base.
UploadDocument	UploadDocument	Uploads a document to a knowledge base.
UpsertDocumentChunks	UpsertDocumentChunks	Upserts document chunks into a knowledge base.
WorkspaceActionLog	WorkspaceActionLog	Queries the log of an asynchronous task in a workspace.
WorkspaceActionStatus	WorkspaceActionStatus	Queries the status of an asynchronous task in a workspace. Operations such as a deployment return a key. Call this operation with the key to retrieve the task's status.
WorkspaceCodePublish	WorkspaceCodePublish	This asynchronous API returns a key. Use this key to query the WorkspaceActionStatus API for the code deployment status.