Call GetTableDesignProjectFlow to query the project flow of a schema design ticket - Data Management - Alibaba Cloud - Data Management

Queries the flow information of a schema design ticket, including the current node, whether the ticket can return to the design node, and the publishing strategy.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetTableDesignProjectFlow

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ID of the schema design ticket. You can call the ListOrders operation to obtain the ID.	95****
Tid	integer	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 elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, which is used for troubleshooting.	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.
	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. Each schema design process has only one anchor node, on which the schema is published. After publishing, 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.
	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 applied to the schema design ticket.	mysql default
RuleComment	string	The description of the security rule set applied to the schema design ticket.	mysql缺省规则集

Examples

Success response

JSON format

{
  "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": "mysql缺省规则集"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.