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

DataWorks:ListCustomAttributes

最終更新日:Jun 11, 2026

カスタム属性定義のリストを取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

GET  HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

PageNumber

integer

任意

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

1

PageSize

integer

任意

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

10

DisplayName

string

任意

カスタム属性の表示名。サービスはこのパラメーターの値に基づいて部分一致を実行します。

Owner

EntityTypes

string

任意

カスタム属性が適用されるエンティティタイプ。複数のエンティティタイプを指定するには、カンマ (,) で区切ります。例: *-table,*-column。このパラメーターは、hms-tableemr-table などの特定のエンティティタイプと、*-table*-column などのワイルドカードタイプをサポートします。

maxcompute-table

Comment

string

任意

カスタム属性に対するコメント。サービスはこのパラメーターの値に基づいてあいまい検索を実行します。

owner

SortBy

string

任意

ソート対象のフィールド。有効な値: CreateTime および ModifyTime。

列挙値:

  • ModifyTime :
  • CreateTime :

CreateTime

Order

string

任意

ソート順。有効な値: 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

ページサイズ。

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
      }
    ]
  }
}

エラーコード

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

変更履歴

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