GetTableDesignProjectInfo - 获取结构设计项目信息_数据管理(DMS)-阿里云帮助中心

调用此API可获取指定结构设计工单的项目信息以及工单的变更基准库的信息，包含结构设计工单的状态、工单创建者ID、基准库的名称和ID等。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
OrderId	long	是	结构设计工单 ID。您可调用 ListOrders 接口获取该参数的值。	95****
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，用于定位日志，排查问题。	48778434-5796-571A-8455-A59146588401
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
ErrorMessage	string	调用失败时，返回的错误信息。	UnknownError
ErrorCode	string	错误码，请求异常时返回。	UnknownError
ProjectInfo	object	结构设计项目信息。
OrderId	long	工单 ID。	95****
ProjectId	long	项目 ID。	12****
GmtCreate	string	工单的创建时间。	2024-04-23 02:57:01
GmtModified	string	最后一次修改工单的时间。	2024-04-23 02:57:01
Status	string	结构设计项目的状态： DESIGN：设计中。 PUBLISHED：已发布。 CLOSE：已关闭。	DESIGN
Title	string	结构设计项目名称。	用户增长战役
Description	string	结构设计项目描述。	测试
CreatorId	long	工单创建者的用户 ID。	71****
BaseDatabase	object	结构设计中变更基准库的信息。
SearchName	string	搜索数据库的名称。	schema_name@127.0.XX.XX
SchemaName	string	数据库名称。	bk_atc020
DbId	integer	数据库 ID。	11****
Logic	boolean	是否为逻辑库，取值： true：是。 false：否。	false
Alias	string	实例别名。	核心交易库
EnvType	string	环境类型，取值如下： product：生产环境。 dev：开发环境。 pre：预发环境。 test：测试环境。 sit：SIT 环境。 uat：UAT 环境。 pet：压测环境。 stag：STAG 环境。	dev
DbType	string	数据库类型，返回值请参见 DbType 参数说明。	POLARDB

示例

正常返回示例

JSON格式

{
  "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"
    }
  }
}

错误码

访问错误中心查看更多错误码。