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

DataWorks:GetAgent

最終更新日:Sep 03, 2026

名前でエージェントの詳細を取得します。

操作説明

リクエスト

このAPIは、パラメーターとして指定されたエージェント名を使用して、モデル設定、システムプロンプト、ツールリストを含む詳細な設定を取得します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

Name

string

必須

取得するスキルの名前。

my-skill

レスポンスフィールド

フィールド

型

説明

例

object

応答パラメーター。

RequestId

string

リクエストID。

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

Agent

object

エージェントの詳細。

CreatorId

string

作成者 ID。

123456

ModifierId

string

最終更新者のID。

123456

Name

string

エージェント名。

my-agent

DisplayName

string

表示名。

我的助手

Description

string

説明。

数据分析助手

Model

object

モデル設定。

ModelName

string

qwen3-max

Temperature

number

1

TopP

number

1

MaxTokens

integer

8192

Stream

boolean

true

Config

object

{}

SystemPrompt

string

システムプロンプト。

你是一个数据分析助手。

Tools

array<object>

ツールのリスト。

object

Kind

string

builtin

BuiltinName

string

builtin_sql

McpServerName

string

server-name

McpItems

array

string

search_table

Skills

array<object>

スキルのリスト。

object

Name

string

my-skill

Version

integer

-

CallableAgents

array<object>

呼び出し可能なサブエージェントのリスト。

object

Name

string

sub-agent

DisplayName

string

子助手

Version

integer

-

Source

string

custom

RequiredRuntime

array

ランタイム依存関係のリスト。

string

ランタイム依存関係。

-

Metadata

object

追加のメタデータ。

{}

Visibility

string

可視性レベル。

TENANT

VisibilityScope

object

可視性スコープ。

ProjectIds

array

string

proj_001

UserIds

array

string

123456

GmtCreateTime

string

作成時刻。Unixタイムスタンプ(ミリ秒)形式。

1780555634000

GmtModifiedTime

string

最終更新時刻。Unixタイムスタンプ(ミリ秒)形式。

1780555634000

例

成功レスポンス

JSONJSON

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "Agent": {
    "CreatorId": "123456",
    "ModifierId": "123456",
    "Name": "my-agent",
    "DisplayName": "我的助手",
    "Description": "数据分析助手",
    "Model": {
      "ModelName": "qwen3-max",
      "Temperature": 1,
      "TopP": 1,
      "MaxTokens": 8192,
      "Stream": true,
      "Config": {}
    },
    "SystemPrompt": "你是一个数据分析助手。",
    "Tools": [
      {
        "Kind": "builtin",
        "BuiltinName": "builtin_sql",
        "McpServerName": "server-name",
        "McpItems": [
          "search_table"
        ]
      }
    ],
    "Skills": [
      {
        "Name": "my-skill",
        "Version": 0
      }
    ],
    "CallableAgents": [
      {
        "Name": "sub-agent",
        "DisplayName": "子助手",
        "Version": 0,
        "Source": "custom"
      }
    ],
    "RequiredRuntime": [
      "-"
    ],
    "Metadata": {},
    "Visibility": "TENANT",
    "VisibilityScope": {
      "ProjectIds": [
        "proj_001"
      ],
      "UserIds": [
        "123456"
      ]
    },
    "GmtCreateTime": "1780555634000",
    "GmtModifiedTime": "1780555634000"
  }
}

エラーコード

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

変更履歴

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