ModifyCopilotEmbedConfig - - Alibaba Cloud ドキュメントセンター

今すぐお試しください

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

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CopilotId	string	必須	埋め込み ID。	ccd3428c-dd2xxxxxxxxxxxxdffee
DataRange	string	任意	データ範囲。重要パラメーターの型は JSON 文字列です。分析テーマとクエリリソースの切り替えは、どちらか一方のみ有効です。すべて選択のスイッチが true の場合、それが優先されます。1 つのパラメーターのみを渡すことを推奨します。列挙値: themes : 分析テーマ allTheme : すべての分析テーマ llmCubes : クエリリソース allCube : すべてのクエリリソース	如果客户要授权所有分析主题，则 {allTheme: true} 如果客户要授权所有问数资源，则 {allCube: true} 如果客户要授权部分问数资源，则 {llmCubes: [12314,12345]} 如果客户要授权部分分析主题，则 {themes: [12314,12345]}
ModuleName	string	任意	モジュール名。	小Q
AgentName	string	任意	エージェントのニックネーム。	小Q

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	4BAA4694-CC27-555F-B15A-688AA9289FEE
Success	boolean	リクエストが成功したかどうかを示します。有効値： true：リクエストは成功しました false：リクエストは失敗しました	true
Result	boolean	API の実行結果を返します。有効値： true：実行は成功しました false：実行は失敗しました	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "4BAA4694-CC27-555F-B15A-688AA9289FEE",
  "Success": true,
  "Result": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.
400	Copilot.Modulename.Error	ModuleName max length limit 20.
400	Copilot.AgentName.Error	AgentName max length limit 10.
400	Invalid.Parameter.Error	The parameter is invalid:%s.
400	CopilotEmbed.Config.NotFind	Can not find copilot embed config with this copilot ID.

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

変更履歴

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