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.

Agent data gateway

API	Title	Description
DeleteAgenticVpcEndpoint	Delete a reverse endpoint	Submits an asynchronous deletion request for a VPC endpoint and returns the acceptance result.
UpdateAgenticDataSource	Update a data source	Updates the connection, authentication, or display information of an existing data source.
TestAgenticDataSourceConnection	Test data source connection	Tests whether the network and authentication information of a data source are available.
ListAgenticDataSources	List data sources	Performs a paged query on the data sources of the current account by using paging.
GetAgenticDataSource	Query data source details	Queries the details of a data source by UUID.
DeleteAgenticDataSource	Delete a data source	Deletes a data source and its associated metadata catalog.
AddAgenticDataSource	Create a data source	Creates a data source that can be accessed by the Agent data gateway.
ListAgenticCatalog	Query catalogs	Performs a paging query on the catalogs in Agentic DMS. You can filter the results by catalog type and name prefix.
ListAgenticDatabase	List databases	Performs a paged query for the list of databases in a specified catalog, with options to filter by name prefix and specify the sorting method for paging.
ListAgenticTableBaseInfo	List basic table information	Queries the basic information and engine metadata of tables in a specified database by using paging. You can filter the results by keyword and table type, and specify the sorting method.
GetAgenticTableIndex	Query table indexes	Queries the indexes of a table based on the database UUID and the fully qualified name of the table.
GetAgenticTableColumn	Query table fields	Queries the fields of a table based on the database UUID and the fully qualified name of the table.
GetAgenticDatabase	Query database details	Queries the details of a database in Agentic DMS based on the database UUID.
GetAgenticCatalog	Query catalog details	Queries the details of an Agentic DMS catalog based on the catalog UUID.
SearchAgenticCatalog	Search catalogs	Searches for catalogs in Agentic DMS by keyword, catalog type, database type, or a list of catalog UUIDs, and returns paginated results.
SearchAgenticDatabase	Search databases globally	Searches for databases across catalogs by keyword. You can filter the results by catalog, database type, and environment type. The results are paginated.
CreateAgent	Create a database gateway agent identity	Creates a Database Gateway agent identity.
CreateAgenticSqlExecuteCredential	Create a temporary credential for SQL execution	Creates a temporary credential for an agent to execute SQL statements.
GetAgenticAgentByInstallToken	Query the agent associated with an install token	Queries the agent associated with an install token after redemption. Data is empty if the token has not been redeemed.
ResetAgenticApiKey	Reset a data gateway access token	Resets the Access Token of a specified data gateway. The associated Agent and name are retained, and only the plaintext Access Token is regenerated. The old Access Token becomes invalid immediately. The new plaintext Access Token is returned only once in this response. Store it securely right away. Only the creator of the Access Token can reset it, and only Access Tokens issued by the console (source=console) can be reset.
ListAgenticGlobalSqlExecutionHistories	Query SQL execution history within a tenant	Queries the SQL execution history within the current tenant, sorted in descending order by execution start time. Only includes AGENT_QUERY and WORKFLOW_QUERY.
ListAgenticSecurityPolicies	Query security policies by using paging	Queries the user security policy of the current Alibaba Cloud account by using paging and returns the enabled system default security policy.
ListAgenticSqlExecutionHistories	Query the SQL execution history of the current caller	Queries the SQL execution history visible to the current caller, sorted in descending order by execution start time. Only includes AGENT_QUERY and WORKFLOW_QUERY.

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	Create an airflow instance	Creates an Airflow instance in a workspace.
UpdateAirflow	Update airflow instance information	Updates the information 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.

Other

