Query schema design project information by using GetTableDesignProjectInfo - Data Management - Alibaba Cloud - Data Management

Retrieves the project details and change base database information for a specified schema design ticket, including the ticket state, creator ID, and the name and ID of the change base database.

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:GetTableDesignProjectInfo

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 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 can be used to query logs and troubleshoot issues.	48778434-5796-571A-8455-A59146588401
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
ProjectInfo	object	The information about the schema design project.
OrderId	integer	The ticket ID.	95****
ProjectId	integer	The project ID.	12****
GmtCreate	string	The time when the ticket was created.	2024-04-23 02:57:01
GmtModified	string	The time when the ticket was last modified.	2024-04-23 02:57:01
Status	string	The state of the schema design project. Valid values: DESIGN: The schema is being designed. PUBLISHED: The schema is published. CLOSE: The ticket is closed.	DESIGN
Title	string	The name of the schema design project.	用户增长战役
Description	string	The description of the schema design project.	测试
CreatorId	integer	The ID of the user who created the ticket.	71****
BaseDatabase	object	The change base database details for the schema design ticket.
SearchName	string	The searchable name of the database.	schema_name@127.0.XX.XX
SchemaName	string	The database name.	bk_atc020
DbId	integer	The database ID.	11****
Logic	boolean	Indicates whether the database is a logical database. Valid values: true false	false
Alias	string	The alias of the database instance.	核心交易库
EnvType	string	The environment type of the database instance. Valid values: product: production environment. dev: development environment. pre: pre-release environment. test: test environment. sit: system integration testing (SIT) environment. uat: user acceptance testing (UAT) environment. pet: stress testing environment. stag: staging environment.	dev
DbType	string	The database type. For more information about the valid values of this parameter, see DbType parameter.	PolarDB

Examples

Success response

JSON format

{
  "RequestId": "48778434-5796-571A-8455-A59146588401",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "ProjectInfo": {
    "OrderId": 0,
    "ProjectId": 0,
    "GmtCreate": "2024-04-23 02:57:01",
    "GmtModified": "2024-04-23 02:57:01",
    "Status": "DESIGN",
    "Title": "用户增长战役",
    "Description": "测试",
    "CreatorId": 0,
    "BaseDatabase": {
      "SearchName": "schema_name@127.0.XX.XX",
      "SchemaName": "bk_atc020",
      "DbId": 0,
      "Logic": false,
      "Alias": "核心交易库",
      "EnvType": "dev",
      "DbType": "POLARDB"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.