查询服务调用情况
更新时间：2024-12-31
接口描述
本接口用于查询服务调用情况。
权限说明
调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：
- 完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限：QianfanReadAccessPolicy
- 只读访问千帆大模型平台预测服务的权限：QianfanServiceReadAccessPolicy
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/service?Action=DescribeServiceMetric HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"serviceId": ["svco-tv***j3za"],
"appId": ["148***575"],
"startTime": "2024-04-23T00:00:00Z",
"endTime": "2024-04-24T23:00:00Z"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值DescribeServiceMetric |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| serviceId | list<string> | 否 | 服务ID，说明： （1）不填写该字段，默认查询全部服务ID （2）可以通过任一方式获取： 方式一：通过调用接口创建服务，返回参数serviceId获取 方式二：通过千帆控制台-在线服务-我的服务页面，点击某服务详情查看，如下图所示：  （3）该接口超时时间大约为5s，查询服务过多，调用接口可能会出错 |
| appId | list<string> | 否 | 应用ID，说明： （1）不填写该字段，默认查询全部应用 （2）通过千帆控制台-在线服务-应用接入页面，查看AppID，如下图所示：  （3）该接口超时时间大约为5s，查询应用过多，调用接口可能会出错 |
| startTime | string | 是 | 查询起始时间，说明： （1）格林威治时间，格式为 2016-04-06T08:23:00Z，精确到分钟，如果填写秒数默认使用00替换 （2）该接口超时时间为5s，时间范围选择太大，调用接口可能会出错 |
| endTime | string | 是 | 查询终止时间，说明： （1）格林威治时间，格式为 2016-04-06T08:23:00Z，精确到分钟，如果填写秒数默认使用59替换 （2）该接口超时时间为5s，时间范围选择太大，调用接口可能会出错 |
| protocolVersion | int | 否 | 服务版本，可选值如下： · 1，默认1 · 2 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| result | object | 请求结果 |
result说明
| 名称 | 类型 | 描述 |
|---|---|---|
| startTime | string | 查询起始时间 |
| endTime | string | 查询终止时间 |
| serviceList | List<servicesItem> | 服务列表 |
serviceItem说明
| 名称 | 类型 | 描述 |
|---|---|---|
| serviceId | string | 服务ID |
| serviceName | string | 服务名 |
| appList | List<appItem> | app列表 |
appItem说明
| 名称 | 类型 | 描述 |
|---|---|---|
| appId | string | appID |
| metrics | object | 监控指标，返回入参指定的指标结果 |
metrics说明
| 名称 | 类型 | 描述 |
|---|---|---|
| inputTokensTotal | float | 输入token数 |
| outputTokensTotal | float | 输出token数 |
| tokensTotal | float | 总token数 |
| succeedCallTotal | int | 调用成功次数 |
| failureCallTotal | int | 调用失败次数 |
| callTotal | int | 调用总次数 |
请求示例
curl --location 'https://qianfan.baidubce.com/v2/service?Action=DescribeServiceMetric' \
--header 'Authorization: bce-auth-v1/047ab241bad24xxx28b1ac/2024-01-10T08:39:09Z/180000/host;x-bce-date/eae9855604cxxxxe03cfcbaff' \
--header 'x-bce-date: 2024-01-10T08:37:40Z' \
--header 'Content-Type: application/json' \
--data '{
"serviceId": ["svco-tv5t4zpkj3za"],
"appId": ["1483416575"],
"startTime": "2024-04-23T00:00:00Z",
"endTime": "2024-04-24T23:00:00Z"
}'响应示例
{
"requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": {
"startTime": "2024-04-23T00:00:00Z",
"endTime": "2024-04-24T23:00:00Z",
"serviceList": [
{
"serviceId": "svco-tvxxxxda",
"serviceName": "sunxxxu0506",
"appList": [
{
"appId": "14xxx75",
"metric": {
"inputTokensTotal": 900,
"outputTokensTotal": 721,
"tokensTotal": 1621,
"succeedCallTotal": 575,
"failureCallTotal": 100,
"callTotal": 675
}
}
]
}
]
}
}错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}更多相关错误码，请查看错误码说明。