# Alibaba Cloud Data Management API > Alibaba Cloud Data Management API on Apizie: 339 endpoints (Adds instance, database, and table resources to a specified permission template, Adds a data masking rule, Registers a database instance in Data Management Service (DMS) and enables security hosting for the instance, Invokes the AddLhMembers operation to add storage management administrators, workspace members, or node flow…, …) 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://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-dms-enterprise` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/dms-enterprise - Page: https://zieapi.vercel.app/api/cloud/aliyun-dms-enterprise - OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-dms-enterprise/openapi.json Alibaba Cloud OpenAPI for Data Management (dms-enterprise, version 2018-11-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Adds instance, database, and table resources to a specified permission template `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/add-authority-template-items` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | TemplateId | integer | yes | The ID of the permission template. You can call the https://help.aliyun.com/document_detail/600705.html operation to obtain the value of… | | Items | string | yes | The list of resources to be added to the permission template (JSON-encoded) | | Tid | integer | no | The tenant ID. Move the pointer over the profile picture in the upper-right corner of the console to view the tenant ID. For more… | ### Adds a data masking rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/add-desensitization-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | RuleName | string | yes | The name of the rule | | RuleType | string | yes | The data masking algorithm | | RuleDescription | string | no | The description of the rule | | FunctionType | string | yes | The type of the data masking algorithm | | FunctionParams | string | no | The algorithm parameters (JSON-encoded) | | Tid | integer | no | The tenant ID. Move the pointer over the profile picture in the upper-right corner of the console to view the tenant ID. For more… | ### Registers a database instance in Data Management Service (DMS) and enables security hosting for the instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/add-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. You can find the tenant ID by hovering over the profile icon in the upper-right corner of the DMS console | | InstanceType | string | yes | The database type. For valid values, see https://help.aliyun.com/document_detail/198106.html | | InstanceSource | string | yes | The source of the instance. Valid values: PUBLIC_OWN: a self-managed instance connected over the Internet. RDS: an ApsaraDB RDS instance.… | | NetworkType | string | yes | The network type. Valid values: CLASSIC: classic network. VPC: VPC network | | EnvType | string | yes | The environment type. Valid values: product: production environment. dev: development environment. pre: pre-release environment. test:… | | EcsInstanceId | string | no | The instance ID. For example, if your instance is a Database Gateway instance, enter the gateway ID. This parameter is required if… | | VpcId | string | no | The instance ID of the VPC. This parameter is required if InstanceSource is set to VPC_IDC | | EcsRegion | string | no | The region in which the instance resides. This parameter is required if InstanceSource is set to RDS, ECS_OWN, GATEWAY, or VPC_IDC | | Host | string | yes | The database connection address | | Port | integer | yes | The database connection port | | Sid | string | no | The SID of the instance. This parameter is required if InstanceType is set to ORACLE | | DatabaseUser | string | no | The database account | | DatabasePassword | string | no | The database password | | InstanceAlias | string | yes | The alias of the instance, which helps you quickly identify the instance | | DbaId | integer | no | The user ID of the DBA for the instance. You can call the https://help.aliyun.com/document_detail/141938.html or… | | QueryTimeout | integer | yes | The query timeout period. Unit: seconds | | ExportTimeout | integer | yes | The export timeout period. Unit: seconds | | EnableSellTrust | string | yes | Specifies whether to enable security hosting for the instance. Valid values: Y: Enable security hosting mode. N: Do not enable security… | | EnableSellStable | string | no | Specifies whether to enable the stable change feature for the instance. Valid values: Y: Enable. N: Do not enable | | EnableSellCommon | string | no | Specifies whether to enable the security collaboration feature for the instance. Valid values: Y: Enable. N: Do not enable | | SafeRule | string | no | If you want to enable the security collaboration feature, you must specify the security rule set (GroupName) for the instance. You can… | | EnableSellSitd | string | no | Specifies whether to enable the sensitive data protection feature for the instance. Valid values: Y: Enable. N: Do not enable | | DataLinkName | string | no | The name of the cross-database query datalink. This parameter is required if UseDsql is set to 1. The DBLink name can contain only… | | DdlOnline | integer | no | Specifies whether DMS structure change is prioritized. Valid values: 0: Do not use. 1: Native Online DDL takes priority. 2: DMS lock-free… | | UseDsql | integer | no | Specifies whether to enable cross-instance query. Valid values: 0: Disable. 1: Enable. Supported database types: MySQL, SQL Server,… | | SkipTest | string | no | Specifies whether to skip the connectivity test for the instance. Valid values: true: Skip. false: Do not skip | | TemplateId | integer | no | The ID of the data classification template. You can call the https://help.aliyun.com/document_detail/465947.html operation to obtain this… | | TemplateType | string | no | The categorization templatetype. You can call the https://help.aliyun.com/document_detail/465947.html operation to obtain this value | | UseSsl | integer | no | Specifies whether to enable SSL connection. After SSL is enabled, DMS connects to the database over SSL. The database must have SSL… | | RoleArn | string | no | The ARN of the authorized role in the target account, used for cross-tenant registration | | LoginType | integer | no | 0: username and password logon. 1: password-only (Redis). 2: password-free logon (Redis) | ### Invokes the AddLhMembers operation to add storage management administrators, workspace members, or node flow… `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/add-lh-members` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | ObjectType | integer | yes | The object type. Valid values: 0: project workspace 1: task flow | | ObjectId | integer | yes | The object ID: Project workspace ID (Id). You can call the https://help.aliyun.com/document_detail/424379.html operation to obtain this… | | Members | string | yes | The list of target user information (JSON-encoded) | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | ### Adds a routing algorithm configuration to a logical table `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/add-logic-table-route-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | TableId | integer | yes | The ID of the table in the logical database. You can call the https://help.aliyun.com/document_detail/141875.html operation to obtain the… | | RouteKey | string | yes | The unique key of the routing algorithm. You can define a custom route algorithm unique key without any format constraints. The unique… | | RouteExpr | string | yes | The expression of the routing algorithm. You can refer to the DMS documentation to configure the routing algorithm expression. For more… | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html operation to obtain the value of this parameter | ### Adds a table to an asset category `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/add-table-to-category` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | | CategoryId | integer | yes | The ID of the associated category | | DbId | integer | yes | The physical database ID. You can call the https://help.aliyun.com/document_detail/141873.html or… | | TableName | string | yes | The table name. You can call the https://help.aliyun.com/document_detail/141878.html operation to obtain the value of this parameter | | TableSchemaName | string | no | The table schema name. This parameter is required only for SQL Server and must be specified as the schema name | ### Creates directed edges for existing nodes in a task flow `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/add-task-flow-edges` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. You can move the pointer over the profile picture in the upper-right corner of the console and view the tenant ID. For more… | | DagId | integer | yes | The task flow ID. You can call the https://help.aliyun.com/document_detail/424565.html or… | | Edges | string | yes | The list of task flow edges (JSON-encoded) | ### Adds a user to a workspace `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/add-workspace-user` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | WorkspaceId | string | yes | The name of the workspace | | DmsUserIds | string | yes | The DMS user IDs | | RoleSource | string | yes | The source of the role. You can obtain this value from the SearchWorkspaceRoles operation | | RoleId | string | yes | The ID of the role. You can obtain this value from the SearchWorkspaceRoles operation | ### Analyzes the lineage relationships, including dependencies and impacts, between tables and fields in SQL… `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/analyze-sqllineage` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | DbId | integer | yes | The database ID. This parameter corresponds to the DatabaseId parameter in API operations such as… | | SqlContent | string | yes | The SQL statement | | Tid | integer | no | The tenant ID. You can view the tenant ID by moving the pointer over the profile picture in the upper-right corner of the DMS console. For… | ### Answers syntax questions for the corresponding database engine based on a specified database ID `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/answer-sql-syntax-by-meta-agent` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | DbId | string | yes | The ID of the database. You can call the https://help.aliyun.com/document_detail/141873.html operation to obtain the database ID | | Query | string | no | The syntax question | | Model | string | no | The name of the model to use. Only Qwen series models are supported | ### Approves a ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/approve-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html operation to obtain the value of this parameter | | WorkflowInstanceId | integer | yes | The workflow instance ID. You can call the https://help.aliyun.com/document_detail/144642.html operation to obtain the value of this… | | ApprovalType | string | yes | The approval action. Valid values: AGREE: agree CANCEL: cancel REJECT: reject TRANSFER: transfer ADD_APPROVAL_NODE: add an approval node | | Comment | string | no | The comment | | NewApprover | integer | no | The ID of the user to whom the ticket is transferred. This parameter is required when the ApprovalType parameter is set to TRANSFER | | OldApprover | integer | no | The ID of the user who transfers the ticket. Default value: the ID of the current user. If the current user is an administrator or a… | | ApprovalNodeId | integer | no | The ID of the approval node to be added. The node must be a custom approval node. This parameter is required when the ApprovalType… | | ApprovalNodePos | string | no | The position where the approval node is added. This parameter is required when the ApprovalType parameter is set to ADD_APPROVAL_NODE.… | | NewApproverList | string | no | Specify this parameter or the NewApprover parameter when the ApprovalType parameter is set to TRANSFER. The list of IDs of the users to… | | RealLoginUserUid | string | no | The Alibaba Cloud account UID of the user who actually calls the API operation. For more information, see… | ### Queries asset information through the MetaAgent SSE interface `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/asset-answer-sse` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | DbId | string | no | The database ID. This parameter is optional. If specified, the query is performed within the specified database. If not specified, the… | | Query | string | yes | The natural language question from the user | | Model | string | no | The name of the model to use. Only Qwen series models are supported | | QueryId | string | no | The request ID for the current query round. This value is used in the requestId field of SSE events | | SessionId | string | no | The session ID. This parameter is used for context association in multi-round conversations | ### Submits an asynchronous full export node for inventory table assets `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/async-export-inventory-asset` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | JobId | integer | yes | The ID of the inventory task | | Query | string | no | The search keyword used for fuzzy matching of asset information such as table names | | SortBy | string | no | The field by which to sort the results. Valid values: confidence and entityId. Default value: confidence | | SortOrder | string | no | The sort order. Valid values: asc for ascending order and desc for descending order. Default value: desc | ### Asynchronously submits a full export task for inventory knowledge `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/async-export-inventory-knowledge` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | JobId | integer | yes | The ID of the inventory task | | Query | string | no | The search keyword used for fuzzy matching of knowledge content | | ShowType | string | no | The filter for knowledge display types, such as TABLE, COLUMN, SQL, SEG, LINEAGE, and TERM | | SortBy | string | no | The field used for sorting. Valid values: confidence and entityId. Default value: confidence | | SortOrder | string | no | The sort order. Valid values: asc for ascending order and desc for descending order. Default value: desc | ### Calls the BackFill operation to backfill data for a task flow `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/back-fill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. You can find the tenant ID by hovering over the profile picture in the upper-right corner of the console. For more… | | DagId | integer | yes | The ID of the task flow. You can obtain this parameter by calling the https://help.aliyun.com/document_detail/424565.html or… | | StartNodeIds | string | no | The list of start node IDs for data backfill. If this parameter is not specified, the entire task flow is run (JSON-encoded) | | FilterNodeIds | string | no | The filter condition. Specifies the list of node IDs in the task flow that do not require data backfill (JSON-encoded) | | IsTriggerSubTree | string | no | Specifies whether to run downstream nodes. Default value: true | | BackFillDate | string | no | The business time for data backfill. This parameter is required when you backfill data for a specified date | | BackFillDateBegin | string | no | The start business time for data backfill. This parameter is required when you backfill data for a specified date range | | BackFillDateEnd | string | no | The end business time for data backfill. This parameter is required when you backfill data for a specified date range | | Interval | integer | no | The data timestamp interval for data backfill. Unit: hours. Minimum value: 1. Default value: 24 | | Asc | string | no | The execution order of the data backfill task flow. Valid values: 0: descending order. Runs from the latest date to the earliest date. 1:… | | HistoryDagId | integer | no | The ID of the historical task flow. If you do not specify this parameter, the system automatically retrieves the ID of the most recently… | ### Creates multiple partitions for a data lakehouse table `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/batch-create-data-lake-partitions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The name of the data catalog | | DbName | string | yes | The name of the database | | TableName | string | yes | The name of the table | | PartitionInputs | string | yes | The information about the partitions to be created (JSON-encoded) | | IfNotExists | string | no | Specifies whether to ignore the exception if the name of a new partition duplicates an existing partition name. Valid values: true: Ignore… | | NeedResult | string | no | Specifies whether to return partition information. If this parameter is set to true, the Partitions field is returned | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The tenant ID. Move the pointer over the profile picture in the upper-right corner of the console to view the tenant ID. For more… | | WorkspaceId | integer | no | The workspace ID | ### Deletes multiple partitions of a data lakehouse table `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/batch-delete-data-lake-partitions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The name of the data catalog | | DbName | string | yes | The name of the database | | TableName | string | yes | The name of the table | | PartitionValuesList | string | yes | The list of partition values (JSON-encoded) | | IfExists | string | no | Specifies whether to ignore the exception if the partition to be deleted does not exist | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The tenant ID. You can obtain the tenant ID by moving the pointer over the profile picture in the upper-right corner of the console. For… | | WorkspaceId | integer | no | The workspace ID | ### Updates multiple partitions of a table in a data lakehouse at a time `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/batch-update-data-lake-partitions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The name of the data directory | | DbName | string | yes | The name of the database that you want to query | | TableName | string | yes | The name of the table | | PartitionInputs | string | yes | The information about the created partition (JSON-encoded) | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | | WorkspaceId | integer | no | The workspace ID | ### Purchases a pay-as-you-go Data Management (DMS) product `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/buy-pay-as-you-go-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. You can obtain the tenant ID by moving the pointer over the profile picture in the upper-right corner of the console. For… | | CommodityType | string | yes | The commodity type. Valid values: versionType: control mode SensitiveDataProtection: sensitive data protection | | InsNum | integer | yes | The usage quota for the control mode or sensitive data protection. One quota can be used for only one database instance | | VersionType | string | no | The type of the control mode. This parameter is required when the commodity type is set to control mode. Valid values: stand: stable… | ### Modifies the sensitivity level of a column `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/change-column-sec-level` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. Move the pointer over the profile picture in the upper-right corner of the console to view the tenant ID. For more… | | DbId | integer | yes | The database ID. You can call the https://help.aliyun.com/document_detail/141876.html operation to obtain the value of this parameter. You… | | IsLogic | string | yes | Specifies whether the database is a logical database. Valid values: true: physical database false: logical database | | SchemaName | string | yes | The database name. You can call the https://help.aliyun.com/document_detail/188103.html operation to obtain the value of this parameter.… | | TableName | string | yes | The table name. You can call the https://help.aliyun.com/document_detail/188103.html operation to obtain the value of this parameter. You… | | ColumnName | string | yes | The column name. You can call the https://help.aliyun.com/document_detail/188103.html operation to obtain the value of this parameter. You… | | NewLevel | string | yes | The new sensitivity level of the column. Valid values: INNER: low sensitivity SENSITIVE: medium sensitivity CONFIDENTIAL: high sensitivity | ### Changes the security level of a column `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/change-column-security-level` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the… | | DbId | integer | yes | The database ID. The database can be a physical database or a logical database. The ID of a physical database: You can call the… | | IsLogic | string | yes | Specifies whether the database is a logical database. Valid values: true: The database is a logical database false: The database is a… | | SchemaName | string | yes | The database name. You can call the https://help.aliyun.com/document_detail/188103.html or… | | TableName | string | yes | The name of the table. You can call the https://help.aliyun.com/document_detail/188103.html or… | | ColumnName | string | yes | The name of the field. You can call the https://help.aliyun.com/document_detail/188103.html or… | | NewSensitivityLevel | string | yes | The new security level of the column. The valid values are the same as the sensitivity levels of the classification template that is… | ### Transfers the owner of a task flow in a DMS data warehouse development workspace `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/change-lh-dag-owner` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | DagId | integer | yes | The task flow ID. You can call the https://help.aliyun.com/document_detail/426672.html operation to obtain this parameter | | OwnerUserId | integer | yes | The user ID of the new task flow owner. You can call the https://help.aliyun.com/document_detail/141938.html or… | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | ### Batch verify table permissions `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/check-batch-table-access-permission` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | TableNameList | string | yes | The name of the table (JSON-encoded) | | DbId | integer | yes | The database ID. You can call the https://help.aliyun.com/document_detail/141873.html operation to query the ID of a physical database and… | | Logic | string | no | Specifies whether the database is a logical database. Valid values: true: Logical database. false: Physical database | | PermissionType | string | yes | The type of the permission to be verified. Valid values: QUERY EXPORT CORRECT LOGIN PERF | | Tid | integer | no | The ID of the tenant. View Tenant ID by hovering over your profile icon in the DMS console. For more information, see the… | ### Queries the execution status and progress information of an asset information collection task `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/check-inventory-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | JobId | integer | yes | The ID of the inventory task | ### Unmounts all tables from a specified category folder `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/clear-category-mounted-tables` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CategoryId | integer | yes | The ID of the category folder to clean up. The folder level is not limited. Only the mount relationships of all tables under the folder… | | DryRun | string | no | Specifies whether to perform a dry run. If set to true, only the number of mount relationships and tables that would be cleaned up is… | ### Clones a security rule set `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/clone-standard-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | GroupName | string | yes | The name of the destination security rule set | | Description | string | yes | The description of the destination security rule set | | SourceGroupId | string | yes | The ID of the source security rule set | ### Closes a ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/close-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management… | | OrderId | integer | yes | The ID of the ticket | | CloseReason | string | yes | The reason why the ticket is closed | ### Confirms a single knowledge item in an inventory task and marks it as certified `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/confirm-inventory-knowledge` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | JobId | integer | yes | The ID of the inventory task | | EntityId | integer | yes | The ID of the knowledge entity | | KnowledgeType | string | yes | The type of knowledge. Valid values: TABLE, COLUMN, DB, DMS_SQL, DMS_SEG, INCLUDE_SQL, ASSET_DOMAIN_TREE, META_LINEAGE, META_TERM,… | ### Attaches a system policy or custom policy to a DMS user or custom role `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-abac-authorization` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | IdentityType | string | yes | Principal Type. Valid values:userorcustom role. Valid values: USER ROLE | | UserId | integer | no | The ID of the user. You can call the https://help.aliyun.com/document_detail/465816.html operation to query the user ID. If IdentityType… | | PolicyId | integer | yes | The ID of the policy | | RoleId | integer | no | The ID of the role. If IdentityType is set to ROLE, this parameter is required | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | ### Creates a policy to manage the permissions on DMS features and data resources managed in DMS in a… `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-abac-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | AbacPolicyName | string | yes | The name of the policy. The name must be unique for the tenant | | AbacPolicyDesc | string | no | The description of the policy | | AbacPolicyContent | string | yes | The content of the policy. Specifies whether the authorized user can access and use the resources and features defined in the policy | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right… | ### Creates a permission template `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-authority-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Name | string | yes | The name of the permission template | | Description | string | no | The description of the permission template | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | ### Creates a data archiving ticket to archive data to destinations such as dedicated storage space or ApsaraDB… `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-data-archive-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Comment | string | yes | The description of the task | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | | PluginType | string | no | The type of the plug-in. Default value: DATA_ARCHIVE | | RelatedUserList | string | no | The list of the related users (JSON-encoded) | | ParentId | integer | no | The ID of the parent ticket. A parent ticket is generated only when a child ticket is created | | Param | string | yes | The parameters for archiving data (JSON-encoded) | ### Creates a ticket for changing data in Data Management (DMS) `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-data-correct-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Comment | string | yes | The purpose or objective of the data change. This parameter is used to help reduce unnecessary communication | | RelatedUserList | string | no | The stakeholders of the data change. All stakeholders can view the ticket details and assist in the approval process. Irrelevant users… | | Param | string | yes | The parameters of the ticket (JSON-encoded) | | AttachmentKey | string | no | The key of the attachment that provides more instructions for the ticket. You can call the… | | RealLoginUserUid | string | no | The ID of the Alibaba Cloud account that is used to call the API operation | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | ### Create a Historical Data Cleanup ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-data-cron-clear-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Comment | string | yes | The purpose or objective of the data change. This reduces unnecessary communication | | RelatedUserList | string | no | The stakeholders of this operation. All stakeholders can view the ticket details and assist in the approval process. Irrelevant users… | | Param | string | yes | The parameters of the ticket (JSON-encoded) | | AttachmentKey | string | no | The key of the attachment for the ticket. The attachment provides more instructions for this operation. You can call the… | | Tid | integer | no | The ID of the tenant. The ID of the tenant is displayed when you move the pointer over the profile picture in the upper-right corner of… | ### Creates a ticket to export an SQL result set `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-data-export-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | ParentId | integer | no | The ID of the parent ticket | | Comment | string | yes | The purpose or objective of the ticket. This parameter helps reduce unnecessary communication | | AttachmentKey | string | no | The key of the attachment that provides more instructions for the ticket. You can call the… | | RelatedUserList | string | no | The stakeholders involved in this operation (JSON-encoded) | | PluginParam | string | yes | The parameters of the ticket (JSON-encoded) | | Tid | integer | no | The tenant ID. To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For… | | RealLoginUserUid | string | no | The UID of the Alibaba Cloud account that actually calls the API | ### Creates a data import ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-data-import-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Comment | string | yes | The business background of the data import, which helps reduce communication costs | | RelatedUserList | string | no | The list of relevant users (JSON-encoded) | | Param | string | yes | The ticket parameters (JSON-encoded) | | AttachmentKey | string | no | The attachment key of the ticket, which is used to supplement the ticket information. You can call the… | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | | RealLoginUserUid | string | no | The UID of the Alibaba Cloud account that actually calls the API operation | ### Creates a database in a data lakehouse `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-data-lake-database` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The name of the data catalog | | DbName | string | yes | The name of the database that you want to query | | Description | string | no | The description of the database | | Location | string | yes | The storage path of the database. OSS, S3, and S3A are supported | | Parameters | string | no | The key-value pairs of the database attributes (JSON-encoded) | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | | WorkspaceId | integer | no | The workspace ID | ### Call this API to create a new data lake user-defined function `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-data-lake-function` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The data catalog name | | DbName | string | yes | The database name | | FunctionInput | string | yes | The function details (JSON-encoded) | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The tenant ID. Obtain the tenant ID from the tooltip displayed when you hover over your profile picture in the upper-right corner of the… | | WorkspaceId | integer | no | The workspace ID | ### Creates a partition for a table in a data lakehouse `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-data-lake-partition` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The name of the data catalog | | DbName | string | yes | The database name | | TableName | string | yes | The name of the table | | PartitionInput | string | yes | The information about the created partition (JSON-encoded) | | IfNotExists | string | no | Specifies whether to ignore the exception if the name of the created partition is the same as the name of an existing partition | | NeedResult | string | no | Specifies whether to return information about the created partition. If the value is true, the Partition parameter is returned. Valid… | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The ID of the tenant. To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the… | | WorkspaceId | integer | no | The workspace ID | ### Creates a table in a data lakehouse `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-data-lake-table` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The name of the data catalog | | DbName | string | yes | The database name | | TableInput | string | yes | The information about the table (JSON-encoded) | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The ID of the tenant. You can move the pointer over the profile picture in the upper-right corner of the DMS console to obtain the tenant ID | | WorkspaceId | integer | no | The workspace ID | ### Creates a data tracking ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-data-track-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Comment | string | yes | The purpose or objective of the data tracking ticket. This parameter is used to help reduce unnecessary communication | | RelatedUserList | string | no | The IDs of the operators that are related to the ticket (JSON-encoded) | | Param | string | yes | The parameters of the ticket (JSON-encoded) | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html operation to query the tenant ID | ### Creates a database export ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-database-export-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | ParentId | integer | no | The ID of the parent ticket | | Comment | string | yes | The purpose or objective of the ticket. This parameter helps reduce unnecessary communication | | AttachmentKey | string | no | The key of the attachment that provides more instructions for the ticket. You can call the… | | PluginParam | string | yes | The parameters of the ticket (JSON-encoded) | | RelatedUserList | string | no | The stakeholders involved in this operation (JSON-encoded) | | Tid | integer | no | The tenant ID. To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For… | ### Creates a forecast agent instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-forecast-agent` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | DataRegion | string | no | The region where the data lake resides | | DryRun | string | no | Specifies whether to enable the DryRun mode. Valid values: true: enables the DryRun mode. false (default): disables the DryRun mode. The… | ### Create a lockless change ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-free-lock-correct-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Comment | string | yes | The purpose or objective of the data change. This parameter is used to help reduce unnecessary communication | | RelatedUserList | string | no | The stakeholders of the data change. All stakeholders can view the ticket details and assist in the approval process. Irrelevant users… | | Param | string | yes | The parameters of the ticket (JSON-encoded) | | AttachmentKey | string | no | The key of the attachment that provides more instructions for the ticket. You can call the… | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | | RealLoginUserUid | string | no | The UID of the Alibaba Cloud account of the user who actually invokes the API. For more information, see… | ### Creates an asset inventory task to perform knowledge inventory on specified instances, databases, or tables `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-inventory-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Param | string | no | The JSON string of inventory parameters. / Parameter / Type / Required / Description / /--------/------/------/------/ / `instanceIds` /… | ### Creates a workspace for data warehouse development in Data Management (DMS) `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-lake-house-space` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | SpaceName | string | yes | The name of the workspace | | Description | string | no | The description of the workspace | | Mode | string | yes | The mode in which the workspace runs. Valid values: 0: basic mode. This mode is unavailable. 1: standard mode | | DwDbType | string | yes | The type of the database. Valid values: 14: AnalyticDB for MySQL 18: AnalyticDB for PostgreSQL | | SpaceConfig | string | yes | The configuration of the workspace. Valid values: skipManualRunCheck: No security rule check is required in the trial run phase.… | | DevDbId | string | yes | The ID of the development database. You can call the https://help.aliyun.com/document_detail/141873.html or… | | ProdDbId | string | no | The ID of the production database. You can call the https://help.aliyun.com/document_detail/141873.html or… | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | ### Create a DMS logical database `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-logic-database` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Alias | string | yes | The alias of the logical database | | DatabaseIds | string | yes | The IDs of the physical databases that compose the logical database. You can specify one or more database IDs. You can call the… | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS… | ### Create an asset category `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-meta-category` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | | Name | string | yes | The name of the category | | ParentCategoryId | integer | no | The ID of the parent category. The new category is created under this parent category. If this value is left empty, the new category is of… | | Description | string | no | Description | | Remark | string | no | Remarks | | OwnerIds | string | no | User IDs of the owners. Separate multiple user IDs with commas. You can obtain the value of UserId by invoking the… | ### Creates a ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | | Comment | string | yes | The description of the ticket | | PluginParam | string | yes | The parameters for creating the ticket, in JSON format. The parameter settings vary by ticket type. For more information, see… | | RelatedUserList | string | no | The list of user IDs of the stakeholders for the ticket. Separate multiple user IDs with commas (,) | | PluginType | string | yes | The ticket type. For valid values, see https://help.aliyun.com/document_detail/429109.html | | AttachmentKey | string | no | The key of the attachment returned after the attachment is uploaded. You can call the https://help.aliyun.com/document_detail/206069.html… | | RealLoginUserUid | string | no | The UID of the Alibaba Cloud account of the user who actually calls the API operation | | ParentId | integer | no | The ID of the associated parent ticket | ### Creates a programmable object ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-proc-correct-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Comment | string | yes | The remarks of the ticket | | RelatedUserList | string | no | The operators that are related to the ticket (JSON-encoded) | | Param | string | yes | The parameters of the ticket (JSON-encoded) | | AttachmentKey | string | no | The key of the attachment for the ticket. The attachment provides more instructions for this operation. You can call the… | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | ### Invokes the CreateProxy operation to enable the data security access feature for an instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-proxy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | InstanceId | integer | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/141936.html or… | | Username | string | yes | The database account | | Password | string | yes | The database password | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html operation to obtain the value of this parameter | ### Grants a user the permissions to access a database instance by using the secure access proxy feature `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-proxy-access` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | UserId | integer | yes | The ID of the user. You can call the ListUsers (https://www.alibabacloud.com/help/en/data-management-service/latest/listusers) or GetUser… | | ProxyId | integer | yes | The ID of the security protection agent. You can call the ListProxies… | | IndepAccount | string | no | The database account | | IndepPassword | string | no | The password that is used to log on to the database | | Tid | integer | no | The ID of the tenant. You can call the GetUserActiveTenant… | ### Executes a schema design ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-publish-group-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile… | | OrderId | integer | yes | The ID of the ticket. : You can create a schema design ticket in the DMS console. For more information, see… | | DbId | integer | yes | The ID of the database for which the schema design is executed | | Logic | string | yes | Indicates whether the database is a logical database | | PublishStrategy | string | yes | The policy to execute the schema design ticket. Valid values: IMMEDIATELY: immediately executes the schema design ticket. REGULARLY:… | | PlanTime | string | no | The time to execute the schema design ticket | ### Creates a SQL review ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-sqlreview-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Comment | string | yes | The purpose or objective of the SQL review. This reduces unnecessary communication | | RelatedUserList | string | no | The stakeholders involved in this operation. All the specified stakeholders can view the ticket details and take part in the approval… | | Param | string | yes | The parameters of the ticket (JSON-encoded) | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | ### Creates a business scenario to group task flows by business scenario `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-scenario` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data… | | ScenarioName | string | yes | The name of the business scenario | | Description | string | no | The description of the business scenario | ### Creates a security rule set `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-standard-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | GroupName | string | yes | The name of the security rule set | | Description | string | yes | The description of the security rule set | | DbType | string | yes | The database engine type of the instance. For valid values, see https://help.aliyun.com/document_detail/198106.html | | Tid | integer | no | The tenant ID | ### Creates a schema synchronization ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-struct-sync-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Comment | string | yes | The remarks of the ticket | | RelatedUserList | string | no | The IDs of the stakeholders (JSON-encoded) | | Param | string | yes | The parameters of the ticket (JSON-encoded) | | AttachmentKey | string | no | The key of an attachment that is returned after the attachment is uploaded. You can call the… | | Tid | integer | no | The ID of the tenant. To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the DMS console. For… | ### Creates a task node for a task flow `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS)… | | DagId | integer | yes | The ID of the task flow. You can call the https://help.aliyun.com/document_detail/424565.html or… | | NodeName | string | yes | The name of the node that you want to create | | NodeType | string | yes | The type of the node that you want to create. For more information about the valid values for this parameter, see… | | NodeContent | string | no | The configuration of the node | | TimeVariables | string | no | The time variables configured for the node | | NodeOutput | string | no | The output variables configured for the task | | GraphParam | string | no | The position of the node on the Directed Acyclic Graph (DAG) | ### Creates a task flow `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-task-flow` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | | DagName | string | yes | The name of the task flow | | Description | string | no | The description of the task flow | | ScenarioId | integer | no | The ID of the scenario | ### Creates a file upload task `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-upload-file-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | FileSource | string | yes | The purpose of the uploaded attachment. Valid values: datacorrect: Data change ticket. order_info_attachment: Ticket attachment. big-file:… | | FileName | string | yes | The file name. The file name must end with .txt or .sql, such as test.txt or test.sql | | UploadURL | string | yes | The URL of the uploaded attachment. Only HTTP and HTTPS URLs are supported. You can upload an object to a bucket and obtain the shared URL… | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html operation to obtain this parameter | ### Creates an Object Storage Service (OSS) file upload task `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-upload-ossfile-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | FileSource | string | yes | The purpose of uploading the attachment. Valid values: datacorrect: data change ticket order_info_attachment: ticket attachment big-file:… | | FileName | string | yes | The file name. The file name must end with .txt or .sql, such as test.txt | | UploadTarget | string | yes | The OSS information (JSON-encoded) | | Tid | integer | no | The tenant ID. You can obtain the tenant ID by moving the pointer over the profile picture in the upper-right corner of the console. For… | ### Creates a list of approval nodes `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-work-flow-node` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | NodeName | string | yes | The name of the approval node | | Comment | string | yes | The description of the approval node | | UserIdList | string | yes | The list of DMS user IDs. Separate multiple user IDs with commas (,). You can call the ListUsers operation to obtain user IDs | ### Creates an approval template `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-work-flow-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | TemplateName | string | yes | The name of the approval template | | Comment | string | yes | The description of the approval template | | NodeIdList | string | yes | The IDs of approval nodes. Separate multiple node IDs with commas (,). You can call ListWorkflowNode to obtain node IDs | ### Creates a workspace `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/create-workspace` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | WorkspaceName | string | yes | The name of the workspace | | Description | string | yes | The description of the workspace | | VpcId | string | yes | The ID of the VPC | | WorkspaceRegion | string | yes | region, cn-hangzhou | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions | ### Detaches a policy from a user or role `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-abac-authorization` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | AuthorizationId | integer | yes | The authorization ID | | IdentityType | string | yes | The type of object to which you want to attach the policy.******** Valid values: USER ROLE | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | ### Deletes a created permission policy `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-abac-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | AbacPolicyId | integer | yes | The ID of the policy | | Tid | integer | no | The ID of the tenant. To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the… | ### Deletes a permission template `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-authority-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | TemplateId | integer | yes | The ID of the permission template | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | ### Deletes a database from a data lakehouse `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-data-lake-database` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The name of the data directory | | DbName | string | yes | The name of the database that you want to query | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | | WorkspaceId | integer | no | The workspace ID | ### Deletes a user-defined function in a data lakehouse `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-data-lake-function` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The name of the data directory | | DbName | string | yes | The database name | | FunctionName | string | yes | The function name | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The ID of the tenant. To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the… | | WorkspaceId | integer | no | The workspace ID | ### Deletes a partition from a table in a data lakehouse `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-data-lake-partition` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The name of the data catalog | | DbName | string | yes | The name of the database that you want to query | | TableName | string | yes | The table name | | PartitionValues | string | yes | The values in a partition key column (JSON-encoded) | | IfExists | string | no | Specifies whether to ignore the exception if the partition that you want to delete does not exist | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right… | | WorkspaceId | integer | no | The workspace ID | ### Deletes a table from a data lakehouse `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-data-lake-table` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | CatalogName | string | yes | The name of the data catalog | | DbName | string | yes | The database name | | TableName | string | yes | The name of the table | | DataRegion | string | yes | The region where the data lake resides | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right… | | WorkspaceId | integer | no | The workspace ID | ### Removes a database instance from Data Management (DMS) `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html operation to obtain the tenant ID | | Host | string | yes | The endpoint of the database instance. You can call the https://help.aliyun.com/document_detail/141936.html or… | | Port | integer | yes | The port number that is used to connect to the database instance. You can call the https://help.aliyun.com/document_detail/141936.html or… | | Sid | string | no | The system ID (SID) of the database instance. You can call the https://help.aliyun.com/document_detail/141936.html or… | ### Calls the DeleteLakeHouseSpace operation to delete a project space in data warehouse development `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-lake-house-space` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | SpaceId | integer | yes | The project space ID. You can call the https://help.aliyun.com/document_detail/424379.html operation to obtain this parameter | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | ### Deletes members or task flow developers from a DMS data warehouse development project workspace `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-lh-members` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | ObjectType | integer | yes | The object type. Valid values: 0: project workspace 1: task flow | | ObjectId | integer | yes | The object ID: The project workspace ID (Id). You can call the https://help.aliyun.com/document_detail/424379.html operation to obtain… | | MemberIds | string | yes | The list of target user information (JSON-encoded) | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | ### Deletes a logical database from Data Management (DMS). This operation only deletes the specified logical… `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-logic-database` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | LogicDbId | integer | yes | The ID of the logical database. You can call the ListLogicDatabases… | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS… | ### Deletes a routing algorithm from a logical table `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-logic-table-route-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | TableId | integer | yes | The ID of the logical table. You can call the ListLogicTables… | | RouteKey | string | yes | The unique key of the routing algorithm. You can call the ListLogicTableRouteConfig… | | Tid | integer | no | The ID of the tenant. You can call the GetUserActiveTenant… | ### Deletes an asset category `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-meta-category` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right… | | CategoryId | integer | yes | The category ID | ### You can call this operation to disable the data security protection proxy of a DB instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-proxy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | ProxyId | integer | yes | The ID of the security protection agent. You can call the ListProxies… | | Tid | integer | no | The ID of the tenant. You can call the GetUserActiveTenant… | ### Revokes the permissions to access a database instance by using the secure access proxy feature from a user `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-proxy-access` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | ProxyAccessId | integer | yes | The ID of the security protection authorization. After the security protection agent authorizes the target user, the system automatically… | | Tid | integer | no | The ID of the tenant. You can call the GetUserActiveTenant… | ### Deletes a business scenario `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-scenario` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data… | | ScenarioId | integer | yes | The ID of the business scenario | ### Deletes a security rule set `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-standard-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | GroupId | integer | yes | The security rule set ID. You can call the https://help.aliyun.com/document_detail/465940.html operation to obtain the ID of the security… | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | ### Deletes a task in a specified task flow `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | | NodeId | string | yes | The ID of the node you want to delete | ### Deletes a task flow `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-task-flow` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | DagId | integer | yes | The ID of the task flow. You can call the https://help.aliyun.com/document_detail/424565.html or… | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | ### Deletes task flow edges based on multiple conditions `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-task-flow-edges-by-condition` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | | DagId | integer | yes | The ID of the task flow. You can call the https://help.aliyun.com/document_detail/424565.html or… | | Id | integer | no | The ID of the task flow edge to delete | | NodeFrom | integer | no | The ID of the start node on the edge to delete | | NodeEnd | integer | no | The ID of the end node of the edge to delete | ### Deletes a user (Alibaba Cloud account) registered in Data Management (DMS) `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-user` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. You can obtain the tenant ID by moving the pointer over the profile picture in the upper-right corner of the DMS console.… | | Uid | string | yes | The UID of the Alibaba Cloud account | ### Deletes a workspace `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/delete-workspace` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | WorkspaceId | integer | yes | The ID of the DMS workspace | ### Retrieves the details of a forecast agent instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/describe-forecast-agent` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | InstanceUuid | string | no | The unique identifier of the database backup client on the destination server. Call the… | | DataRegion | string | no | The region where the data lake resides | ### Retrieves OSS direct upload credentials for asset inventory files `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/describe-inventory-file-upload-signature` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | JobToken | string | no | The idempotency token for the upload directory. You can pass an inventory task draft ID or a client-generated UUID. If not specified, the… | ### Disables a user that is temporarily not used in Data Management (DMS) `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/disable-user` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | | Uid | string | yes | The UID of the Alibaba Cloud account | ### Downloads the parsing result of a data tracking task `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/download-data-track-result` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | OrderId | integer | yes | The ID of the ticket. You can call the https://help.aliyun.com/document_detail/144643.html operation to obtain the ticket ID | | RollbackSQLType | string | yes | The type of the SQL statement. REVERSE: undoes or rolls back an executed SQL statement, which is equivalent to the UNDO SQL statement.… | | FilterStartTime | string | no | The start time of the time range in which you want to track data operations. The time must be specified in the yyyy-MM-dd HH:mm:ss format | | FilterEndTime | string | no | The end time of the time range in which you want to track data operations. The time must be specified in the yyyy-MM-dd HH:mm:ss format | | FilterTableList | string | no | The names of the tables for which you want to track data operations (JSON-encoded) | | FilterTypeList | string | no | The types of data operations that you want to track (JSON-encoded) | | ColumnFilter | string | no | The condition to filter columns (JSON-encoded) | | EventIdList | string | no | The IDs of the events (JSON-encoded) | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | ### Updates the information of a logical database `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/edit-logic-database` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Alias | string | yes | To update the alias of the logical database, enter a new alias. If you do not need to update the alias, you can call the… | | LogicDbId | integer | yes | The ID of the logical database. You can call the https://help.aliyun.com/document_detail/141874.html operation to obtain the value of this… | | DatabaseIds | string | yes | The physical databases that correspond to the logical database (JSON-encoded) | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | ### Updates the business knowledge of metadata specified by a GUID `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/edit-meta-knowledge-asset` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | TableSchemaName | string | no | The table schema name. Pass this parameter as the schema name only for SQL Server | | ColumnName | string | no | The column name. Specify this parameter when the content to be updated is a column | | AssetDescription | string | yes | The business knowledge content to be updated | | DbId | integer | yes | The ID of the physical database. You can call the https://help.aliyun.com/document_detail/141876.html operation to obtain this value | | TableName | string | yes | The table name | ### Edits the business knowledge (AI-enhanced description and summary) of a table, which affects the accuracy of… `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/edit-table-asset-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | DbId | string | yes | The database ID. You can call the https://help.aliyun.com/document_detail/141873.html operation to query the database ID | | Tid | integer | no | The tenant ID. Move the pointer over the profile picture in the upper-right corner of the console to view the tenant ID. For more… | | TableName | string | yes | The table name | | AssetDescription | string | no | The business description (AI-enhanced description) of the table, which is used for semantic table search. If you leave this parameter… | | Title | string | no | The Chinese name of the table. If you leave this parameter empty, the original value is retained | | Summary | string | no | The business summary of the table, which is used for semantic table search. If you leave this parameter empty, the existing summary is… | ### Enables a user that is disabled `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/enable-user` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. To obtain the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management… | | Uid | string | yes | The UID of the Alibaba Cloud account | ### Execute a data change ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/execute-data-correct` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | string | no | Tenant ID. Call https://help.aliyun.com/document_detail/198073.html to get this value | | OrderId | integer | yes | Ticket ID. Call https://help.aliyun.com/document_detail/144643.html to get this value | | ActionDetail | string | no | Parameters for executing the data change: ``` json "actionDetail" : { "grayType": "FIRST", // Grayscale type. Valid values: "NONE",… | | RealLoginUserUid | string | no | Alibaba Cloud account UID of the user who calls the API | ### Executes a data export ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/execute-data-export` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. To obtain the tenant ID, move the pointer over the profile picture in the upper-right corner of the console. For more… | | OrderId | integer | yes | The ticket ID | | ActionDetail | string | no | The execution parameters: ```json { "mode" : "FAST", // The data export mode. Default value: FAST. NORMAL allows interruptions. "encoding"… | | RealLoginUserUid | string | no | The Alibaba Cloud account UID of the user who actually calls the API. For more information, see… | ### Executes an SQL script `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/execute-script` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | DbId | integer | yes | The database ID. This parameter corresponds to the DatabaseId parameter in API operations such as… | | Script | string | yes | The SQL script to be executed. The script can include DQL, DDL, and DML statements. Whether DDL and DML statements are allowed depends on… | | Logic | string | yes | Specifies whether the database is a logical database | | Tid | integer | no | The tenant ID. You can obtain the tenant ID by moving the pointer over the profile picture in the upper-right corner of the console. For… | | RealLoginUserUid | string | no | The Alibaba Cloud account UID of the user who actually calls the API operation. For more information, see… | ### Executes a schema synchronization task `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/execute-struct-sync` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | OrderId | integer | yes | The ID of the ticket | | Tid | integer | no | The ID of the tenant. To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management… | ### Exports the full list of table assets under an inventory task as an XLSX file `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/export-inventory-asset` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | JobId | integer | yes | The ID of the inventory task | | Query | string | no | The search keyword used for fuzzy matching of asset information such as table names | | SortBy | string | no | The field by which to sort the results. Valid values: confidence entityId Default value: confidence | | SortOrder | string | no | The sort direction. Valid values: asc: ascending order. desc: descending order. Default value: desc | ### Exports the full list of knowledge generated by an inventory task to an XLSX file `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/export-inventory-knowledge` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | JobId | integer | yes | The ID of the inventory task | | Query | string | no | The search keyword used for fuzzy matching of knowledge content | | ShowType | string | no | The filter for knowledge display types, such as TABLE, COLUMN, SQL, SEG, LINEAGE, and TERM | | SortBy | string | no | The field used for sorting. Valid values: confidence, entityId. Default value: confidence | | SortOrder | string | no | The sort order. Valid values: asc: Ascending order. desc: Descending order. Default value: desc | ### Analyzes the cause of an SQL error and fixes the error based on the SQL statement, error message, and… `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/fix-sql-by-meta-agent` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | DbId | string | yes | The database ID. You can call the https://help.aliyun.com/document_detail/141873.html operation to obtain the database ID | | Query | string | no | The remarks | | Sql | string | yes | The SQL statement that contains errors | | Error | string | no | The error message | | Model | string | no | The name of the selected model. Only Qwen series models are supported | ### This API converts a natural language description into an executable SQL statement by retrieving relevant… `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/generate-sql-from-nl` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | DbId | string | yes | The database ID. You can call the https://help.aliyun.com/document_detail/141873.html operation to obtain this ID. The API operation uses… | | Knowledge | string | no | Supplementary business information to help the model better understand the question | | Question | string | yes | The natural language question to convert into an SQL statement | | Dialect | string | no | The SQL dialect. If unspecified, the system defaults to `MySQL` and generates a standard SQL statement | | Level | string | no | The processing level. The default value is `base` | | Model | string | no | The Qwen series model to use | | TableNames | string | no | A comma-separated list of table names. If specified, the model uses only these tables to generate the SQL statement | | RealLoginUserUid | string | no | The Alibaba Cloud account ID of the user who calls the operation | ### Gets approval suggestions for a ticket from a Large Language Model (LLM) `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-aiorder-approval-comment-sse` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | OrderId | integer | no | The ticket ID | | SessionId | string | no | The session ID | ### Queries the details of a policy, including the name, content, and the user who created the policy `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-abac-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | AbacPolicyId | integer | no | The ID of the policy | | AbacPolicyName | string | no | The name of the policy | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | ### Queries the approval details of a ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-approval-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html operation to obtain the tenant ID | | WorkflowInstanceId | integer | yes | The ID of the approval process. You can call the https://help.aliyun.com/document_detail/144642.html operation to obtain the ID of the… | ### Retrieves the details of a permission template `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-authority-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | TemplateId | integer | yes | The ID of the permission template | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | ### Queries the resources in a permission template `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-authority-template-item` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | TemplateId | integer | yes | The ID of the permission template | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | ### Queries the information about the classification and grading template associated with an instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-classification-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | InstanceId | integer | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/141936.html or… | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture… | ### Queries the log that records the scheduling details of an SQL task `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-dbtask-sqljob-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | JobId | integer | yes | The ID of the SQL task. You can call the https://help.aliyun.com/document_detail/207049.html operation to query the ID of the SQL task | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html operation to query the tenant ID | ### Queries the topologies of a logical database and its physical database shards `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-dbtopology` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | LogicDbId | integer | yes | The ID of the logical database. You can call the ListLogicDatabases… | | Tid | integer | no | The ID of the tenant. To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management… | ### Queries the statistics on the number of data archiving tickets, including the number of tickets of… `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-data-archive-count` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | PluginType | string | no | The plugin type. Default value: DATA_ARCHIVE | | OrderResultType | string | no | The type of the identity. Default value: AS_ADMIN | | SearchDateType | string | no | The time when the ticket is modified or created. The statistics of data archiving tickets are calculated based on the creation time | | Tid | integer | no | The tenant ID. To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS)… | ### Queries the details of a data archiving ticket, including the time when the ticket was created, the… `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-data-archive-order-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | OrderId | integer | yes | The IDs of data archiving tickets | | Tid | integer | no | The tenant ID. To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS)… | ### Retrieves the download URL for the backup file of a data change ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-data-correct-backup-files` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | | OrderId | integer | yes | The ticket ID. You can call the https://help.aliyun.com/document_detail/144643.html operation to obtain the value of this parameter | | ActionDetail | string | no | The operation parameter. You do not need to specify this parameter (JSON-encoded) | ### Queries the information about a data change ticket in Data Management (DMS) `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-data-correct-order-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The ID of the tenant. You can call the https://help.aliyun.com/document_detail/198073.html or… | | OrderId | integer | yes | The ID of the ticket. You can call the https://help.aliyun.com/document_detail/144643.html operation to obtain the ticket ID | ### Queries the download URL of the rollback attachment submitted along with a data change ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-data-correct-rollback-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | OrderId | integer | yes | The ID of the ticket. You can call the https://help.aliyun.com/document_detail/144643.html operation to query the ticket ID | | Tid | integer | no | The ID of the tenant. : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile… | ### Queries the download URL of the SQL script for a data change task `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-data-correct-sqlfile` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | OrderId | integer | yes | The ID of the ticket | | Tid | integer | no | The ID of the tenant. : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile… | ### Retrieves the details of a ticket task for regular data changes, lock-free changes, or data imports `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-data-correct-task-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | OrderId | integer | yes | The ticket ID. You can call the https://help.aliyun.com/document_detail/208388.html, https://help.aliyun.com/document_detail/208387.html,… | | Tid | integer | no | The tenant ID. You can obtain the tenant ID by moving the pointer over the profile picture in the upper-right corner of the console. For… | ### Queries the scheduling configuration of a ticket for cleaning up historical data `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-data-cron-clear-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | OrderId | integer | yes | The ID of the ticket. You can call the https://help.aliyun.com/document_detail/144643.html operation to query the ticket ID | | Tid | integer | no | The ID of the tenant. : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile… | ### Queries the details of a historical data cleansing ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-data-cron-clear-task-detail-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | OrderId | integer | yes | The ID of the ticket. You can query the ticket ID from the response parameters of the https://help.aliyun.com/document_detail/208385.html… | | PageNumber | integer | no | The number of the page to return | | PageSize | integer | no | The number of entries to return on each page | | Tid | integer | no | The ID of the tenant. To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data… | ### Queries the download URL of export results for a data export ticket `POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/get-data-export-download-url` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dms-enterprise.ap-southeast-1.aliyuncs.com | | Tid | integer | no | The tenant ID. You can call the https://help.aliyun.com/document_detail/198073.html or https://help.aliyun.com/document_detail/198074.html… | | OrderId | integer | yes | The ticket ID. You can call the https://help.aliyun.com/document_detail/144643.html operation to query the ticket ID | | RealLoginUserUid | string | no | The ID of the Alibaba Cloud account that is used to call the API operation | …and 219 more. See the OpenAPI spec. ## Example ``` curl "https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/add-authority-template-items" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud Data Management API? Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-dms-enterprise/add-authority-template-items with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud Data Management API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Data Management itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud Data Management API? Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-dms-enterprise. ### What is the status of the Alibaba Cloud Data Management API? Needs your own provider key (bring your own key)