首页 云数据库 ClickHouse 开发参考 API参考(企业版) API目录 数据库管理 DescribeDBInstanceDataSources - 查询DB或者Table的数据结构

DescribeDBInstanceDataSources - 查询DB或者Table的数据结构

更新时间: 2025-01-09 18:37:15

调用DescribeDBInstanceDataSources接口查询DB或者Table的数据结构。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
DBInstanceIdstring

集群 ID。

cc-bp100p4q1g9z3****
DBNamestring

数据库名称。

dbtest
TableNamestring

表名称。

tableTest

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

F543E6CC-6868-523D-8D28-0E92CF977ED2
Dataobject

返回结果。

DBInstanceIdstring

集群 ID。

cc-bp100p4q1g9z3****
Schemasstring

账号。

default
Tablesarray

表列表。

Tablestring

表列表。

table_test
Columnsarray<object>

列类型。

Columnobject

列类型。

DBNamestring

数据库名称。

dbtest
Typestring

存储数据类型。

UInt64
TableNamestring

表名。

tableTest
ColumnNamestring

列名。

c31
PrimaryKeystring

列是否为主键,取值说明:

  • true:主键。
  • false:非主键。
false
Commentstring

数据库账号的描述。

测试

示例

正常返回示例

JSON格式

{
  "RequestId": "F543E6CC-6868-523D-8D28-0E92CF977ED2",
  "Data": {
    "DBInstanceId": "cc-bp100p4q1g9z3****",
    "Schemas": "default",
    "Tables": [
      "table_test"
    ],
    "Columns": [
      {
        "DBName": "dbtest",
        "Type": "UInt64",
        "TableName": "tableTest",
        "ColumnName": "c31",
        "PrimaryKey": "false",
        "Comment": "测试"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
404InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in our records.

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

变更历史

变更时间变更内容概要操作
2024-05-13OpenAPI 错误码发生变更查看变更详情
上一篇: DeleteDB - 删除数据库 下一篇: 网络管理
阿里云首页 云数据库 ClickHouse 相关技术圈