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

DataWorks:CreateAgent

最終更新日:Sep 03, 2026

エージェントを作成します。

操作説明

操作の説明

  • エージェント名: 現在のアカウント内で一意である必要があります。

  • モデル構成: エージェントが使用するモデルおよび関連設定を指定するオプションのパラメーターです。

  • 可視性レベル: エージェントにアクセスできる対象を定義します。エージェントは、アカウント内、特定のプロジェクト、または特定のユーザーに対して可視化できます。

  • 可視性範囲: 可視性レベルを PROJECT または USER に設定する場合、プロジェクト ID またはユーザー ID のリストを指定する必要があります。

  • その他のパラメーター: 表示名や説明などのオプションのパラメーターです。必要に応じて設定してください。

今すぐお試しください

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

create

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

Name

string

必須

エージェント名。現在のアカウント内で一意である必要があります。

my-agent

DisplayName

string

任意

エージェントの表示名。

MyAssistant

Description

string

任意

エージェントの説明。

データ分析アシスタント

Model

object

任意

モデル構成。

{ "modelName": "dataworks-public-bailian/qwen-max" }

SystemPrompt

string

任意

システムプロンプト。

あなたはデータ分析アシスタントです

Tools

array<object>

任意

ツールのリスト。

-

object

任意

ツール情報。

-

Name

string

任意

McpServer 名。

server-1

Skills

array<object>

任意

スキルのリスト。

-

object

任意

スキル構成。

["my-skill"]

Name

string

任意

スキル名。

skill-1

CallableAgents

array<object>

任意

このエージェントから呼び出し可能な子エージェントのリスト。

-

object

任意

エージェント名。

["agent-name"]

Name

string

任意

エージェント名。

agent-1

Metadata

object

任意

拡張メタデータ (キーと値のペア)。

{}

Visibility

string

任意

可視性レベル。
TENANT: アカウント内で可視。
PROJECT: 指定されたプロジェクトに対して可視。
USER: 指定されたユーザーに対して可視。







TENANT

VisibilityScope

object

任意

可視性範囲。対応するフィールドは Visibility パラメーターによって決定されます。

ProjectIds

array

任意

エージェントが可視となるプロジェクト ID のリスト。このパラメーターは、Visibility が PROJECT にセットされている場合にのみ効果が適用されます。

string

任意

ワークスペース ID のリスト。

[21791]

UserIds

array

任意

エージェントが可視となるユーザー ID のリスト。このパラメーターは、Visibility が USER にセットされている場合にのみ効果が適用されます。

string

任意

エージェントが可視となるユーザー ID のリスト。このパラメーターは、Visibility が USER にセットされている場合にのみ効果が適用されます。

[]

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスのスキーマ。

RequestId

string

リクエスト ID。

824F80BA-1778-5D8A-BAFF-668A4D9C4CC7

Agent

object

作成されたエージェントの詳細。

Name

string

エージェント名。

my-agent

GmtCreateTime

string

作成時間 (ミリ秒精度の UNIX タイムスタンプ)。

1780555634000

GmtModifiedTime

string

最終更新時間 (ミリ秒精度の UNIX タイムスタンプ)。

1780555634000

例

成功レスポンス

JSONJSON

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "Agent": {
    "Name": "my-agent",
    "GmtCreateTime": "1780555634000",
    "GmtModifiedTime": "1780555634000"
  }
}

エラーコード

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

変更履歴

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