すべてのプロダクト
Search

このプロダクト

    Data Management:GetDataLakeCatalog

    ドキュメントセンター

    Data Management:GetDataLakeCatalog

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:GetDataLakeCatalog

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DataRegion

    string

    必須

    データレイクが配置されているリージョン。

    cn-hangzhou
    CatalogName

    string

    必須

    データカタログの名称。

    hive
    Tid

    integer

    任意

    テナント ID。テナント ID は、GetUserActiveTenant 操作または ListUserTenants 操作を呼び出して取得できます。

    3
    WorkspaceId

    integer

    任意

    ワークスペース ID。

    12****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    RequestId

    string

    リクエスト ID。 このリクエスト ID を使用して、ログの特定や問題のトラブルシューティングができます。

    FE8EE2F1-4880-46BC-A704-5CF63EAF9A04
    Success

    boolean

    リクエストが成功したかどうかを示します。 有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコード。

    400
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージ。

    code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B7EB1
    Catalog DLCatalog

    カタログに関する情報。

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF9A04",
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B7EB1",
  "Catalog": {
    "Description": "init default catalog",
    "Name": "hive",
    "Location": "oss://xxxx"
  }
}

    エラーコード

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

    変更履歴

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