すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeAdbMySqlTableMeta

    ドキュメントセンター

    AnalyticDB:DescribeAdbMySqlTableMeta

    最終更新日:Mar 17, 2026

    テーブルメタデータに関する情報を照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    adb:DescribeAdbMySqlTableMeta

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    説明

    最新のリージョンリストは、DescribeRegions 操作を呼び出して照会できます。

    cn-hangzhou
    DBClusterId

    string

    必須

    AnalyticDB for MySQL Data Lakehouse Edition クラスターの ID。

    説明

    リージョン内のすべての AnalyticDB for MySQL Data Lakehouse Edition クラスターの ID は、DescribeDBClusters 操作を呼び出して照会できます。

    am-bp11q28kvl688****
    Schema

    string

    必須

    データベース名。

    adb_demo
    TableName

    string

    必須

    テーブル名。

    説明

    このパラメーターを空のままにすると、クラスター内の現在のすべてのテーブルに関する情報が返されます。

    test

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Message

    string

    返されたメッセージ。有効な値は次のとおりです：

    • リクエストが成功した場合、成功メッセージが返されます。****

    • リクエストが失敗した場合、エラーメッセージが返されます。

    Success
    RequestId

    string

    リクエスト ID。

    2FED790E-FB61-4721-8C1C-07C627FA5A19
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値は次のとおりです：

    • true

    • false

    true
    TableMeta

    object

    照会されたテーブルメタデータ。

    TableSchema

    string

    テーブルが属するデータベース。

    tpch
    TableName

    string

    テーブル名。

    **

    external_supplier
    TableType

    string

    テーブルのタイプ。

    fact_table
    DistributeType

    string

    ディストリビューションタイプ。

    hash
    DistributeColumn

    string

    分散キー列。

    customer_id
    PartitionType

    string

    パーティションのタイプ。

    value
    PartitionColumn

    string

    パーティションキー列。

    DATE_FORMAT(login_time, '%Y%m%d')
    PrimaryKeyColumn

    string

    プライマリキー列。

    login_time,customer_id,phone_num
    TableEngine

    string

    テーブルエンジン。

    XUANWU
    IsDictEncode

    boolean

    辞書エンコーディングが使用されているかどうかを示します。

    true
    IsHidden

    boolean

    ページが非表示かどうかを示します。

    • false

    • true

    true
    IsAllIndex

    boolean

    全列インデックスが使用されているかどうかを示します。

    false
    IsFullTextDict

    boolean

    フルテキストインデックスが使用されているかどうかを示します。

    true
    CreateTime

    string

    テーブルが作成された時間。

    2025-03-14 02:18:08.0
    UpdateTime

    string

    テーブルが更新された時間。

    2024-07-25 02:07:23.0

    例

    成功レスポンス

    JSONJSON

    {
  "Message": "Success",
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627FA5A19",
  "Success": true,
  "TableMeta": {
    "TableSchema": "tpch",
    "TableName": "external_supplier",
    "TableType": "fact_table",
    "DistributeType": "hash",
    "DistributeColumn": "customer_id",
    "PartitionType": "value",
    "PartitionColumn": "DATE_FORMAT(login_time, '%Y%m%d')",
    "PrimaryKeyColumn": "login_time,customer_id,phone_num",
    "TableEngine": "XUANWU",
    "IsDictEncode": true,
    "IsHidden": true,
    "IsAllIndex": false,
    "IsFullTextDict": true,
    "CreateTime": "2025-03-14 02:18:08.0",
    "UpdateTime": "2024-07-25 02:07:23.0"
  }
}

    エラーコード

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

    変更履歴

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