# Alibaba Cloud DataManage - Data+AI API

> Alibaba Cloud DataManage - Data+AI API on Apizie: 134 endpoints (Creates a data source accessible by the Agent data gateway, Adds a memory entry to a DataAgent, Adds a user to a specified workspace, CheckDataAgentMemoryConfig - Queries the memory generation and usage configuration of a DataAgent, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-dms/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-dms`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/dms
- Page: https://apizie.tech/api/cloud/aliyun-dms
- OpenAPI: https://apizie.tech/api/cloud/aliyun-dms/openapi.json

Alibaba Cloud OpenAPI for DataManage - Data+AI (dms, version 2025-04-14). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a data source accessible by the Agent data gateway
`POST https://apizie.tech/v1/cloud:aliyun-dms/add-agentic-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| InstanceSource | string | yes | The source of the data source. Valid values: RDS: An ApsaraDB instance. PUBLIC_OWN: A self-managed database on the Internet. ECS_OWN: A… |
| InstanceResourceId | string | no | The ID of the cloud resource instance. This parameter is required when you select an existing cloud instance. You can leave this parameter… |
| Alias | string | no | The display name of the data source. If you do not specify this parameter, the server generates a name |
| CatalogName | string | no | The name of the metadata catalog. If you do not specify this parameter, the name is automatically generated. The name can be up to 128… |
| DbType | string | yes | The type of the data source. Use uppercase letters. Do not pass numbers. Valid values: MYSQL, POSTGRESQL, ORACLE, SQLSERVER, MARIADB,… |
| Host | string | no | Optional. The domain name or IP address of the database. Do not include the protocol, path, or port. You can leave this parameter empty if… |
| Port | integer | no | Optional. The service port of the database. You can leave this parameter empty if you select an existing cloud instance and the port is… |
| Schema | string | no | Optional. For ADB_POSTGRESQL, DRDS, POSTGRESQL, and POLARDB_POSTGRESQL, enter the database name. For ORACLE, enter the SID or service… |
| SnowflakeWarehouse | string | no | The name of the Snowflake compute warehouse. This parameter takes effect only when DbType is set to SNOWFLAKE |
| SnowflakeRole | string | no | The name of the Snowflake role. This parameter takes effect only when DbType is set to SNOWFLAKE |
| AuthType | integer | no | Optional. The authentication type. Valid values: -1: No authentication required. 0: Username and password. 1: Password only. 2:… |
| AuthAccount | string | no | The logon username. You can leave this parameter empty for authentication methods that do not require a username |
| AuthPassword | string | no | The logon password. This is sensitive information. Do not record or disclose it |
| UseSsl | integer | no | Specifies whether to use SSL. Valid values: 1: Enable. 0: Disable. -1: Use the default setting. Only ADB_MYSQL, CLICKHOUSE, MARIADB,… |
| RoleArn | string | no | The complete ARN of the Resource Access Management (RAM) role. Specify this parameter when you use a RAM role to access the data source.… |
| KmsSecret | string | no | The name of the credential. Specify this parameter when you use Key Management Service (KMS) to manage database credentials. Leave this… |
| EnvType | string | no | The environment type. Valid values: product, pre, dev, test, sit, uat, pet, and stag |
| SyncAlias | integer | no | Specifies whether to use the cloud instance name as the data source name. Valid values: 1: Yes. 0: No. This parameter takes effect only… |
| CreateMode | string | no | The entry method. Valid values: INSTANCE_ID: Select an existing cloud instance. HOST_PORT: Enter the endpoint and port. If you do not… |
| PolicyId | string | no | Optional. The ID of the data access security policy. This policy is used to control the access and protection rules for the data source |
| VpcId | string | no | The ID of the destination VPC. Specify this parameter when you access MaxCompute through a VPC. Leave this parameter empty in other… |
| ZoneId | string | no | The ID of the destination zone. Specify this parameter when you access MaxCompute through a VPC. Leave this parameter empty in other… |
| VSwitchId | string | no | The ID of the destination vSwitch. Specify this parameter when you access MaxCompute through a VPC. Leave this parameter empty in other… |

### Adds a memory entry to a DataAgent
`POST https://apizie.tech/v1/cloud:aliyun-dms/add-data-agent-memory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| SessionUuid | string | no | The session ID. Note: This parameter is deprecated |
| Content | string | no | The memory content |
| Label | string | no | The memory label. Valid values: fact_specifications: fact definitions. task_constraints: node constraints. execution_config: execution… |
| MemFrom | string | no | The memory source. Valid values: session: generated from a session. user: edited by a user |
| FromId | string | no | The source ID. If MemFrom is set to session, FromId indicates the session ID. If MemFrom is set to user, FromId indicates the RAM user ID |

### Adds a user to a specified workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/add-user-to-data-agent-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| WorkspaceId | string | no | The workspace ID |
| MemberId | string | no | The Alibaba Cloud UID of the user |
| RoleName | string | no | The name of the user's role in the workspace |

### CheckDataAgentMemoryConfig - Queries the memory generation and usage configuration of a DataAgent
`POST https://apizie.tech/v1/cloud:aliyun-dms/check-data-agent-memory-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current Data Management unit |

### Update an Airflow instance's custom configuration
`POST https://apizie.tech/v1/cloud:aliyun-dms/config-airflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| AirflowId | string | yes | The unique ID of the Airflow instance |
| CustomAirflowCfg | string | yes | The list of custom Airflow configurations (JSON-encoded) |
| WorkspaceId | string | yes | The DMS workspace ID |

### Configures memory generation and usage for a DataAgent
`POST https://apizie.tech/v1/cloud:aliyun-dms/config-data-agent-memory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| Enabled | string | no | Specifies whether to enable memory generation. Valid values: true: Enabled. false: Disabled |
| RecallEnabled | string | no | Specifies whether to enable memory recall usage. Valid values: true: Enabled. false: Disabled |

### Creates a Database Gateway agent identity
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| AgentName | string | yes | The agent name. The name must be unique within the same tenant. Maximum length: 128 characters |
| Description | string | no | The description of the agent. Maximum length: 512 characters |
| AgentType | string | no | The permission inheritance type of the agent, which specifies the permission source. Default value: HUMAN_BOUND |
| ExpireAfterSeconds | integer | no | The validity period of the automatically issued API key, in seconds. Valid values: 1 to 31536000 (up to 1 year) |

### Creates a temporary credential for an agent to execute SQL statements
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-agentic-sql-execute-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DatabaseUuid | string | no | The UUID of the database. If you specify this parameter, the credential is restricted to this database. You can call the ListDatabases… |
| CatalogUuid | string | no | The UUID of the instance |
| CatalogName | string | no | The name of the instance |
| QualifiedName | string | no | The fully qualified name of the database. This parameter must be used together with CatalogUuid or CatalogName. MySQL database: The value… |

### Creates an Airflow instance in a workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-airflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the Data Management workspace |
| AirflowName | string | yes | The name of the Airflow instance |
| Description | string | no | The description of the Airflow instance |
| AppSpec | string | yes | The specification of the Airflow instance. Valid values: SMALL, MEDIUM, LARGE, XLARGE, and X2LARGE |
| WorkerServerlessReplicas | integer | yes | The number of extended Worker node replicas |
| VpcId | string | yes | VPC ID |
| VSwitchId | string | yes | The ID of the vSwitch |
| SecurityGroupId | string | yes | The ID of the security group |
| OssBucketName | string | yes | The name of the OSS bucket |
| OssPath | string | yes | The OSS path for storing logs |
| StartupFile | string | no | The startup script of the Airflow container |
| RequirementFile | string | no | The path of the package installation file |
| DagsDir | string | no | The DAG directory scanned by Airflow |
| PluginsDir | string | no | The plugin directory scanned by the Airflow instance |
| GracefulShutdownTimeout | integer | no | The timeout period for the Worker to gracefully shut down |
| EnableServerless | string | no | Specifies whether to enable Worker elasticity |
| DataMountInfoList | string | no | The list of data mount information (JSON-encoded) |
| AirflowVersion | string | no | The Airflow version. Valid values: "3.2.2", "3.1.0", "2.10.4", and "3.0.6" |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |
| ZoneId | string | no | The zone ID within the region |

### Obtains logon credentials for an Airflow instance hosted by Data Management Service (DMS). Use the returned…
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-airflow-login-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| AirflowId | string | yes | The ID of the Airflow instance. For more information, see [Airflow instances]() |

### Creates a custom agent in a personal space or workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-custom-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| Name | string | no | The name of the custom agent |
| Description | string | no | The description of the custom agent |
| AgentType | string | no | The type of the custom agent. Valid values: Default: the system-built-in custom agent. Each workspace can have at most one Default agent,… |
| DataJson | string | no | The specified data scope, in JSON character string format. General parameter descriptions tableFlag: true specifies the data scope. scope:… |
| Instruction | string | no | The instructions. Input limit: up to 10,000 characters |
| Knowledge | string | no | The knowledge. Input limit: up to 10,000 characters |
| KnowledgeConfigList | string | no | The external knowledge bases (JSON-encoded) |
| KnowledgeSemanticConfigList | string | no | The knowledge semantic configuration list (JSON-encoded) |
| UserSpecifiedSkillList | string | no | The list of user-specified skills (JSON-encoded) |
| RecommendQuestionList | string | no | The list of recommended questions. You can configure up to 10 recommended questions (JSON-encoded) |
| ExecutionConfig | string | no | The execution configuration (JSON-encoded) |
| ScheduleTaskConfig | string | no | The scheduled task configuration (JSON-encoded) |
| TextReportConfig | string | no | The text report format |
| WebReportConfig | string | no | The web report format |
| WebReportTheme | string | no | The web report theme |
| DMSUnit | string | no | The current DMS unit |
| CallbackConfig | string | no | The callback feature configuration (JSON-encoded) |
| RelatedSessionId | string | no | The ID of the referenced historical session |

### Creates an accuracy test instance
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-data-agent-accuracy-test` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| FileId | string | no | The file ID in the data center |
| CustomAgentId | string | no | The ID of the custom agent to be tested for accuracy |
| Datasource | string | no | The data source. We recommend that you configure this in the custom agent |
| Dataset | string | no | Deprecated |
| EvaluationPrompt | string | no | The accuracy evaluation criteria. An empty value indicates the default criteria |
| Mode | integer | no | The analysis mode |
| WorkspaceId | string | no | The workspace ID |
| RegionId | string | no | The region ID |
| DmsUnit | string | no | The DMS unit used to create the resource |
| Language | string | no | The language used for the analysis task |
| MaxConcurrent | integer | no | The maximum number of concurrent sessions during the test |
| NeedDelete | string | no | Specifies whether sessions are displayed after analysis. This parameter is not supported |
| Name | string | no | The name of the test item |
| Desc | string | no | The description |

### Creates feedback for a DataAgent
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-data-agent-feedback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| SessionId | string | no | The agent session ID |
| FeedbackType | string | no | The feedback type. Valid values: ISSUE_REPORT: issue report. CANCEL_CHAT: task cancellation. LIKE: like. DISLIKE: dislike |
| TargetType | string | no | The feedback target. Valid values: SESSION: session (used for issue reports). CHAT: chat (used for task cancellation). REPORT: report.… |
| TargetId | string | no | The feedback target ID. For issue reports, use SessionId + underscore + random UUID. For other feedback types, pass the checkpoint of the… |
| LikeValue | integer | no | The like value. This parameter is used only for like and dislike scenarios. Do not pass this parameter for other scenarios. Valid values:… |
| FeedbackContent | string | no | The feedback content. You can directly enter the feedback content, or pass a JSON string for the issue report scenario as shown in the… |
| DMSUnit | string | no | The current DMS unit |
| WorkspaceId | string | no | The workspace ID |

### Creates a DataAgent knowledge base. The knowledge base creator has read and write permissions. Other…
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-data-agent-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| WorkspaceId | string | yes | The workspace ID |
| Name | string | yes | The name of the knowledge base |
| Description | string | no | The description of the knowledge base |
| FromKbUuid | string | no | The ID of the source industry knowledge base |

### Creates a DataAgent session
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-data-agent-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| Title | string | no | The title. Chinese and English characters are supported. Maximum length: 128 characters |
| File | string | no | The file ID |
| SessionConfig | string | no | The session configuration (JSON-encoded) |
| WorkspaceId | string | no | The workspace ID |

### Creates and registers a DataAgent skill
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-data-agent-skill-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| SkillId | string | no | The skill ID. If you specify this parameter, the uploaded skill overwrites the existing skill and replaces the original skill content.… |
| SkillName | string | no | The skill name. This parameter is optional. If not specified, the backend parses the ZIP package specified by UploadLocation to obtain the… |
| Description | string | no | The skill description. This parameter is optional. If not specified, the backend parses the ZIP package specified by UploadLocation to… |
| UploadLocation | string | no | The full path for the skill ZIP file upload. Format: The UploadDir field returned by the DescribeSkillFileUploadSignature operation… |

### Creates a DataAgent theme
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-data-agent-theme` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| ThemeId | string | no | The UUID of the theme. The value must be returned by GetDataAgentThemeUploadSignature, and the file must have been uploaded. If the UUID… |
| ThemeName | string | no | The display name of the theme. The value can be up to 64 characters in length. This parameter is required when you create a theme |
| FileFrom | string | no | The file source, which affects the backend logic for determining whether the theme is valid. Valid values: upload: The file is uploaded… |
| ThemeType | string | no | The type of the custom theme. Valid values: (Default) template: The theme is a template. (Not supported) design: The theme is a DESIGN.md… |
| Category | string | no | The scenario, which affects the filtering when you view the theme list in the console. Valid values: (Recommended) custom: A user-uploaded… |
| Description | string | no | The description. The value can be up to 255 characters in length |
| WorkspaceId | string | no | The workspace to which the theme belongs. If this parameter is not specified or is set to personal, the personal workspace is used. You… |

### Creates a DataAgent workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-data-agent-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| WorkspaceName | string | no | The name of the workspace |
| WorkspaceDesc | string | no | The description of the workspace |
| IsSessionShareEnabled | string | no | Specifies whether session sharing is enabled within the workspace |

### Creates an SQL template
`POST https://apizie.tech/v1/cloud:aliyun-dms/create-one-meta-sql-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| Source | string | yes | The knowledge source of the SQL template |
| Title | string | yes | The title of the SQL template |
| Description | string | no | The description of the SQL template |
| Tag | string | no | The tag of the SQL template |
| DatabaseUuid | string | no | The UUID of the associated database |
| CatalogUuid | string | no | The UUID of the associated folder |
| Expr | string | yes | The content of the SQL template |
| SqlParams | string | no | The custom template parameters |

### Deletes a data source and its associated metadata catalog
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-agentic-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DataSourceUuid | string | yes | The UUID of the data source to delete. Ensure that no workloads are using the data source before deletion |

### Deletes an Airflow instance
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-airflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |
| AirflowId | string | yes | The ID of the Airflow instance |
| WorkspaceId | string | yes | The ID of the workspace |

### Delete a custom agent in your personal workspace or a shared workspace. Note: Only custom agents that are…
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-custom-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | Workspace ID |
| CustomAgentId | string | yes | Custom Agent ID |

### Releases a DataAgent seat
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-data-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |

### Deletes an accuracy test configuration item
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-data-agent-accuracy-test` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| AccuracyTestInsId | string | no | The accuracy test instance ID |
| WorkspaceId | string | no | The workspace ID |
| RegionId | string | no | The region ID |
| DmsUnit | string | no | The current DMS unit |

### Deletes a DataAgent knowledge base
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-data-agent-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| WorkspaceId | string | yes | The ID of the workspace |
| KbUuid | string | yes | The ID of the knowledge base |

### Deletes MCP Servers from a specified workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-data-agent-mcp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the Data Agent workspace |
| McpServerIds | string | no | The list of MCP Server IDs to delete (JSON-encoded) |

### Deletes the memory of a DataAgent
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-data-agent-memory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| Uuid | string | no | The memory UUID |

### Deletes a DataAgent skill
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-data-agent-skill-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| SkillId | string | yes | The skill ID |

### Deletes a DataAgent workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-data-agent-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| WorkspaceId | string | no | The workspace ID |

### Deletes a document from a specified knowledge base
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KbUuid | string | yes | The knowledge base ID |
| DocumentName | string | yes | The document name |

### Deletes chunks from a document in a knowledge base
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-document-chunks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KbUuid | string | yes | The ID of the knowledge base |
| DocumentName | string | yes | The name of the document |
| ChunkIds | string | yes | A list of chunk IDs (JSON-encoded) |

### DeleteFileUpload
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-file-upload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DmsUnit | string | no | Current DMS unit |
| FileId | string | yes | File ID |
| CallFrom | string | no | Used by frontend only |

### Deletes an Ossie model from onemeta 3.0
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-one-meta-ossie-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KnowledgeUuid | string | yes | The UUID of the knowledge base |

### Deletes a knowledge base in OneMeta 3.0
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-one-meta-sql-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KnowledgeUuid | string | yes | The UUID of the knowledge base |

### Deletes a code file or directory from a workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/delete-workspace-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace |
| Path | string | yes | The full path of the code file or directory. The path must be prefixed with `/Workspace/code/` |
| Repo | string | no | The repository information |
| Symlink | string | no | Specifies whether the item to delete is a symbolic link |

### Retrieves the detailed description of a custom agent based on the custom agent ID
`POST https://apizie.tech/v1/cloud:aliyun-dms/describe-custom-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| CustomAgentId | string | no | The custom agent ID |

### DescribeCustomAgentMonitorMetrics - Retrieves monitoring metrics data for custom agents, including trend data
`POST https://apizie.tech/v1/cloud:aliyun-dms/describe-custom-agent-monitor-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| CustomAgentId | string | no | The custom agent ID. Required only when QueryType is set to CustomAgent |
| QueryType | string | no | The statistical scope. Default value: All. Valid values: Default: default DataAgent sessions. CustomAgent: specified custom agent… |
| StartTime | integer | no | The start time of the statistical period (epoch millis). Note: The maximum time range is 3 months |
| EndTime | integer | no | The end time of the statistical period (epoch millis). Note: The maximum time range is 3 months |
| Granularity | string | no | The aggregation granularity. Valid values: DAY: daily. The maximum supported time range is 3 months. HOUR: hourly. The maximum supported… |

### Queries DataAgent metrics
`POST https://apizie.tech/v1/cloud:aliyun-dms/describe-data-agent-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| MetricNames | string | no | The metric names. Separate multiple names with commas (,) |
| StartTime | integer | yes | The start time of the query range |
| EndTime | integer | yes | The end time of the query range |
| MetricType | string | yes | The metric type. Valid values: basic: basic metrics. high_level: advanced metrics |

### Retrieves the description of a DataAgent session
`POST https://apizie.tech/v1/cloud:aliyun-dms/describe-data-agent-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| SessionId | string | no | The DataAgent session ID. You can obtain this ID by calling CreateDataAgentSession |
| WorkspaceId | string | no | The workspace ID |

### Invokes the DescribeDataAgentTheme operation to query the details of a specific DataAgent theme, including…
`POST https://apizie.tech/v1/cloud:aliyun-dms/describe-data-agent-theme` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| ThemeId | string | no | The business ID of the theme |

### Retrieves the details of a specific document
`POST https://apizie.tech/v1/cloud:aliyun-dms/describe-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KbUuid | string | yes | The ID of the knowledge base |
| DocumentName | string | yes | The name of the document |

### Retrieves the signature information for file uploads
`POST https://apizie.tech/v1/cloud:aliyun-dms/describe-file-upload-signature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DmsUnit | string | no | The current DMS unit |
| CallFrom | string | no | For frontend use only |
| WorkspaceId | string | no | The workspace ID |

### Retrieves the statistics of a knowledge base
`POST https://apizie.tech/v1/cloud:aliyun-dms/describe-knowledge-base-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KbUuid | string | yes | The ID of the knowledge base |

### Generates a signature to upload a document to a knowledge base
`POST https://apizie.tech/v1/cloud:aliyun-dms/describe-knowledge-base-upload-signature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KbUuid | string | yes | The knowledge base ID |

### Retrieves the signature information for uploading skill files
`POST https://apizie.tech/v1/cloud:aliyun-dms/describe-skill-file-upload-signature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |

### Processes the file upload callback
`POST https://apizie.tech/v1/cloud:aliyun-dms/file-upload-callback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DmsUnit | string | no | The current DMS unit |
| Filename | string | yes | The name of the file |
| UploadLocation | string | yes | The full path of the uploaded file. Format: Concatenate the UploadDir field returned by the DescribeFileUploadSignature operation with the… |
| FileSize | integer | no | The size of the file, in bytes |
| CallFrom | string | no | Used only by the frontend |
| OssBucket | string | no | The name of the user's OSS bucket. Specify this parameter to use a file in the user's OSS bucket and register the file as a data center… |
| WorkspaceId | string | no | The ID of the workspace |

### Queries the agent associated with an install token after redemption. Data is empty if the token has not been…
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-agentic-agent-by-install-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| InstallToken | string | yes | The one-time install token issued by IssueAgenticInstallToken. The token starts with dit_ followed by 40 URL-safe Base64 characters,… |

### Queries the details of an Agentic DMS catalog based on the catalog UUID
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-agentic-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| CatalogUuid | string | yes | The catalog UUID. You can obtain it by calling ListAgenticCatalog or SearchAgenticCatalog |

### Queries the details of a data source by its UUID
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-agentic-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DataSourceUuid | string | yes | The UUID of the data source to query |

### Queries the details of a database in Agentic DMS based on the database UUID
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-agentic-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DatabaseUuid | string | yes | The UUID of the database. You can obtain this value by calling ListAgenticDatabase or SearchAgenticDatabase |

### Queries the fields of a table based on the database UUID and the fully qualified name of the table
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-agentic-table-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DatabaseUuid | string | yes | The UUID of the database to which the table belongs. You can obtain the UUID by calling the ListAgenticDatabase or SearchAgenticDatabase… |
| TableQualifiedName | string | yes | The fully qualified name of the table. You can obtain the name from the QualifiedName parameter returned by the ListAgenticTableBaseInfo… |

### Queries the indexes of a table based on the database UUID and the fully qualified name of the table
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-agentic-table-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DatabaseUuid | string | yes | The UUID of the database to which the table belongs. You can obtain this value by calling ListAgenticDatabase or SearchAgenticDatabase |
| TableQualifiedName | string | yes | The fully qualified name of the table. You can obtain this value from the QualifiedName parameter returned by ListAgenticTableBaseInfo.… |

### Queries the configuration and status of an Airflow instance
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-airflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| AirflowId | string | yes | The ID of the Airflow instance |
| WorkspaceId | string | yes | The ID of the workspace |

### Retrieves chat content from a specific checkpoint by specifying the session ID and AgentId
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-chat-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit. Chinese mainland users of Alibaba Cloud should use cn-hangzhou by default |
| SessionId | string | no | The session ID. This parameter is required |
| AgentId | string | no | The agent ID. This parameter is required |
| Checkpoint | string | no | The backend will return output starting from this checkpoint |

### Queries the details of an MCP Server by its ID, including the workspace, network, connection method, and…
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-data-agent-mcp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The Data Agent workspace ID |
| McpServerId | string | yes | The unique identifier of the MCP Server to query |

### Retrieves information about a RAM user that belongs to an Alibaba Cloud account
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-data-agent-sub-account-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DmsUnit | string | no | The current DMS unit |
| SubAccountId | string | no | The UID of the RAM user |

### Queries the model usage summary of DataAgent analysis tasks within a specified time range, including the…
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-data-agent-task-model-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| DMSUnit | string | no | The current DMS unit |
| BeginTime | integer | no | The start time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no more than one month |
| EndTime | integer | no | The end time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no more than one month |
| PayLevel | string | no | The billing level |
| InstanceIds | string | no | The list of billing instance IDs to be queried (JSON-encoded) |

### Queries the time-series metrics of tokens per minute (TPM) for DataAgent analysis task model usage within a…
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-data-agent-task-model-usage-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| DMSUnit | string | no | The current DMS unit |
| BeginTime | string | no | The start time of the query time range. The value is a UNIX timestamp in seconds. The recommended time range is up to one month |
| EndTime | string | no | The end time of the query time range. The value is a UNIX timestamp in seconds. The recommended time range is up to one month |
| PayLevel | string | no | The billing level |
| InstanceIds | string | no | The list of billing instance IDs to query (JSON-encoded) |

### Calls the GetDataAgentThemeUploadSignature operation to obtain OSS direct upload credentials for uploading a…
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-data-agent-theme-upload-signature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| ThemeId | string | no | The UUID of the theme. By default, you do not need to specify this parameter because the backend automatically generates and returns a… |

### Queries the details of a workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-data-agent-workspace-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| WorkspaceId | string | no | The ID of the workspace |

### Queries the MCP Server connectivity and tool list results by the Session ID returned when the detection was…
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-list-mcp-server-tools-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The DMS unit identifier. This value is typically the same as the DMSUnit used in the request that started the tool detection |
| SessionId | string | no | The temporary session ID returned by StartListMcpServerTools. This ID is used to locate the connectivity detection task |
| McpServerUuid | string | no | The MCP Server ID used when the detection was started. This value must match the detection record associated with the SessionId |

### Submits a task to schedule and run a Notebook file
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-notebook-and-submit-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| Path | string | yes | The path of the Notebook file |
| Params | string | yes | The input parameters for the Notebook file. Pass the parameters in a dictionary format |
| SessionId | string | yes | The session ID |
| Retry | integer | no | The number of retries if scheduling fails |
| WorkspaceId | string | no | The workspace ID |

### Retrieves the execution status of a Notebook task
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-notebook-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| TaskId | string | no | The scheduling task ID |
| WorkspaceId | string | no | The workspace ID |
| SessionId | string | no | The Notebook session ID |

### Retrieves the Ossie model of onemeta 3.0
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-one-meta-ossie-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KnowledgeUuid | string | yes | The UUID of the knowledge base |
| DocFormat | string | yes | The document type of the semantic model. Valid values: JSON and YAML |

### Queries the operation logs of the SQL window
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-sql-console-operation-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| InstanceId | integer | no | The instance ID |
| Username | string | no | The username |
| Schema | string | no | The database schema |
| SqlType | string | no | The SQL statement type |
| PageNumber | integer | yes | The page number. Pages start from page 1 |
| PageSize | integer | yes | The number of entries per page. Maximum value: 100 |
| StartTime | string | yes | The start time of the logs |
| EndTime | string | yes | The end time of the logs |

### Reads the content of a code file in the workspace and returns the file content along with mtime (in the…
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-workspace-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID |
| Path | string | yes | The code file path: /Workspace/code/test.py Request path |
| Iac | string | no | If the file is a JSON file and Iac is set to true, the returned content is converted from JSON format to YAML format |

### Retrieves the deployment configuration of a workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-workspace-code-publish-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace |

### Returns the quota for a workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/get-workspace-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the DMS workspace |

### Creates an SQL template
`POST https://apizie.tech/v1/cloud:aliyun-dms/import-one-meta-ossie-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| Tag | string | no | The semantic model tag |
| DatabaseUuid | string | no | The UUID of the associated database |
| CatalogUuid | string | yes | The UUID of the associated folder |
| Document | string | yes | The semantic model document definition |
| DocFormat | string | yes | The semantic model document type. Valid values: JSON and YAML |
| Source | string | yes | The source of the semantic model |
| Title | string | no | The semantic title. If the value is empty, the title is extracted from the document |
| Description | string | no | The semantic description |

### Installs all currently available system MCP services for a specified Data Agent workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/init-workspace-system-mcp-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the Data Agent workspace for which to initialize system MCP services. The caller must have at least MEMBER permissions on the… |

### Imports an MCP into DataAgent
`POST https://apizie.tech/v1/cloud:aliyun-dms/install-data-agent-mcp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| Name | string | no | The MCP name |
| Description | string | no | The brief description of the artifact. This parameter can be empty |
| NetType | string | no | The network type. Valid values: `vpc`: virtual private cloud. `public`: public network |
| VpcId | string | no | VPC ID |
| VswId | string | no | The vSwitch ID |
| TransportType | string | no | The transport channel type. Valid values: streamablehttp and sse |
| Endpoint | string | no | The endpoint of the MCP instance |
| Headers | string | no | The request header settings |
| FromJson | string | no | The JSON used to create the MCP |
| NeedUidInHeader | string | no | Specifies whether to include the Alibaba Cloud UID in the request header |

### Performs a paging query on the catalogs in Agentic DMS. You can filter the results by catalog type and name…
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-agentic-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| CatalogType | string | no | The catalog type. This parameter is used to filter catalogs by exact type. Valid values: JDBC: relational database catalog DataLake: data… |
| SearchKey | string | no | The search keyword for the catalog name. Matches catalogs by name prefix |
| NextToken | string | no | The token for the next query. You do not need to specify this parameter for the first query. To query the next page, set this parameter to… |
| MaxResults | integer | no | The maximum number of entries to return per page |

### Performs a paged query on the data sources of the current account by using paging
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-agentic-data-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DbType | string | no | Filters data sources by type. If you leave this parameter empty, no restriction is applied. Valid values: MYSQL, POSTGRESQL, ORACLE,… |
| State | integer | no | Filters data sources by status. If you leave this parameter empty, no restriction is applied. Valid values: 0: normal -1: deleted -2:… |
| Host | string | no | Filters data sources by endpoint. If you leave this parameter empty, no restriction is applied |
| Port | integer | no | Filters data sources by connection port. If you leave this parameter empty, no restriction is applied |
| InstanceSource | string | no | Filters data sources by source. If you leave this parameter empty, no restriction is applied. Valid values: RDS: ApsaraDB instance… |
| Schema | string | no | Filters data sources by connection target name. The meaning of this parameter varies based on the data source type. If you leave this… |
| SearchKey | string | no | Performs a fuzzy search by data source name or endpoint. If you leave this parameter empty, no fuzzy search is performed |
| NextToken | string | no | The pagination cursor. Leave this parameter empty when you query the first page. When you query subsequent pages, pass the NextToken value… |
| MaxResults | integer | no | The number of entries to return per page. Default value: 20. Maximum value: 200 |

### Performs a paged query for the list of databases in a specified catalog, with options to filter by name…
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-agentic-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| CatalogUuid | string | yes | The UUID of the catalog to which the database belongs. You can obtain the UUID by calling ListAgenticCatalog or SearchAgenticCatalog |
| SearchKey | string | no | The search keyword used to match the database name or the prefix of the fully qualified name |
| SortFieldName | string | no | The field used for sorting. This parameter is case-sensitive. Valid values: name: Sorts by database name. qualifiedName: Sorts by the… |
| SortOrder | string | no | The sort order. This parameter takes effect only when SortFieldName is specified. This parameter is case-insensitive. Valid values: ASC… |
| NextToken | string | no | The token for the next query. You do not need to specify this parameter for the first query. When you query the next page, set this… |
| MaxResults | integer | no | The maximum number of entries to return per page |

### Queries the SQL execution history within the current tenant and returns the results in descending order of…
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-agentic-global-sql-execution-histories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| CatalogUuid | string | no | The catalog UUID for exact match. You can obtain this value by calling ListAgenticCatalog or SearchAgenticCatalog |
| DatabaseUuid | string | no | The database UUID for exact match. You can obtain this value by calling ListAgenticDatabase or SearchAgenticDatabase |
| Page | integer | no | The page number. Pages start from 1. Default value: 1 |
| Size | integer | no | The number of entries per page. Default value: 20. Maximum value: 100 |
| StartTime | string | no | The start time of the query. Specify the time in the yyyy-MM-dd HH:mm:ss format. If you do not specify this parameter, the default time… |
| EndTime | string | no | The end time of the query. Specify the time in the yyyy-MM-dd HH:mm:ss format. If you do not specify this parameter, the default end time… |
| SqlKeyword | string | no | The keyword for fuzzy match based on the original SQL statement |
| SqlType | string | no | The SQL type for exact match |
| ActorId | string | no | The ID of the actor. A user ID starts with usr_, and an agent ID starts with agt_. If you do not specify this parameter, all records… |
| ActorName | string | no | The name of the actor for exact match |
| ActorType | string | no | The type of the actor for exact match. Valid values: HUMAN and AGENT |
| Scenario | string | no | The execution scenario for exact match. Valid values: AGENT_QUERY: The agent directly executes the SQL statement. WORKFLOW_QUERY: The SQL… |

### Queries the SQL execution history visible to the current caller, sorted in descending order by execution…
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-agentic-sql-execution-histories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| CatalogUuid | string | no | The catalog UUID for exact matching. You can obtain this value by calling ListAgenticCatalog or SearchAgenticCatalog |
| DatabaseUuid | string | no | The database UUID for exact matching. You can obtain this value by calling ListAgenticDatabase or SearchAgenticDatabase |
| Page | integer | no | The page number. Pages start from 1. Default value: 1 |
| Size | integer | no | The number of entries per page. Default value: 20. Maximum value: 100 |
| StartTime | string | no | The start time of the query. Specify the time in the yyyy-MM-dd HH:mm:ss format. If you do not specify this parameter, the default time… |
| EndTime | string | no | The end time of the query. Specify the time in the yyyy-MM-dd HH:mm:ss format. If you do not specify this parameter, the default value is… |
| SqlKeyword | string | no | The keyword for fuzzy matching against the original SQL statement |
| SqlType | string | no | The SQL type for exact matching |
| ActorId | string | no | The ID of the actor. User IDs start with usr_, and agent IDs start with agt_. If you do not specify this parameter, a user queries their… |
| ActorName | string | no | The name of the actor for exact matching |
| ActorType | string | no | The type of the actor for exact matching. Valid values: HUMAN and AGENT |
| Scenario | string | no | The execution scenario for exact matching. Valid values: AGENT_QUERY: The agent directly executes the SQL statement. WORKFLOW_QUERY: The… |

### Queries the basic information and engine metadata of tables in a specified database by using paging. You can…
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-agentic-table-base-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DatabaseUuid | string | yes | The UUID of the database to which the table belongs. You can obtain the UUID by calling the ListAgenticDatabase or SearchAgenticDatabase… |
| SearchKey | string | no | The search keyword. The system matches the keyword against table names. The results are sorted by exact match, prefix match, and contains… |
| TableType | string | no | The table type. The results are strictly filtered by this type. Valid values: NORMAL: Regular table. VIEW: View. FOREIGN: Foreign table.… |
| SortFieldName | string | no | The field by which to sort the results. This parameter is case-sensitive. Valid values: name: Sorts the results by table name. This value… |
| SortOrder | string | no | The sort order. This parameter takes effect only when SortFieldName is specified. This parameter is not case-sensitive. Valid values: ASC:… |
| NextToken | string | no | The token for the next query. You do not need to specify this parameter for the first query. When you query the next page, set this… |
| MaxResults | integer | no | The maximum number of entries to return per page |

### Lists the available Airflow versions
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-airflow-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the DMS workspace |

### Retrieves a list of Airflow instances in a workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-airflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the DMS workspace |
| MaxResults | integer | no | The number of entries per page |
| NextToken | string | no | The token that is used to retrieve the next page of results |
| PageIndex | integer | no | The page number. The value starts from 1 |
| Skip | integer | no | The number of records to skip. This is used for paging |

### Lists all custom agents in personal and team workspaces
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-custom-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| SearchKey | string | no | The search keyword. Supports fuzzy search for custom agent names and descriptions |
| AgentType | string | no | The custom agent type. Valid values: Default: system built-in custom agent Common: regular custom agent |
| Status | string | no | The custom agent status |
| QueryAllReleased | string | no | Specifies whether to query all published custom agents. Default value: false |
| PageNumber | integer | no | The page number. Pages start from 1 |
| PageSize | integer | no | The number of entries per page. Default value: 20 |

### ListCustomAgentMonitorSessions - Retrieves the list of monitoring sessions for custom agents
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-custom-agent-monitor-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| CustomAgentId | string | no | The custom agent ID. Required only when QueryType is set to CustomAgent |
| QueryType | string | no | The query scope. Default value: All. Valid values: Default: default DataAgent sessions. CustomAgent: specified custom agent sessions. All:… |
| StartTime | integer | no | The start time for statistics (epoch millis). Note: The maximum time range is 3 months |
| EndTime | integer | no | The end time for statistics (epoch millis). Note: The maximum time range is 3 months |
| PageNumber | integer | no | The page number, starting from 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Valid values: 1 to 200. Default value: 20 |

### Lists the accuracy test configuration items that meet the specified conditions
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-agent-accuracy-test-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| AccuracyTestInsId | string | no | The accuracy test instance ID |
| WorkspaceId | string | no | The ID of the workspace |
| PageSize | string | no | The number of entries per page |
| PageNumber | string | no | The page number |
| MaxResults | integer | no | The maximum number of results to return |
| NextToken | string | no | The next token |

### Retrieves the execution results of a self-test task
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-agent-accuracy-test-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| AccuracyTestInsId | string | no | The instance ID of the accuracy test to which the task belongs |
| AccuracyTestTaskId | string | no | The ID of the accuracy test task |
| AccuracyTestSubtaskId | string | no | The ID of the subtask used to filter results |
| AccuracyTestResultId | string | no | The ID of the result used to exactly match a single record |
| WorkspaceId | string | no | The ID of the workspace |
| PageSize | string | no | The number of entries per page |
| PageNumber | string | no | The page number |
| RegionId | string | no | The region ID |
| MaxResults | integer | no | The maximum number of results per page |
| NextToken | string | no | The pagination token |

### Queries the running status of accuracy test nodes by using paging
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-agent-accuracy-test-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| AccuracyTestInsId | string | no | The accuracy test instance ID |
| AccuracyTestTaskId | string | no | Filters by the exact task ID |
| PageSize | string | no | The number of entries per page |
| PageNumber | string | no | The page number |
| MaxResults | integer | no | The maximum number of entries per page |
| NextToken | string | no | The pagination token |

### Queries MCP Servers in a specified workspace by paging. You can filter results by name, ready status, and…
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-agent-mcp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The Data Agent workspace ID. The caller must have at least MEMBER permissions on this workspace |
| SearchKey | string | no | The keyword for name search. The server performs a fuzzy match against MCP Server names |
| PageNumber | integer | no | The page number. Pages start from 1. Default value: 1 |
| PageSize | integer | no | The number of records per page. Valid values: 1 to 500. Default value: 20 |
| ReadyOnly | string | no | Specifies whether to return only MCP Servers that are enabled and in the ready state. Default value: false |
| MaxResults | integer | no | A compatible pagination parameter. The actual number of records per page is controlled by PageSize |
| NextToken | string | no | A compatible pagination token. The actual page sequence is controlled by PageNumber |
| Type | string | no | The MCP Server type. Valid values: system: system MCP. customer: custom MCP |

### Retrieves the DataAgent memory list (up to 50 memories per RAM user)
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-agent-memory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current Data Management unit |
| PageNum | integer | no | The page number. Minimum value: 1 |
| PageSize | integer | no | The maximum number of entries per page. Default value: 50 |
| ContentPattern | string | no | The content pattern used for fuzzy match search |
| Order | string | no | The sort order for the specified sort field. Default value: desc. Valid values: asc: Ascending order. desc: Descending order |
| OrderBy | string | no | The sort field. Default value: hitTimes. Valid values: hitTimes: The number of hits. created: The creation time |
| QueryAll | string | no | Specifies whether to query memories in all statuses. Default value: true |
| MemFrom | string | no | The memory source. Valid values: session: Generated from a session. user: Edited by a user |
| FromId | string | no | The source ID. If MemFrom is set to session, FromId indicates the session ID. If MemFrom is set to user, FromId indicates the RAM user ID |

### Retrieves the list of historical session descriptions for Data Agent
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-agent-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| CreateStartTime | integer | no | The start time of the session creation time range |
| CreateEndTime | integer | no | The end time of the session creation time range |
| IsSaved | string | no | Specifies whether to retrieve only favorited sessions |
| WorkspaceId | string | no | The workspace ID |
| QueryType | string | no | The session type. This parameter is required when a workspace is specified |
| CreatorId | string | no | The ID of the session creator |
| Title | string | no | The Data Agent title. Fuzzy match is supported |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of records per page |
| CustomAgentId | string | no | The custom agent ID |
| Mode | string | no | The mode. Valid values: Analysis Coding |

### Retrieves the list of DataAgent skills
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-agent-skill-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| SearchKey | string | no | The keyword for fuzzy match |
| WorkspaceId | string | no | The workspace ID |
| SkillId | string | no | The skill ID |
| SkillName | string | no | The skill name |
| SkillFrom | string | no | The source of the skill. Valid values: User: a skill uploaded by the user. Agent: a skill derived from Agent analysis |
| PageNumber | integer | no | The page number, starting from 1 |
| PageSize | integer | no | The number of records per page. Default value: 20 |

### Calls the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter results…
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-agent-theme` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page |
| ThemeType | string | no | The theme stage. Valid values: design: The theme contains only design.md. template: The theme is complete and renderable |
| ThemeFrom | string | no | The source of the theme. Valid values: system custom derived |
| Category | string | no | The common scenario of the theme. Valid values: report, infographic, and others |
| WorkspaceId | string | no | The workspace context. If this parameter is left empty or set to personal, the personal workspace is used. To query themes in a… |
| MaxResults | integer | no | [Not currently supported] The maximum number of entries per page. Maximum value: 100 |
| NextToken | string | no | [Not currently supported] The pagination token for the next query. Valid values: If NextToken is empty, no next query exists. If NextToken… |

### Queries a paginated list of collaborative workspaces under the Alibaba Cloud account
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-agent-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| WorkspaceType | string | yes | The workspace type to query |
| WorkspaceName | string | no | The name of the workspace |
| PageNumber | string | yes | The starting page number |
| PageSize | string | yes | The number of entries per page |
| MaxResults | integer | no | The maximum number of results per page |
| NextToken | string | no | The next token |
| Order | string | no | The sort order |
| OrderBy | string | no | The name of the field to sort by |
| Creator | string | no | The ID of the creator used to search for workspaces |

### Lists all members in a workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-agent-workspace-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| WorkspaceId | string | no | The workspace ID |
| SearchMemberId | string | no | The prefix of the member ID to query |
| SearchRoleName | string | no | The prefix of the member name to query |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries to return on each page |
| MaxResults | integer | no | The number of entries per page |
| NextToken | string | no | The token |
| Order | string | no | The sort order |
| OrderBy | string | no | The sort field |

### Retrieves the list of files uploaded by users in the data center. Only file types are supported. Database…
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-center-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DmsUnit | string | no | The current DMS unit |
| WorkspaceId | string | no | The workspace ID |
| ImportType | string | no | The import type. Valid values: FILE |
| SearchKey | string | no | The keyword used for fuzzy search of databases |
| CallFrom | string | no | Used only by the frontend |
| Language | string | no | Used only by the frontend |

### Retrieves a list of user-uploaded tables from the data center, for file types only
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-data-center-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DmsUnit | string | no | The current DMS unit |
| InstanceName | string | no | The name of the instance. If `ImportType` is `FILE`, this parameter represents the file ID of the data center |
| DatabaseName | string | no | The name of the database. If `ImportType` is `FILE`, this parameter represents the file name |
| TableName | string | no | The name of the table |
| SearchKey | string | no | The keyword for a fuzzy search of database tables |
| ImportType | string | no | The import type. FILE |
| PageNumber | integer | no | The page number, starting from 1 |
| PageSize | integer | no | The number of records to return per page. Default: 20 |
| CallFrom | string | no | For frontend use only |

### Queries a list of chunks
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-document-chunks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KbUuid | string | yes | The ID of the knowledge base |
| DocumentName | string | no | The name of the document |
| NextToken | string | no | The token used to retrieve the next page of results. Omit this parameter to get the first page. If the response returns a `NextToken`, it… |
| MaxResults | integer | no | The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 20 |
| ChunkTitlePattern | string | no | A filter pattern. The operation returns only the chunks whose titles contain this pattern |
| SortFieldName | string | no | The sort field. Valid values: id (default): The chunk ID. hits: The number of hits. modifyTime: The modification time |
| SortOrder | string | no | The sort order. Valid values: ASC (default): ascending order. DESC: descending order |

### Lists the documents in a knowledge base
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KbUuid | string | yes | The ID of the knowledge base |
| NextToken | string | no | The pagination token to retrieve the next page of results. Omit this parameter to retrieve the first page. A `NextToken` value in the… |
| MaxResults | integer | no | The maximum number of documents to return per page. Valid values: 1 to 100. Default value: 20 |
| NamePattern | string | no | The document name filter. Returns only documents whose names contain this value |
| SortFieldName | string | no | The sort field. Valid values: `id` (default): The document ID. `hits`: The number of hits. `modifyTime`: The modification time |
| SortOrder | string | no | The sort order. Valid values: ASC (default): Sorts in ascending order. DESC: Sorts in descending order |
| Filters | string | no | The document property filter. The following properties are supported: `fileExt`: The document extension. `state`: The document status |

### ListFileUpload
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-file-upload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DmsUnit | string | no | The current DMS unit |
| SessionId | string | no | The session ID |
| FileId | string | no | The file ID |
| CallFrom | string | no | For front-end use only |
| FileFrom | string | no | The file source |
| FileCategory | string | no | The file category |
| SortColumn | string | no | The sort column |
| SortDirection | string | no | The sort direction |
| DownloadLinkExpire | integer | no | The validity period of the download link, in seconds. This parameter applies only to files in user-owned Object Storage Service (OSS)… |

### Returns a paginated list of knowledge bases
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-knowledge-bases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| Tag | string | yes | The tag of the knowledge base. In DataAgent, this is the space ID |
| NamePattern | string | no | A keyword to search for in the names of knowledge bases |
| NextToken | string | no | The token used to retrieve the next page of results. Valid values: Omit this parameter for the first request. If the previous response… |
| MaxResults | integer | no | The maximum number of entries to return on each page. Use this parameter with the `NextToken` parameter to implement pagination |
| Filters | string | no | The filter conditions for the knowledge bases, specified as a JSON string. The only supported key is `state`. Valid values are `0` and `1` |
| SortFieldName | string | no | The sort field. Valid values: `id`: Sorts by knowledge base ID. This is the default. `name`: Sorts by knowledge base name |
| SortOrder | string | no | The sort order. Valid values: ASC: Ascending order. This is the default. DESC: Descending order |

### Retrieves a list of OSSIE models
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-one-meta-ossie-models` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| Query | string | yes | The search keyword |
| MaxResults | integer | no | The maximum number of records per page |
| NextToken | string | no | The token for the next query |
| Tag | string | no | The semantic model tag |
| CatalogUuid | string | no | The UUID of the associated folder |
| EnableVectorSearch | string | no | Specifies whether to use semantic search |
| DatabaseUuid | string | no | The UUID of the associated database |

### Retrieves SQL templates
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-one-meta-sql-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| Query | string | yes | The search keyword |
| MaxResults | integer | no | The maximum number of entries to return in this response |
| NextToken | string | no | The pagination token for the next query |
| Tag | string | no | The SQL template tag |
| DatabaseUuid | string | no | The UUID of the associated database |
| CatalogUuid | string | no | The UUID of the associated catalog |
| EnableVectorSearch | string | no | Specifies whether to use semantic search |
| Uuids | string | no | The UUIDs of knowledge instances. Separate multiple UUIDs with commas (,) |

### Lists code files and directories at a specified path in a workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/list-workspace-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace |
| Path | string | yes | The path of the file or directory |

### Modifies a custom agent in a personal or team workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/modify-custom-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| CustomAgentId | string | yes | The ID of the custom agent |
| Name | string | no | The name of the custom agent |
| Description | string | no | The description of the custom agent |
| DataJson | string | no | The specified data scope in JSON character string format. General metric descriptions: tableFlag: true indicates that a data scope is… |
| Instruction | string | no | The instructions. Input limit: Maximum of 10,000 characters |
| Knowledge | string | no | The knowledge. Input limit: Maximum of 10,000 characters |
| KnowledgeConfigList | string | no | The external knowledge bases (JSON-encoded) |
| KnowledgeSemanticConfigList | string | no | The knowledge semantic configuration list (JSON-encoded) |
| UserSpecifiedSkillList | string | no | The list of user-specified skills (JSON-encoded) |
| RecommendQuestionList | string | no | The list of recommended questions. You can configure up to 10 recommended questions (JSON-encoded) |
| ExecutionConfig | string | no | The execution configuration (JSON-encoded) |
| ScheduleTaskConfig | string | no | The scheduled task configuration (JSON-encoded) |
| TextReportConfig | string | no | The text report format. Input limit: Maximum of 10,000 characters |
| WebReportConfig | string | no | The web report format. Input limit: Maximum of 50,000 characters |
| WebReportTheme | string | no | The web report theme. Valid values: default: Default. journal: Journal. legacy: Legacy. neobrutalism: Neobrutalism. infographic: Infographic |
| DMSUnit | string | no | The current DMS unit |
| CallbackConfig | string | no | The callback feature configuration (JSON-encoded) |
| RelatedSessionId | string | no | The ID of the referenced historical session |

### Modifies the configuration of an MCP server
`POST https://apizie.tech/v1/cloud:aliyun-dms/modify-data-agent-mcp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID |
| McpServerId | string | yes | The ID of the MCP server |
| Name | string | no | The MCP name |
| Description | string | no | The brief description of the artifact. This parameter can be empty |
| Enable | string | no | Specifies whether the MCP server is enabled |
| Headers | string | no | The request header settings |
| TransportType | string | no | The transport channel type. Valid values: streamablehttp, sse |
| Endpoint | string | no | The endpoint of the MCP instance |
| NeedUidInHeader | string | no | Specifies whether to include the Alibaba Cloud UID in the request header |

### Modifies the display name and description of a DataAgent theme. A null parameter value indicates that the…
`POST https://apizie.tech/v1/cloud:aliyun-dms/modify-data-agent-theme` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| ThemeId | string | no | The business ID of the theme |
| ThemeName | string | no | The display name. Maximum length: 64 characters. A null value indicates that the field is not modified, and an empty string clears the field |
| Description | string | no | The description. Maximum length: 255 characters. A null value indicates that the field is not modified, and an empty string clears the field |

### Operate custom agents in personal spaces and workspaces
`POST https://apizie.tech/v1/cloud:aliyun-dms/operate-custom-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | Workspace ID |
| CustomAgentId | string | yes | Custom Agent ID |
| OperateType | string | yes | Operation type |

### Redeploy an Airflow instance
`POST https://apizie.tech/v1/cloud:aliyun-dms/redeploy-airflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| AirflowId | string | yes | The unique ID of the Airflow instance |
| WorkspaceId | string | yes | The ID of the DMS workspace |

### Removes a user from a workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/remove-user-to-data-agent-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | The current DMS unit |
| WorkspaceId | string | no | The workspace ID |
| MemberId | string | no | The UID of the member account to remove |

### Resets the Access Token of a specified data gateway. The associated Agent and name are retained, and only…
`POST https://apizie.tech/v1/cloud:aliyun-dms/reset-agentic-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| Id | integer | yes | The ID of the data gateway Access Token to reset. This value is the same as the Id returned by the create and query operations. Only the… |
| ExpireAfterSeconds | integer | no | The validity period of the new Access Token starting from the time of this reset, in seconds. Valid values: 1 to 31536000 (approximately… |

### Query a knowledge base
`POST https://apizie.tech/v1/cloud:aliyun-dms/retrieve-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| KbUuid | string | yes | The ID of the knowledge base |
| Query | string | yes | The query text |
| TopK | integer | no | The number of top-ranked results to return |
| Filter | string | no | A filter for the data, specified as a SQL `WHERE` clause |
| Metrics | string | no | The distance metric for retrieval. If unspecified, this defaults to the metric configured for the knowledge base. Only set this parameter… |
| HybridSearch | string | no | The hybrid search algorithm. If this parameter is not set, the system directly compares and ranks the scores from the dense vector and… |
| HybridSearchArgs | string | no | Parameters for the specified `HybridSearch` algorithm. Both `RRF` and `Weight` are supported. You can use the `HybridPathsSetting` object… |
| IncludeVector | string | no | Specifies whether to include the vector in the results. The default value is `false`. false: The vector is not returned. true: The vector… |
| IncludeMetadataFields | string | no | The metadata fields to return, separated by commas. By default, no metadata fields are returned |
| RerankFactor | number | no | The factor used to rerank vector search results. The value must be in the range (1, 5]. Reranking may be slow if document chunks are… |
| RecallWindow | string | no | The recall window. If specified, this parameter expands the context of the retrieved results. The format is a two-element array `[A, B]`,… |
| OrderBy | string | no | The field to use for sorting the results. By default, this parameter is empty. The field must be a metadata field or a default table… |
| Offset | integer | no | The offset for pagination |

### Saves workspace code. If the file does not exist, a new file is automatically created
`POST https://apizie.tech/v1/cloud:aliyun-dms/save-workspace-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace to publish (numeric ID) |
| Path | string | yes | The file path to save |
| Content | string | yes | The code content |
| Force | string | no | Specifies whether to forcibly overwrite the file regardless of whether it has been modified by others |
| Repo | string | no | The repository information. Pass this parameter when creating a git repo directory during the save action |
| Mtime | string | no | The file modification time. The GetWorkspaceCode operation returns this mtime value. When calling SaveWorkspaceCode, include this mtime to… |
| Iac | string | no | Specifies whether the file is an infrastructure as code template file. Set this parameter to true for YAML configuration files edited… |

### Searches for catalogs in Agentic DMS by keyword, catalog type, database type, or a list of catalog UUIDs,…
`POST https://apizie.tech/v1/cloud:aliyun-dms/search-agentic-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| SearchKey | string | no | The search keyword. It matches the catalog name, data source alias, or the prefix of the data source endpoint. A catalog is matched if any… |
| CatalogType | string | no | The catalog type. Filters catalogs by exact type. Valid values: JDBC: relational database catalog. DataLake: data lake catalog. Dataset:… |
| DbType | string | no | The database type. Filters catalogs exactly by the database type of the associated data source. The value is the uppercase name of the… |
| CatalogUuids | string | no | The list of catalog UUIDs. Filters catalogs exactly by UUID. Separate multiple UUIDs with commas (,). You can specify up to 500 UUIDs, and… |
| NextToken | string | no | The token for the next query. This parameter is not required for the first query. To query the next page, set this parameter to the… |
| MaxResults | integer | no | The maximum number of entries to return per page |

### Searches for databases across catalogs by keyword. You can filter the results by catalog, database type, and…
`POST https://apizie.tech/v1/cloud:aliyun-dms/search-agentic-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| SearchKey | string | no | The search keyword. It matches the name, fully qualified name, and search name of the database, as well as the name or data source alias… |
| CatalogUuid | string | no | The UUID of the catalog that limits the search scope. If you do not specify this parameter, the search is performed across all catalogs |
| DbType | string | no | The database type. This parameter filters the results exactly by the database type of the data source associated with the catalog. The… |
| EnvType | string | no | The environment type. This parameter filters the results exactly by the environment of the associated data source. Valid values: product,… |
| NextToken | string | no | The token for the next query. You do not need to specify this parameter for the first query. When you query the next page, set this… |
| MaxResults | integer | no | The maximum number of entries to return per page |

### Sends a user message to a specified session or cancels the session
`POST https://apizie.tech/v1/cloud:aliyun-dms/send-chat-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DMSUnit | string | no | [Optimized] This field is now automatically retrieved in the background. You do not need to specify it when calling the API |
| SessionId | string | no | The session ID. This optional field is used for multi-turn sessions. You can start a session without specifying this field. The response… |
| AgentId | string | no | [Optimized] This field is now automatically retrieved in the background. You do not need to specify it |
| Message | string | yes | The content of the message sent to the agent |
| MessageType | string | no | The message type. Default value: `primary`. In normal interactions with the agent, the message type is `primary`. When the message is a… |
| ReplyTo | string | no | Important When this message is a reply to an agent message, such as an agent asking for clarification through ASK_HUMAN, `reply_to` must… |
| QuotedMessage | string | no | The quoted content. This is typically used when interacting with the agent |
| Question | string | no | Required when the message type is `additional`. Specifies the specific question asked by the agent to the user through human-in-the-loop |
| DataSource | string | no | The data source information. This parameter can be left empty. You can specify only one data source for this parameter. Use the… |
| SessionConfig | string | no | The special configurations for the current session. For the same session, only the configurations specified in the first SendMessage call… |
| ParentSessionId | string | no | The ID of the parent session |
| DataSources | string | no | The detailed data source information. This parameter can be left empty (JSON-encoded) |
| TaskConfig | string | no | The configuration items that affect only the current task (JSON-encoded) |
| WorkspaceId | string | no | The workspace ID |
| UserOssBucket | string | no | The Object Storage Service (OSS) bucket of the user. If this parameter is left empty, the analysis process is securely stored in the… |

### Sets the code deployment configuration for a workspace. This is an asynchronous operation that returns a…
`POST https://apizie.tech/v1/cloud:aliyun-dms/set-workspace-code-publish-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The numeric ID of the workspace |
| Config | string | yes | The deployment configuration, provided as a JSON string. The repos array specifies the Git repositories in the workspace, primarily for… |

### Sets the quota for a workspace
`POST https://apizie.tech/v1/cloud:aliyun-dms/set-workspace-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the Data Management Service (DMS) workspace |
| CuQuota | integer | yes | The compute unit (CU) quota for the workspace |
| Region | string | yes | The ID of the region |
| AutoPay | string | no | Specifies whether to enable auto-payment for the order |
| ClientToken | string | no | A unique, client-generated token to ensure request idempotence. The token can contain only ASCII characters and must be no longer than 64… |

### Initiates an accuracy self-test task
`POST https://apizie.tech/v1/cloud:aliyun-dms/start-data-agent-accuracy-test-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| AccuracyTestInsId | string | no | The accuracy test instance ID |
| WorkspaceId | string | no | The workspace ID |
| RegionId | string | no | The region ID |
| DmsUnit | string | no | The DMS unit used to create the resource |
| CsvFile | string | no | The accuracy test sample file |

### Asynchronously starts MCP Server connectivity and tool list detection. The first call prompts you to wait…
`POST https://apizie.tech/v1/cloud:aliyun-dms/start-list-mcp-server-tools` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| McpServerUuid | string | no | The ID of the MCP Server for which to detect connectivity and query the tool list. Only the service creator can trigger the detection |
| Language | string | no | The language used for the detection session |
| DMSUnit | string | no | The identifier of the Data Management unit that runs the Data Agent resources |

### Stops an accuracy self-test task
`POST https://apizie.tech/v1/cloud:aliyun-dms/stop-data-agent-accuracy-test-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| AccuracyTestTaskId | string | no | The ID of the accuracy test task |
| WorkspaceId | string | no | The ID of the workspace |
| RegionId | string | no | The region ID |

### Tests whether the network and authentication information of a data source are available
`POST https://apizie.tech/v1/cloud:aliyun-dms/test-agentic-data-source-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| InstanceSource | string | yes | The source of the data source. Valid values: RDS: ApsaraDB instance. PUBLIC_OWN: self-managed database connected over the Internet.… |
| InstanceResourceId | string | no | The ID of the cloud resource instance. This parameter is required when you select an existing cloud instance. You can leave this parameter… |
| Alias | string | no | The alias. You can leave this parameter empty when testing a connection. This parameter does not create or modify a data source |
| CatalogName | string | no | The catalog name. You can leave this parameter empty when testing a connection. This parameter does not create a metadata catalog |
| DbType | string | yes | The type of the data source. Use uppercase letters. Do not pass numbers. Valid values: MYSQL, POSTGRESQL, ORACLE, SQLSERVER, MARIADB,… |
| Host | string | no | The domain name or IP address of the database. Do not include the protocol, path, or port. This parameter is optional. You can leave this… |
| Port | integer | no | The service port of the database. This parameter is optional. You can leave this parameter empty when you select an existing cloud… |
| Schema | string | no | The schema name. This parameter is optional. For ADB_POSTGRESQL, DRDS, POSTGRESQL, and POLARDB_POSTGRESQL, enter the database name. For… |
| SnowflakeWarehouse | string | no | The name of the Snowflake compute warehouse. This parameter takes effect only when DbType is set to SNOWFLAKE |
| SnowflakeRole | string | no | The name of the Snowflake role. This parameter takes effect only when DbType is set to SNOWFLAKE |
| AuthType | integer | no | The authentication type. This parameter is optional. Valid values: -1 (no authentication required), 0 (username and password), 1 (password… |
| AuthAccount | string | no | The logon username. You can leave this parameter empty for authentication methods that do not require a username |
| AuthPassword | string | no | The logon password. When testing an existing data source, you can leave this parameter empty to reuse the saved password. If a new value… |
| UseSsl | integer | no | Specifies whether to enable SSL. Valid values: 1: Enable. 0: Disable. -1: Use the default setting. SSL is supported only for ADB_MYSQL,… |
| RoleArn | string | no | The complete ARN of the RAM role. This parameter is required when you use an Alibaba Cloud RAM role to access the data source. Leave this… |
| KmsSecret | string | no | The name of the KMS secret. This parameter is required when you use KMS to manage database credentials. Leave this parameter empty in… |
| EnvType | string | no | The environment type. This parameter is optional when testing a connection. Valid values: product, pre, dev, test, sit, uat, pet, and stag |
| SyncAlias | integer | no | Specifies whether to synchronize the alias. This parameter is optional when testing a connection. This parameter does not modify the data… |
| DataSourceUuid | string | no | The UUID of the data source. This parameter is required when testing an existing data source. If no new password is passed, the saved… |
| VpcId | string | no | The ID of the VPC. This parameter is required when you access MaxCompute over a VPC. Leave this parameter empty in other scenarios |
| ZoneId | string | no | The zone ID. This parameter is required when you access MaxCompute over a VPC. Leave this parameter empty in other scenarios |
| VSwitchId | string | no | The ID of the vSwitch. This parameter is required when you access MaxCompute over a VPC. Leave this parameter empty in other scenarios |

### Updates the connection, authentication, or display information of an existing data source
`POST https://apizie.tech/v1/cloud:aliyun-dms/update-agentic-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| DataSourceUuid | string | yes | The UUID of the data source to be updated |
| InstanceResourceId | string | no | The new ID of the cloud resource instance. If you do not specify this parameter, the instance resource ID is not updated |
| Alias | string | no | The new display name of the data source. If you do not specify this parameter, the alias is not updated |
| CatalogName | string | no | The new name of the metadata catalog. If you do not specify this parameter, the catalog name is not updated. The name can be up to 128… |
| DbType | string | no | Modifying the data source type is not supported. Do not specify this parameter |
| Host | string | no | Optional. The new domain name or IP address of the database. Do not include the protocol, path, or port. If you do not specify this… |
| Port | integer | no | Optional. The new service port of the database. If you do not specify this parameter, the service port is not updated |
| Schema | string | no | Optional. For ADB_POSTGRESQL, DRDS, POSTGRESQL, and POLARDB_POSTGRESQL, specify the database name. For ORACLE, specify the SID or service… |
| SnowflakeWarehouse | string | no | The name of the Snowflake compute warehouse. This parameter takes effect only when DbType is set to SNOWFLAKE |
| SnowflakeRole | string | no | The name of the Snowflake role. This parameter takes effect only when DbType is set to SNOWFLAKE |
| AuthType | integer | no | Optional. Valid values: -1: No authentication required. 0: Username and password. 1: Password only. 2: Password-free. If you do not… |
| AuthAccount | string | no | The new logon username. If you do not specify this parameter, the authentication account is not updated |
| AuthPassword | string | no | The new logon password. If you do not specify this parameter, the authentication password is not updated. This is sensitive information.… |
| UseSsl | integer | no | The new SSL setting. Valid values: 1: Enable. 0: Disable. -1: Use default settings. If you do not specify this parameter, the SSL setting… |
| RoleArn | string | no | The new ARN of the Alibaba Cloud RAM role. If you do not specify this parameter, the role ARN is not updated |
| KmsSecret | string | no | The new name of the KMS-managed credential. If you do not specify this parameter, the KMS secret is not updated |
| EnvType | string | no | The environment type. Valid values: product, pre, dev, test, sit, uat, pet, and stag. If you do not specify this parameter, the… |
| SyncAlias | integer | no | Specifies whether to use the cloud instance name as the data source name. Valid values: 1: Yes. 0: No. If you do not specify this… |
| CreateMode | string | no | The registration method. Valid values: INSTANCE_ID: Select an existing cloud instance. HOST_PORT: Register by endpoint and port. If you do… |
| PolicyId | string | no | Optional. The new ID of the data access security policy. If you do not specify this parameter, the policy ID is not updated |

### Updates the information of an Airflow instance
`POST https://apizie.tech/v1/cloud:aliyun-dms/update-airflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dms.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |
| AirflowId | string | yes | The unique key ID of the Airflow instance |
| AirflowName | string | no | The name of the Airflow instance |
| StartupFile | string | no | The script loaded at startup of the Airflow instance |
| WorkerServerlessReplicas | integer | no | The number of worker nodes |
| Description | string | no | The description of the Airflow instance |
| PluginsDir | string | no | The plugin directory scanned by Airflow |
| AppSpec | string | no | The specification description of the Airflow instance |
| RequirementFile | string | no | The installation file for package dependencies |
| DagsDir | string | no | The DAG directory scanned by Airflow |
| DataMountInfoList | string | no | The list of data mount information (JSON-encoded) |
| GracefulShutdownTimeout | integer | no | The timeout period for a worker to exit |
| EnableServerless | string | no | Specifies whether to enable serverless workers |
| WorkspaceId | string | yes | The ID of the Data Management (DMS) workspace |

…and 14 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-dms/add-agentic-data-source" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud DataManage - Data+AI API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-dms/add-agentic-data-source with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud DataManage - Data+AI API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud DataManage - Data+AI itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud DataManage - Data+AI API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-dms.

### What is the status of the Alibaba Cloud DataManage - Data+AI API?
Needs your own provider key (bring your own key)