文档

GetMetaTableDetailInfo - 获取表的字段、索引等信息

更新时间:

调用GetMetaTableDetailInfo接口获取表的字段、索引等信息。

接口说明

仅管控模式为安全协同的数据库实例可调用此 API。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetMetaTableDetailInfoRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
123
TableGuidstring

表在 DMS 中的唯一识别码 GUID(Globally Unique Identifier)。

说明
  • 逻辑库:可调用 ListLogicTables 接口获取,需要将 ReturnGuid 参数设置为 true。
  • 物理库:可调用 ListTables 接口获取,需要将 ReturnGuid 参数设置为 true。
  • IDB_L_9032.db-test.yuyang_test

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    E881CB2F-DE42-42E5-90EB-8B3173DCB9B9
    DetailInfoobject

    表详情。

    IndexListobject []

    索引列表。

    IndexColumnsarray

    索引字段列表。

    string

    索引字段。

    id
    IndexNamestring

    索引名。

    PRIMARY
    Uniqueboolean

    是否为唯一索引。取值:

    • true:是唯一索引。
    • false:不是唯一索引。
    false
    IndexTypestring

    索引类型。例如:Primary、Unique、Normal。

    Primary
    IndexIdstring

    索引 ID。

    123
    ColumnListobject []

    字段列表。

    ColumnNamestring

    字段名。

    id
    Descriptionstring

    字段描述。

    test
    DataScaleinteger

    该字段小数后的位数。

    0
    DataPrecisioninteger

    字段精度。

    0
    ColumnTypestring

    字段的数据类型。例如:Bigint 、Int、Varchar。

    bigint(20) unsigned
    AutoIncrementboolean

    当前字段是否自增。取值:

    • true:自增。
    • false:不自增。
    true
    Positionstring

    字段在表中的顺序。

    1
    Nullableboolean

    是否可空。取值:

    • true:允许为空。
    • false:不允许为空。
    false
    ColumnIdstring

    字段 ID。

    191234849
    DataLengthlong

    字段长度。

    0
    ErrorCodestring

    错误码。

    UnknownError
    ErrorMessagestring

    错误信息。

    UnknownError
    Successboolean

    请求是否成功。

    true

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "E881CB2F-DE42-42E5-90EB-8B3173DCB9B9",
      "DetailInfo": {
        "IndexList": [
          {
            "IndexColumns": [
              "id"
            ],
            "IndexName": "PRIMARY",
            "Unique": false,
            "IndexType": "Primary",
            "IndexId": "123"
          }
        ],
        "ColumnList": [
          {
            "ColumnName": "id",
            "Description": "test",
            "DataScale": 0,
            "DataPrecision": 0,
            "ColumnType": "bigint(20) unsigned",
            "AutoIncrement": true,
            "Position": "1",
            "Nullable": false,
            "ColumnId": "191234849",
            "DataLength": 0
          }
        ]
      },
      "ErrorCode": "UnknownError",
      "ErrorMessage": "UnknownError",
      "Success": true
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)
    文档反馈