すべてのプロダクト
Search

このプロダクト

    DataWorks:GetMetaTableBasicInfo

    ドキュメントセンター

    DataWorks:GetMetaTableBasicInfo

    最終更新日:Mar 21, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:*

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TableGuid

    string

    任意

    MaxCompute テーブルの GUID。odps.projectName.tableName 形式で指定します。

    説明

    このパラメーターは E-MapReduce (EMR) テーブルに対してはオプションです。

    odps.engine_name.table_name
    ClusterId

    string

    任意

    EMR クラスターの ID。DataSourceType パラメーターを emr に設定した場合にのみ必須です。

    EMR コンソール にログインして、ID を照会できます。

    abc
    DatabaseName

    string

    任意

    メタデータベースの名前。DataSourceType パラメーターを emr に設定した場合にのみ必須です。

    ListMetaDB 操作を呼び出して、名前を照会できます。

    abc
    TableName

    string

    任意

    EMR クラスター内のメタテーブルの名前。DataSourceType パラメーターを emr に設定した場合にのみ必須です。

    GetMetaDBTableList 操作を呼び出して、名前を照会できます。

    abc
    DataSourceType

    string

    任意

    データソースの種類。有効な値：odps、emr。

    emr
    Extension

    boolean

    任意

    クエリ結果に拡張フィールド（ReadCount、FavoriteCount、ViewCount）を含めるかどうかを指定します。このパラメーターは、DataSourceType パラメーターを odps に設定した場合にのみ有効です。

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答。

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    ErrorMessage

    string

    エラーメッセージ。

    The connection does not exist.
    RequestId

    string

    リクエスト ID。

    0bc1411515937
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    ErrorCode

    string

    エラーコード。

    Invalid.Tenant.ConnectionNotExists
    Data

    object

    業務データ。

    TableName

    string

    メタテーブルの名前。

    table_name
    FavoriteCount

    integer

    メタテーブルがお気に入りリストに追加された回数。Extension パラメーターを true に設定した場合にのみ返されます。また、DataSourceType パラメーターを odps に設定した場合にのみ有効です。

    6
    Comment

    string

    メタテーブルのコメント。

    test table
    ColumnCount

    integer

    フィールド数。

    3
    CreateTime

    integer

    メタテーブルが作成された時刻。

    1589870294000
    ProjectId

    integer

    ワークスペース ID。

    232
    OwnerId

    string

    メタテーブルのオーナー ID。

    123
    EnvType

    integer

    環境の種類。有効な値：

    • 0：開発環境

    • 1：本番環境

    1
    DatabaseName

    string

    メタデータベースの名前。

    abc
    IsVisible

    integer

    メタテーブルが表示される範囲。有効な値：

    • 0：ワークスペースメンバーのみが表示可能

    • 1：テナント内のユーザーのみが表示可能

    • 2：すべてのテナントが表示可能

    • 3：メタテーブルのオーナーのみが表示可能

    1
    TableGuid

    string

    メタテーブルの GUID。

    odps.engine_name.table_name
    ReadCount

    integer

    メタテーブルが読み取られた回数。Extension パラメーターを true に設定した場合にのみ返されます。また、DataSourceType パラメーターを odps に設定した場合にのみ有効です。

    3
    ClusterId

    string

    EMR クラスターの ID。

    abc
    IsPartitionTable

    boolean

    メタテーブルがパーティションテーブルであるかどうかを示します。有効な値：

    • true

    • false

    true
    IsView

    boolean

    メタテーブルがビューであるかどうかを示します。有効な値：

    • true

    • false

    false
    LifeCycle

    integer

    テーブルのライフサイクル。単位：日。

    説明

    MaxCompute テーブルのライフサイクルが設定されていない場合、戻り値は 0 となり、テーブルが永続的に有効であることを示します。

    5
    ProjectName

    string

    ワークスペースの名前。

    test
    ViewCount

    integer

    メタテーブルが表示された回数。Extension パラメーターを true に設定した場合にのみ返されます。また、DataSourceType パラメーターを odps に設定した場合にのみ有効です。

    2
    LastAccessTime

    integer

    メタテーブルが最後にアクセスされた時刻。

    1589870294000
    DataSize

    integer

    メタテーブルが占有するストレージ容量。単位：バイト。

    10
    LastModifyTime

    integer

    メタテーブルが最後に更新された時刻。

    1589870294000
    LastDdlTime

    integer

    メタテーブルのスキーマが最後に変更された時刻。

    1589870294000
    PartitionKeys

    string

    Hive メタテーブルのパーティションキー。

    ab
    Location

    string

    Hive メタデータベースのストレージパス。

    hdfs://
    Caption

    string

    メタテーブルの表示名。

    中文名
    TenantId

    integer

    テナント ID。

    12345
    Schema

    string

    メタテーブルのスキーマ情報。MaxCompute の 3 層モデルが有効化されている場合に返されます。

    default

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1411515937",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "TableName": "table_name",
    "FavoriteCount": 6,
    "Comment": "test table",
    "ColumnCount": 3,
    "CreateTime": 1589870294000,
    "ProjectId": 232,
    "OwnerId": "123",
    "EnvType": 1,
    "DatabaseName": "abc",
    "IsVisible": 1,
    "TableGuid": "odps.engine_name.table_name",
    "ReadCount": 3,
    "ClusterId": "abc",
    "IsPartitionTable": true,
    "IsView": false,
    "LifeCycle": 5,
    "ProjectName": "test",
    "ViewCount": 2,
    "LastAccessTime": 1589870294000,
    "DataSize": 10,
    "LastModifyTime": 1589870294000,
    "LastDdlTime": 1589870294000,
    "PartitionKeys": "ab",
    "Location": "hdfs://",
    "Caption": "中文名",
    "TenantId": 12345,
    "Schema": "default"
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Invalid.Meta.TableNotExist The table does not exist.
    400 InvalidParameter.Meta.CommonError The specified parameter is invalid.
    400 InvalidParameter.Meta.Illegal The app guid parameter is invalid.
    400 InvalidParameter.Meta.IllegalDate The date format is invalid.
    400 InvalidParameter.Meta.IllegalPageError The parameter for paging is invalid.
    400 InvalidParameter.Meta.NotExist The object does not exist.
    400 InternalError.UserId.Missing An internal system error occurred. Try again later.
    400 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project.
    500 InternalError.System An internal system error occurred. Try again later.
    500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network.
    500 InternalError.Meta.Unknown An unknown error occurred while processing your request.
    403 Forbidden.Meta.NoTenant The user is not the owner of any tenants.
    403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
    429 Throttling.Api The request for this resource has exceeded your available limit.
    429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit.
    429 Throttling.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

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

    変更履歴

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