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

DataWorks:AddMetaCollectionEntity

最終更新日:Sep 03, 2026

コレクションにエンティティを追加します。

操作説明

事前準備: この操作の呼び出し前に、DataWorks Professional Edition 以上のエディションを有効化してください。Basic Edition および標準エディションでは、メタデータコレクションの特徴はサポートされていません。

今すぐお試しください

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

update

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

CollectionQualifiedName

string

必須

コレクションの一意の識別子。

album.2222

EntityQualifiedName

string

必須

エンティティの一意の識別子。

maxcompute-table.projectA.tableB

Remark

string

任意

エンティティの備考。

これは備考です

レスポンスフィールド

フィールド

型

説明

例

object

レスポンス構造体。

RequestId

string

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

0000-ABCD-E****

Status

boolean

操作の結果。有効な値:

  • true: 成功。

  • false: 失敗。

true

HttpStatusCode

integer

HTTP 状態コード。

200

ErrorMessage

string

エラーメッセージ。

指定されたプロダクトは存在しません

ErrorCode

string

エラーコード。

9999

Success

boolean

呼び出しが成功したかどうかを示します。有効な値:

  • true: 呼び出しが成功しました。

  • false: 呼び出しが失敗しました。

true

例

成功レスポンス

JSONJSON

{
  "RequestId": "0000-ABCD-E****",
  "Status": true,
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified product does not exist",
  "ErrorCode": "9999",
  "Success": true
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Invalid.Entity.NotExist %s

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

変更履歴

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