すべてのプロダクト
Search

このプロダクト

    DataWorks:ListCustomAttributes

    ドキュメントセンター

    DataWorks:ListCustomAttributes

    最終更新日:Sep 03, 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:ListCustomAttributes

    list

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    GET  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    ページ番号。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。

    10
    DisplayName

    string

    任意

    カスタム属性の表示名。値はプレーンテキストの部分一致でマッチングされます。

    Owner
    EntityTypes

    string

    任意

    カスタム属性が適用されるエンティティタイプ。複数のエンティティタイプはカンマで区切ります (例: *-table,*-column)。特定のエンティティタイプ (hms-table、emr-table など) およびワイルドカードタイプ *-table、*-column がサポートされています。

    maxcompute-table
    Comment

    string

    任意

    カスタム属性の説明。値はあいまいマッチングされます。

    owner
    SortBy

    string

    任意

    ソートフィールド。有効な値: CreateTime、ModifyTime。

    列挙値:

    • ModifyTime :

      更新日時でソートします。

    • CreateTime :

      作成日時でソートします。

    • Type :

      タイプでソートします。

    • Name :

      名前でソートします。

    CreateTime
    Order

    string

    任意

    ソート注文。有効な値: Asc、Desc。

    列挙値:

    • Asc :

      昇順の注文。

    • Desc :

      降順の注文。

    Asc

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

    54594ACA-7976-5273-958B-02E15E9B867C
    Success

    boolean

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

    true
    PagingInfo

    object

    ページネーション情報。

    TotalCount

    integer

    エントリの総数。

    10
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

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

    10
    CustomAttributes

    array

    カスタム属性オブジェクトのリスト。

    CustomAttribute

    カスタム属性オブジェクト。

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "54594ACA-7976-5273-958B-02E15E9B867C",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 10,
    "PageNumber": 1,
    "PageSize": 10,
    "CustomAttributes": [
      {
        "Id": "custom-attribute:biz_owner",
        "DisplayName": "业务负责人",
        "Type": "TEXT",
        "EntityTypes": [
          "maxcompute-table"
        ],
        "ValueEnums": [
          "VALUE_1"
        ],
        "SearchFilterEnabled": false,
        "DisplayEnabled": true,
        "Comment": "this is a comment",
        "CreateTime": 1750817692000,
        "ModifyTime": 1763380628000
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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