すべてのプロダクト
Search

このプロダクト

    :QueryCopilotEmbedConfig

    ドキュメントセンター

    :QueryCopilotEmbedConfig

    最終更新日:Dec 24, 2025

    XiaoQ 埋め込みを有効化するための構成リストを取得します

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    quickbi-public:QueryCopilotEmbedConfig

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Keyword

    string

    任意

    埋め込み構成モジュールの名前。あいまい検索をサポートします。

    06-ELive

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ

    RequestId

    string

    リクエスト ID。

    1FC71085-D5FD-08E0-813A-4D4BD1031BC5
    Success

    boolean

    リクエストが成功したかどうかを示します。指定可能な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    Result

    array<object>

    埋め込み構成のリスト。

    array<object>

    埋め込み構成オブジェクト。

    AgentName

    string

    ロボットのニックネーム。

    小Q
    CopilotId

    string

    埋め込み ID。

    9c079710-ddbe-48b3-b495-7c83c8d57cc4
    CreateUser

    string

    作成者の ID。

    qweqw12312423521
    CreateUserName

    string

    作成者のニックネーム。

    诸葛
    DataRange

    object

    データ範囲 (分析テーマと質問リソース)。

    AllCube

    boolean

    すべての質問リソースが選択されているかどうか。

    true/false
    AllTheme

    boolean

    すべての分析テーマが選択されているかどうか。

    true/false
    LlmCubes

    array

    質問リソース ID のコレクション。

    string

    質問リソース ID。

    123124,1231241
    Themes

    array

    分析テーマ ID のコレクション。

    string

    分析テーマ ID。

    123124,1231241
    ModifyUser

    string

    変更者の ID。

    asda1231231dfs
    ModuleName

    string

    モジュール名。

    小Q
    ShowName

    string

    埋め込みモジュールの名前。

    0327

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1FC71085-D5FD-08E0-813A-4D4BD1031BC5",
  "Success": true,
  "Result": [
    {
      "AgentName": "小Q",
      "CopilotId": "9c079710-ddbe-48b3-b495-7c83c8d57cc4",
      "CreateUser": "qweqw12312423521",
      "CreateUserName": "诸葛",
      "DataRange": {
        "AllCube": true,
        "AllTheme": true,
        "LlmCubes": [
          "123124,1231241"
        ],
        "Themes": [
          "123124,1231241"
        ]
      },
      "ModifyUser": "asda1231231dfs",
      "ModuleName": "小Q",
      "ShowName": "0327"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 UserRoleConfig.NotContain.Function The user %s does not have permission to operate.

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

    変更履歴

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