全部产品
Search

搜索本产品

    数据管理 DMS：ListColumns - 获取表的列信息

    文档中心

    数据管理 DMS：ListColumns - 获取表的列信息

    更新时间：Nov 06, 2024

    返回表的列信息。

    接口说明

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

    调试

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

    授权信息

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

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

    请求参数

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

    租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。

    		3***
    TableIdstring是

    表 ID，可通过调用接口 ListTables 获取该参数的值。

    		39281****
    Logicboolean是

    是否为逻辑库，取值如下：

    • true：逻辑库
    • false：物理库
    		false

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		0AD9AC55-5873-474A-9F33-4285806A3619
    ErrorCodestring

    错误码。

    		UnknownError
    ColumnListarray<object>

    列信息详情。

    Columnobject

    字段列表信息。

    ColumnTypestring

    字段类型。

    		varchar
    AutoIncrementboolean

    当前字段是否自增。返回值如下：

    • true：自增。
    • false：不自增。
    		false
    ColumnIdstring

    字段 ID。

    		62589****
    DefaultValuestring

    字段默认值。

    		def_value
    Sensitiveboolean

    是否敏感字段，返回值如下：

    • true：敏感字段
    • false：非敏感字段
    		false
    ColumnNamestring

    字段名。

    		name
    SecurityLevelstring

    安全级别，返回值如下：

    • INNER：内部（非敏感）
    • SENSITIVE：敏感
    • CONFIDENTIAL：机密
    说明 更多信息，请参见字段安全等级。
    		INNER
    Descriptionstring

    字段描述。

    		test
    DataPrecisioninteger

    字段的有效数字位数。

    		0
    DataScaleinteger

    字段的小数位数。

    		0
    FunctionTypestring

    字段遮掩算法类型，返回值如下：

    • null：无遮掩
    • DEFAULT：全遮掩
    • FIX_POS：固定位置遮掩
    • FIX_CHAR：固定字符替换
    		DEFAULT
    Nullableboolean

    字段是否可空，返回值如下：

    • true：可空
    • false：不可空
    		false
    DataLengthlong

    字段长度。

    		4
    ErrorMessagestring

    错误信息。

    		UnknownError
    Successboolean

    请求是否成功，返回值如下：

    • true：请求成功
    • false：请求失败
    		true

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "0AD9AC55-5873-474A-9F33-4285806A3619",
  "ErrorCode": "UnknownError",
  "ColumnList": {
    "Column": [
      {
        "ColumnType": "varchar",
        "AutoIncrement": false,
        "ColumnId": "62589****",
        "DefaultValue": "def_value",
        "Sensitive": false,
        "ColumnName": "name",
        "SecurityLevel": "INNER",
        "Description": "test",
        "DataPrecision": 0,
        "DataScale": 0,
        "FunctionType": "DEFAULT",
        "Nullable": false,
        "DataLength": 4
      }
    ]
  },
  "ErrorMessage": "UnknownError",
  "Success": true
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史