获取数据库列的列表 - CreateColumns
功能介绍
获取数据库列的列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/sdg/server/mask/dbs/rdbs/tables/columns
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 是 | String | 参数解释: 查询类型,用于指定获取数据库列时所依据的类型(如按数据表类型等执行查询) 约束限制: 最大长度256字符 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| db_id | 是 | String | 参数解释: 数据库ID,标识目标数据库,可通过查询数据库列表接口获取 约束限制: 32-32,符合UUID 取值范围: 不涉及 默认取值: 不涉及 |
| db_name | 否 | String | 参数解释: 数据库名称 约束限制: 最大长度255字符 取值范围: 不涉及 默认取值: 不涉及 |
| schema | 否 | String | 参数解释: 数据库的schema模式(架构)名称,用于限定查询的数据库模式范围 约束限制: 最大长度255字符 取值范围: 不涉及 默认取值: 不涉及 |
| table_name | 是 | String | 参数解释: 表名称 约束限制: 最大长度255字符 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| column | Array of RdbColumn objects | 参数解释: 列信息列表,数组中的每个元素为一条数据库列记录,包含列名、数据类型、敏感数据级别、分类名称等信息 取值范围: 不涉及 |
| partition_info | Map<String,String> | 参数解释: 分区信息,键值对形式,键为分区字段名,值为分区字段值,用于描述数据库表的分区结构 取值范围: 不涉及 |
请求示例
获取数据库列的列表
{
"db_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"db_name" : "db-finance-01",
"schema" : "example-schema",
"table_name" : "table-finance-01"
} 响应示例
状态码:200
{
"column" : [ {
"column_name" : "字段1",
"data_type" : "varchar",
"level" : 1,
"classification_name" : "分类1",
"rule_name" : "规则1",
"rule_id" : "00000000-0000-0000-0000-000000000000"
} ],
"partition_info" : { }
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 操作成功 |
错误码
请参见错误码。