
# 分页查询Agent调用情况
#### 功能介绍
分页查询Agent调用情况，展示Agent调用产生的调用次数和Tokens，按日汇总明细数据。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-appstage/appstage_07_0008.html)。
#### URI
POST https://aiae.appstage.myhuaweicloud.com/v1/routes/open/queryAgentInvokeStatistics
#### 请求参数
表1请求Header参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| Authorization | 是    | String | **参数解释：** 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157\*\*\*。API Key获取方法请参见[创建API Key](https://support.huaweicloud.com/usermanual-wiseagent/appstage_04_0704.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表2请求Body参数 
| 参数        | 是否必选 | 参数类型             | 描述                                                                                         |
|:---|:---|:---|:---|
| agentIds  | 否    | Array of strings | **参数解释：** 需要查询的Agent ID的列表。 **约束限制：** 格式为uuid列表，列表数量不超过100。 **取值范围：** 不涉及。 **默认取值：** 不涉及。  |
| startTime | 是    | Number           | **参数解释：** 需要查询的Agent ID的统计开始时间。 **约束限制：** 毫秒级别时间戳。 **取值范围：** 不涉及。 **默认取值：** 目前最多查询近一个月的数据。 |
| endTime   | 是    | Number           | **参数解释：** 需要查询的Agent ID的统计结束时间。 **约束限制：** 毫秒级别时间戳。 **取值范围：** 不涉及。 **默认取值：** 目前最多查询近一个月的数据。 |
| current   | 是    | Integer          | **参数解释：** 当前页号。 **约束限制：** 数字。 **取值范围：** 大于0。 **默认取值：** 1。                                  |
| pageSize  | 是    | Integer          | **参数解释：** 每页数量。 **约束限制：** 数字。 **取值范围：** (0,999\]。 **默认取值：** 10。                            |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数               | 参数类型                                                                                    | 描述                                         |
|:---|:---|:---|
| pageInfos        | [RecordsStatisticsVo] object | **参数解释：** 查询成功时接口返回的分页数据列表。 **取值范围：** 不涉及。 |
| notExistAgentIds | Array of strings                                                                        | **参数解释：** 不存在的Agent ID列表。 **取值范围：** 不涉及。   |
   
 表4RecordsStatisticsVo 
| 参数                 | 参数类型   | 描述                                                                                                              |
|:---|:---|:---|
| id                 | String | **参数解释：** 主键ID。 **取值范围：** 不涉及。                                                                                  |
| agentId            | String | **参数解释：** Agent ID。 **取值范围：** 不涉及。                                                                              |
| userId             | String | **参数解释：** 用户ID。 **取值范围：** 不涉及。                                                                                  |
| agentWorkType      | String | **参数解释：** Agent工作类型。 **取值范围：** 枚举值： - agent_llm：自主规划模式。 - agent_single_workflow：工作流模式。 - agent_operator：复杂任务规划。 |
| invokeCount        | Number | **参数解释：** 调用总次数。 **取值范围：** 不涉及。                                                                                 |
| invokeSucceedCount | Number | **参数解释：** 调用成功次数。 **取值范围：** 不涉及。                                                                                |
| invokeFailedCount  | Number | **参数解释：** 调用失败次数。 **取值范围：** 不涉及。                                                                                |
| promptTokens       | Number | **参数解释：** 提示tokens。 **取值范围：** 不涉及。                                                                              |
| completionTokens   | Number | **参数解释：** 输出tokens。 **取值范围：** 不涉及。                                                                              |
| totalTokens        | Number | **参数解释：** 总tokens。 **取值范围：** 不涉及。                                                                               |
| duration           | Number | **参数解释：** 时延。 **取值范围：** 不涉及。                                                                                    |
| tenantName         | String | **参数解释：** 租户名称。 **取值范围：** 不涉及。                                                                                  |
| statisticsTime     | Number | **参数解释：** 统计时间。 **取值范围：** 不涉及。                                                                                  |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述                             |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。  |
| error_msg  | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 |
   
**状态码：500**
表6响应Body参数 
| 参数         | 参数类型   | 描述                             |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。  |
| error_msg  | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 |
   
#### 请求示例
分页查询Agent调用情况，每页10条，查询第1页。
```
https://xxx.x.x.x:xxxx/v1/routes/open/queryAgentInvokeStatistics
{
  "agentIds" : "[\"362de749046e40de95650fa6b9d677eb\",\"362de749046e40de95650fa6b9d677eb\"]",
  "startTime" : 1740588223000,
  "endTime" : 1740714223000,
  "current" : 1,
  "pageSize" : 10
}
```
#### 响应示例
**状态码：200**
请求响应成功。
```
{
  "data" : {
    "notExistAgentIds" : "[\"362de749046e40de95650fa6b9d677eb\",\"362de749046e40de95650fa6b9d677eb\"]",
    "pageInfos" : {
      "total" : 3,
      "list" : {
        "id" : "149fd3a992c044d7960f15e5c09aa6af",
        "tenant_id" : "9190086000001247361",
        "dept_code" : "d491985550b34b1c901aff363d030c4f",
        "agent_id" : "CFEUYYIX6d",
        "user_id" : "1008600000300604420",
        "agent_work_type" : "agent_llm",
        "invoke_count" : 7,
        "invoke_succeed_count" : 1,
        "invoke_failed_count" : 6,
        "prompt_tokens" : 10,
        "completion_tokens" : 20,
        "total_tokens" : 30,
        "duration" : 398.3,
        "statistics_time" : "2025/02/27 11:33:39"
      }
    }
  }
}
```
**状态码：400**
缺少请求体。
```
{
  "error_code" : "AIAE.00001400",
  "error_msg" : "Request body is missing"
}
```
**状态码：500**
服务器内部错误或三方服务器内部错误。
```
{
  "error_code" : "AIAE.00001500",
  "error_msg" : "Internal Server Error."
}
```
#### 状态码
| 状态码 | 描述                 |
|:---|:---|
| 200 | 请求响应成功。            |
| 400 | 缺少请求体。             |
| 500 | 服务器内部错误或三方服务器内部错误。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-appstage/ErrorCode.html)。
