すべてのプロダクト
Search
ドキュメントセンター

Data Management:ListDataLakeFunction

最終更新日:Mar 17, 2026

この API を呼び出して、データレイクの関数一覧を取得します。

今すぐお試しください

この 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:ListDataLakeFunction

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DataRegion

string

必須

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

cn-hangzhou

Tid

integer

任意

テナント ID です。

説明

テナント ID を確認するには、コンソールの右上隅にあるプロフィール画像にポインターを合わせます。詳細については、「テナント情報の表示」をご参照ください。

3***

CatalogName

string

必須

データカタログの名前です。

hive

DbName

string

任意

データベースの名前です。

default

FunctionNamePattern

string

任意

関数名をフィルターするための正規表現です。

.*

NextToken

string

任意

次のページの結果を取得するために使用するトークンです。前のリクエストの応答が途中で切断された場合、このトークンを使用して次のページの結果を取得できます。

  • NextToken が空の場合、次のクエリは存在しません。

  • NextToken に値が返された場合、その値が次のクエリ用のトークンです。

f056501ada12c1cc

MaxResults

integer

任意

各ページに表示するエントリ数です。最大値は 100 です。

20

WorkspaceId

integer

任意

ワークスペース ID です。

12****

レスポンスフィールド

フィールド

説明

object

応答のスキーマです。

RequestId

string

リクエスト ID です。ログの特定や問題のトラブルシューティングに使用されます。

7FAD400F-7A5C-4193-8F9A-39D86C4F0231

Success

boolean

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

  • true:リクエストが成功しました。

  • false:リクエストが失敗しました。

true

ErrorCode

string

呼び出しが失敗した場合に返されるエラーコードです。

UnknownError

ErrorMessage

string

呼び出しが失敗した場合に返されるエラーメッセージです。

UnknownError

FunctionList

array

関数の一覧です。

DLFunction

関数の情報です。

NextToken

string

次のページの結果を取得するために使用するトークンです。これより先の結果がない場合は、このパラメーターは応答に含まれません。

f056501ada12c1cc

MaxResults

integer

ページあたりのエントリ数です。

20

成功レスポンス

JSONJSON

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "FunctionList": [
    {
      "FunctionName": "my_funciton",
      "OwnerName": "zhangsan",
      "OwnerType": "USER",
      "CreatorId": 0,
      "FunctionType": "JAVA",
      "CreateTime": 1731586286,
      "ResourceUris": [
        {
          "ResourceType": "JAR",
          "Uri": "hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar"
        }
      ],
      "ClassName": "com.example.hive.MyCustomUDF",
      "CatalogName": "hive",
      "DbName": "default",
      "ModifierId": 0
    }
  ],
  "NextToken": "f056501ada12c1cc",
  "MaxResults": 20
}

エラーコード

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

変更履歴

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