DescribeAllDataSource API でデータベース、テーブル、カラムをすべて説明 - ClickHouse

インスタンス内のすべてのデータベース、テーブル、および列に関する情報を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

clickhouse:DescribeAllDataSource

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	cc-bp108z124a8o7****
SchemaName	string	任意	データベース名。	database
TableName	string	任意	テーブル名。	table

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	05321590-BB65-4720-8CB6-8218E041CDD0
Tables	object
Table	array<object>	テーブル情報。
	object
TableName	string	テーブル名。	table
DBClusterId	string	クラスター ID。	cc-bp108z124a8o7****
SchemaName	string	データベース名。	database
Columns	object
Column	array<object>	列情報。
	object
Type	string	列のタイプ。	String
ColumnName	string	列名。	name
TableName	string	テーブル名。	table
AutoIncrementColumn	boolean	列が自動インクリメント列であるかどうかを示します。有効な値： true：列は自動インクリメント列です。 false：列は自動インクリメント列ではありません。	true
DBClusterId	string	クラスター ID。	cc-bp108z124a8o7****
PrimaryKey	boolean	列がプライマリキーであるかどうかを示します。有効な値： true：列はプライマリキーです。 false：列はプライマリキーではありません。	true
SchemaName	string	データベース名。	database
Schemas	object
Schema	array<object>	データベース情報。
	object
DBClusterId	string	クラスター ID。	cc-bp108z124a8o7****
SchemaName	string	データベース名。	database

例

成功レスポンス

JSONJSON

{
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0",
  "Tables": {
    "Table": [
      {
        "TableName": "table",
        "DBClusterId": "cc-bp108z124a8o7****",
        "SchemaName": "database"
      }
    ]
  },
  "Columns": {
    "Column": [
      {
        "Type": "String",
        "ColumnName": "name",
        "TableName": "table",
        "AutoIncrementColumn": true,
        "DBClusterId": "cc-bp108z124a8o7****",
        "PrimaryKey": true,
        "SchemaName": "database"
      }
    ]
  },
  "Schemas": {
    "Schema": [
      {
        "DBClusterId": "cc-bp108z124a8o7****",
        "SchemaName": "database"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。