API	Title	Description
GetNotebookAndSubmitTask	GetNotebookAndSubmitTask	Submits a task to schedule and run a Notebook file.
GetNotebookTaskStatus	GetNotebookTaskStatus	Retrieves the execution status of a Notebook task.
AddDataAgentMemory	Add dataAgent memory	Adds a memory entry to a DataAgent.
AddUserToDataAgentWorkspace	AddUserToDataAgentWorkspace	Adds a user to a specified workspace.
CheckDataAgentMemoryConfig	Query dataAgent memory generation and usage configuration	CheckDataAgentMemoryConfig - Queries the memory generation and usage configuration of a DataAgent.
ConfigAirflow	ConfigAirflow	Update an Airflow instance's custom configuration
ConfigDataAgentMemory	Configure dataAgent memory generation/usage	Configures memory generation and usage for a DataAgent.
CreateCustomAgent	Create a custom agent	Creates a custom agent in a personal space or workspace.
CreateDataAgentAccuracyTest	Create an accuracy test instance	Creates an accuracy test instance.
CreateDataAgentFeedback	Create dataAgent feedback	Creates feedback for a DataAgent.
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	Create a dataAgent session	Creates a DataAgent session.
CreateDataAgentSkillMeta	Create and register a dataAgent skill	Creates and registers a DataAgent skill.
CreateDataAgentTheme	Create a dataAgent theme	Creates a DataAgent theme.
CreateDataAgentWorkspace	Create a collaborative workspace	Creates a DataAgent collaborative workspace.
CreateOneMetaSqlTemplate	Create an SQL template	Creates an SQL template.
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.
DeleteDataAgent	Release a dataAgent seat	Releases a DataAgent seat.
DeleteDataAgentAccuracyTest	Delete an accuracy test item	Deletes an accuracy test configuration item.
DeleteDataAgentKnowledgeBase	DeleteDataAgentKnowledgeBase	Deletes a DataAgent knowledge base.
DeleteDataAgentMcp	Delete data agent MCP servers	Deletes MCP Servers from a specified workspace.
DeleteDataAgentMemory	Delete dataAgent memory	Deletes the memory of a DataAgent.
DeleteDataAgentSkillMeta	Delete a dataAgent skill	Deletes a DataAgent skill.
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
DeleteOneMetaOssieModel	Delete a semantic model	Deletes an Ossie model from onemeta 3.0.
DeleteOneMetaSqlTemplate	Delete SQL template	Deletes a knowledge base in OneMeta 3.0.
DeleteWorkspaceCode	DeleteWorkspaceCode	Deletes a code file or directory from a workspace.
DescribeCustomAgent	Retrieve the detailed description of a custom agent	Retrieves the detailed description of a custom agent based on the custom agent ID.
DescribeDataAgentMetrics	Query dataAgent metrics	Queries DataAgent metrics.
DescribeDataAgentSession	Retrieve dataAgent session description	Retrieves the description of a DataAgent session.
DescribeDataAgentTheme	Query dataAgent theme details	Invokes the DescribeDataAgentTheme operation to query the details of a specific DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
DescribeDocument	DescribeDocument	Retrieves the details of a specific document.
DescribeFileUploadSignature	Retrieve file upload signature information	Retrieves the signature information for file uploads.
DescribeKnowledgeBaseStats	DescribeKnowledgeBaseStats	Retrieves the statistics of a knowledge base.
DescribeKnowledgeBaseUploadSignature	DescribeKnowledgeBaseUploadSignature	Generates a signature to upload a document to a knowledge base.
DescribeSkillFileUploadSignature	Retrieve skill file upload signature information	Retrieves the signature information for uploading skill files.
FileUploadCallback	Handle file upload callback	Processes the file upload callback.
GetChatContent	GetChatContent	Retrieves chat content from a specific checkpoint by specifying the session ID and AgentId.
GetDataAgentMcp	Query data agent MCP server details	Queries the details of an MCP Server by its ID, including the workspace, network, connection method, and running status.
GetDataAgentSubAccountInfo	GetDataAgentSubAccountInfo	Retrieves information about a RAM user that belongs to an Alibaba Cloud account.
GetDataAgentTaskModelUsage	Query model usage of dataAgent tasks	Queries the model usage summary of DataAgent analysis tasks within a specified time range, including the number of models used, total number of calls, total tokens consumed, and peak TPM.
GetDataAgentTaskModelUsageMetrics	Query time-series metrics for dataAgent analysis task model usage	Queries the time-series metrics of tokens per minute (TPM) for DataAgent analysis task model usage within a specified time range, returning token consumption at each time point at a minute-level granularity.
GetDataAgentThemeUploadSignature	Obtain dataAgent theme upload signature	Calls the GetDataAgentThemeUploadSignature operation to obtain OSS direct upload credentials for uploading a DataAgent theme file. After obtaining the credentials, use the PostObject method to upload the theme file directly to OSS. After the upload is complete, call the CreateDataAgentTheme operation with the returned ThemeId to complete theme creation. For more information, see https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/.
GetDataAgentWorkspaceInfo	Retrieve collaborative workspace details	Retrieves the details of a collaborative workspace.
GetListMcpServerToolsResult	Query MCP server tool detection results	Queries the connectivity and tool list results of an MCP server based on the session ID returned when the detection was started.
GetOneMetaOssieModel	Retrieve semantic model	Retrieves the Ossie model of onemeta 3.0.
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.
ImportOneMetaOssieModel	Import semantic model	Creates an SQL template.
InitWorkspaceSystemMcpServer	Initialize workspace system MCP services	Installs all currently available system MCP services for a specified Data Agent workspace.
InstallDataAgentMcp	Import MCP to dataAgent	Imports an MCP into DataAgent.
ListAirflowVersions	ListAirflowVersions	Lists the available Airflow versions.
ListCustomAgent	List custom agents	Lists all custom agents in personal and team workspaces.
ListDataAgentAccuracyTestInstances	List accuracy self-test configuration items	Lists the accuracy test configuration items that meet the specified conditions.
ListDataAgentAccuracyTestResults	Retrieve execution results of a self-test task	Retrieves the execution results of a self-test task.
ListDataAgentAccuracyTestTasks	List accuracy test tasks	Queries the running status of accuracy test nodes by using paging.
ListDataAgentMcp	Query data agent MCP server list	Queries MCP Servers in a specified workspace by paging. You can filter results by name, ready status, and service type.
ListDataAgentMemory	Retrieve dataAgent memory list	Retrieves the DataAgent memory list (up to 50 memories per RAM user).
ListDataAgentSession	List data agent sessions	Retrieves the list of historical session descriptions for Data Agent.
ListDataAgentSkillMeta	Retrieve dataAgent skill list	Retrieves the list of DataAgent skills.
ListDataAgentTheme	List dataAgent themes	Calls the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter results by theme stage, source, and common scenario.
ListDataAgentWorkspace	Retrieve collaborative workspaces under the Alibaba Cloud account	Queries a paginated list of collaborative workspaces under the Alibaba Cloud account.
ListDataAgentWorkspaceMember	ListDataAgentWorkspaceMember	Lists all members in a workspace.
ListDataCenterDatabase	Retrieve the list of files uploaded by users in the data center	Retrieves the list of files uploaded by users in the data center. Only file types are supported. Database types are not supported.
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.
ListOneMetaOssieModels	Batch retrieve semantic models	Retrieves a list of OSSIE models.
ListOneMetaSqlTemplates	Batch retrieve SQL templates	Retrieves SQL templates.
ListWorkspaceCode	ListWorkspaceCode	Lists code files and directories at a specified path in a workspace.
ModifyCustomAgent	Modify a custom agent	Modifies a custom agent in a personal or team workspace.
ModifyDataAgentMcp	Modify MCP configuration	Modifies the configuration of an MCP server.
ModifyDataAgentTheme	Modify a dataAgent theme	Modifies the display name and description of a DataAgent theme. A null parameter value indicates that the corresponding field is not modified, and an empty string clears the field.
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 the 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.
StartDataAgentAccuracyTestTask	Start a self-test task	Initiates an accuracy self-test task.
StartListMcpServerTools	Start MCP server tool connectivity detection	Asynchronously starts MCP Server connectivity and tool list detection. The first call prompts you to wait one minute for resource provisioning. Subsequent calls return a temporary Session ID for polling the result.
StopDataAgentAccuracyTestTask	Stop an accuracy test task	Stops an accuracy self-test task.
UpdateDataAgentAccuracyTest	Update accuracy test item	Updates the content of an accuracy test item.
UpdateDataAgentMemory	Update dataAgent memory	Updates the memory of a DataAgent.
UpdateDataAgentSpaceInfo	Update workspace information	Updates the information of a workspace.
UpdateDataAgentWorkspaceMemberRole	UpdateDataAgentWorkspaceMemberRole	Changes the role of a workspace member.
UpdateDocument	UpdateDocument	Updates the description of a document.
UpdateKnowledgeBase	UpdateKnowledgeBase	Updates a knowledge base.
UpdateOneMetaOssieModel	Update a semantic model	Updates an SQL template.
UpdateOneMetaSqlTemplate	Update an SQL template	Updates an SQL template.
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.
DescribeCustomAgentMonitorMetrics	Retrieve custom agent monitoring metrics data	DescribeCustomAgentMonitorMetrics - Retrieves monitoring metrics data for custom agents, including trend data.
ListCustomAgentMonitorSessions	Retrieve custom agent monitoring session list data	ListCustomAgentMonitorSessions - Retrieves the list of monitoring sessions for custom agents.
DescribeDataAgentSkillDownload	Retrieve the download link for a dataAgent skill	Retrieves the download link for a DataAgent skill.
GetMyAgenticNotificationChannelAuthorizeUrl	Retrieve the authorization URL for my notification channel	Retrieves the OAuth authorization URL required for the current user to bind a Lark account. After the user completes the authorization, the system automatically binds their Lark account.
ListMyAgenticNotificationChannelConfigs	Query personal notification channel configurations	Queries the personal notification channel configurations of the current user in the current tenant, including channel status and bound identity information.
UpdateMyAgenticNotificationChannelConfig	Update my notification channel configurations	Updates the notification channel switch or Lark account binding information for the current user.