GetTableDesignProjectFlow - Data Management - Alibaba Cloud Documentation Center

Queries the information about a schema design ticket, such as the current node of the ticket, whether the ticket can be returned to the schema design node, and the publishing strategy.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetTableDesignProjectFlow	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
OrderId	long	Yes	The ID of the schema design ticket. You can call the ListOrders operation to obtain the ID.	95****
Tid	long	No	The tenant ID. Note To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	3***

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. You can use the request ID to query logs and troubleshoot issues.	B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
ProjectFlow	object	The information about the schema design process.
FlowNodeArray	array<object>	The nodes in the process.
FlowNodeArray	object
NodeRole	string	The role of the node in the process. START: The ticket was created. DESIGN: The schema is being created. PUBLISH: The schema is published. END: The ticket is complete.	DESIGN
NodeTitle	string	The title of the node.
Position	integer	The position of the node in the process. The value starts from 1.	1
PublishAnchor	boolean	Indicates whether the node is the anchor node. A schema design process has only one anchor node, on which the schema is published. After the schema is published on the anchor node, a post-publish image is generated and the DDL metadata lock is released.	false
BackToDesign	boolean	Indicates whether the ticket can be returned to the schema design node. Valid values: 1: The ticket can be returned to the schema design node. 0: The ticket cannot be returned to the schema design node. This value can be returned only for the PUBLISH node.	1
CanSkip	boolean	Indicates whether the current node can be skipped. Valid values: 1: The current node can be skipped. 0: The current node cannot be skipped. This value can be returned only for the PUBLISH node.	0
PublishStrategies	array	The available publishing strategies.
PublishStrategies	string	The publishing strategy. IMMEDIATELY: immediately publish the schema. REGULARLY: publish the schema at the scheduled time.	IMMEDIATELY
CurrentPosition	integer	The position of the current node in the process.	2
RuleName	string	The name of the security rule set that is applied to the schema design ticket.	mysql default
RuleComment	string	The description of the security rule set that is applied to the schema design ticket.	mysq_test

Examples

Sample success responses

JSONformat

{
  "RequestId": "B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "ProjectFlow": {
    "FlowNodeArray": [
      {
        "NodeRole": "DESIGN",
        "NodeTitle": "",
        "Position": 1,
        "PublishAnchor": false,
        "BackToDesign": true,
        "CanSkip": true,
        "PublishStrategies": [
          "IMMEDIATELY"
        ]
      }
    ],
    "CurrentPosition": 2,
    "RuleName": "mysql default",
    "RuleComment": "mysq_test"
  }
}

Error codes

For a list of error codes, visit the Service error codes.