カスタムエージェントのページネーション付きリストを取得します。
操作説明
リクエスト
-
検索キーワード:
Qパラメーターを使用して、エージェント名による曖昧検索を実行します。 -
可視性レベルによるフィルタリング:
Visibilityパラメーターを使用して、TENANT、PROJECT、USERなどの可視性レベルで結果をフィルタリングします。 -
ページネーション情報:
MaxResultsおよびNextTokenパラメーターを使用してページネーションクエリを実装します。NextTokenは次のページの結果を取得します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| MaxResults |
integer |
任意 |
1ページに返されるエントリの最大数。 |
20 |
| NextToken |
string |
任意 |
ページネーショントークン。最初のリクエストではこのパラメーターを省略します。以降のリクエストでは、次のページを取得するために前回のレスポンスの |
12345 |
| Q |
string |
任意 |
エージェント名による曖昧一致検索のキーワード。 |
analysis |
| Visibility |
array |
任意 |
可視性レベルで結果をフィルタリングします。複数のレベルを指定できます。 |
- |
|
string |
任意 |
可視性レベル。 |
TENANT |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| RequestId |
string |
リクエスト ID。 |
824F80BA-1778-5D8A-BAFF-668A4D9C4CC7 |
| PagingInfo |
object |
ページネーション情報。 |
|
| TotalCount |
integer |
フィルター条件に一致するエントリの総数。 |
100 |
| MaxResults |
integer |
このレスポンスで返されるエントリの最大数。 |
20 |
| NextToken |
string |
次のページの結果を取得するためのトークン。返す結果がそれ以上ない場合、このパラメーターは空になります。 |
5 |
| Agents |
array<object> |
カスタムエージェントのリスト。 |
|
|
object |
カスタムエージェント。 |
||
| Name |
string |
my-agent |
|
| DisplayName |
string |
我的助手 |
|
| Description |
string |
数据分析助手 |
|
| CreatorId |
string |
123456 |
|
| ModifierId |
string |
123456 |
|
| Visibility |
string |
TENANT |
|
| GmtCreateTime |
string |
1780555634000 |
|
| GmtModifiedTime |
string |
1780555634000 |
例
成功レスポンス
JSONJSON
{
"RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
"PagingInfo": {
"TotalCount": 100,
"MaxResults": 20,
"NextToken": "5",
"Agents": [
{
"Name": "my-agent",
"DisplayName": "我的助手",
"Description": "数据分析助手",
"CreatorId": "123456",
"ModifierId": "123456",
"Visibility": "TENANT",
"GmtCreateTime": "1780555634000",
"GmtModifiedTime": "1780555634000"
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。