全部产品
Search

搜索本产品

    数据管理 DMS：GetTableDesignProjectInfo - 获取结构设计项目信息

    文档中心

    数据管理 DMS：GetTableDesignProjectInfo - 获取结构设计项目信息

    更新时间：Aug 27, 2026

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

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dms:GetTableDesignProjectInfo

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    OrderId

    integer

    是

    结构设计工单 ID。您可调用 ListOrders 接口获取该参数的值。

    95****
    Tid

    integer

    否

    租户 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

    integer

    工单 ID。

    95****
    ProjectId

    integer

    项目 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

    integer

    工单创建者的用户 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"
    }
  }
}

    错误码

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

    变更历史

    更多信息，参考变更详情。