GetTableDesignProjectInfo - Data Management - Alibaba Cloud Documentation Center

Queries the information about the project and change base database of a schema design ticket, such as the state of the ticket, the ID of the user who created the ticket, and the name and ID of the change base database.

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

There is currently no authorization information disclosed in the API.

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 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.	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	long	The ticket ID.	95****
ProjectId	long	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.	test
Description	string	The description of the schema design project.	test
CreatorId	long	The ID of the user who created the ticket.	71****
BaseDatabase	object	The information about the change base database of the schema design ticket.
SearchName	string	The name that is used to search for 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.	poc_test
EnvType	string	The type of the environment in which the database instance is deployed. 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 type of the database. For more information about the valid values of this parameter, see DbType parameter.	POLARDB

Examples

Sample success responses

JSONformat

{
  "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": "test",
    "Description": "test",
    "CreatorId": 0,
    "BaseDatabase": {
      "SearchName": "schema_name@127.0.XX.XX",
      "SchemaName": "bk_atc020",
      "DbId": 0,
      "Logic": false,
      "Alias": "poc_test",
      "EnvType": "dev",
      "DbType": "POLARDB"
    }
  }
}

Error codes

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