すべてのプロダクト
Search

このプロダクト

    Database Autonomy Service:GetDasAgentSSE

    ドキュメントセンター

    Database Autonomy Service:GetDasAgentSSE

    最終更新日:May 22, 2026

    この API は、サーバー送信イベント (SSE) を使用して DAS エージェントと対話します。この API は、Q&A やパフォーマンス診断などの機能に使用できます。

    操作説明

    この API は有料です。出力文字数に基づいて課金されます。この API を使用する前に、DAS エージェント製品の課金方法と料金を必ずご確認ください。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hdm:GetDasAgentSSE

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

    POST /getDasAgentSSE HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Query

    string

    必須

    DAS エージェントに対する自然言語クエリです。

    Are there any issues or abnormalities with my instance rm-xxx?
    InstanceId

    string

    任意

    このパラメーターは非推奨です。インスタンス ID は Query パラメーターで指定してください。

    rm-xxxx
    SessionId

    string

    任意

    セッション ID は UUID フォーマットである必要があります。このパラメーターはオプションです。セッション ID を指定しない場合、サービスは新しいセッションを作成します。既存の会話を続けるには、後続のリクエストで同じセッション ID を使用してください。

    123e4567-e89b-12d3-a456-xxxxxxxxxxxx
    AgentId

    string

    任意

    使用するエージェントの ID です。このパラメーターはオプションです。このパラメーターを指定しない場合、サービスはデフォルトのエージェントを使用します。DAS エージェントサービスを有効にしたときに生成されたエージェント、または手動で作成したエージェントの ID を指定できます。

    ag-472T0DxtmjIxxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ

    Id

    string

    セッション ID です。これはリクエスト内の SessionId と同じです。

    123e4567-e89b-12d3-a456-xxxxxxxxxxxx
    Answer

    string

    レスポンスのコンテンツです。

    rm-xxxx
    Metadata

    object

    メタデータです。

    Code

    integer

    エラーコードです。例外が発生しない場合、このパラメーターは空になります。

    -1810001
    CharCount

    integer

    レスポンスの文字数です。

    1403
    ToolName

    string

    使用したツールの名前です。

    SqlFilter
    ToolParams

    array

    ツールパラメーターです。

    string

    文字列のリストです。

    ["--instanceId", "rm-*****", "--sqlText", "select~from~das~where~name~das1"]
    RequestId

    string

    リクエスト ID です。

    04930480-9404-50CB-8252-Axxxxxxxx
    Event

    string

    レスポンスメッセージのタイプです。

    列挙値:

    • summary :

      レスポンスの概要です。

    • error :

      エラーメッセージです。

    • agent_message :

      エージェントのレスポンスです。

    summary

    例

    成功レスポンス

    JSONJSON

    {
  "Id": "123e4567-e89b-12d3-a456-xxxxxxxxxxxx",
  "Answer": "rm-xxxx",
  "Metadata": {
    "Code": -1810001,
    "CharCount": 1403,
    "ToolName": "SqlFilter",
    "ToolParams": [
      "[\"--instanceId\", \"rm-*****\", \"--sqlText\", \"select~from~das~where~name~das1\"]"
    ],
    "RequestId": "04930480-9404-50CB-8252-Axxxxxxxx"
  },
  "Event": "summary"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParams The request parameters are invalid.
    500 Timeout The request processing has failed due to timeout.
    403 NoPermission You are not authorized to do this action.
    404 InstanceNotFound Requested instance not found.

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

    変更履歴

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