获取服务错误明细列表
功能介绍
获取服务错误明细列表接口用于获取服务的错误明细数据,查看调用失败的相关信息,如错误码、发生次数、错误信息等。仅保存30天内的统计数据。
接口约束
- 区域限制:仅支持西南-贵阳一区域。
- API流量限制:所有用户对该API的总请求次数上限,1分钟内不超过1000次。
- 用户流量限制:单个用户对该API的请求次数上限,1分钟内不超过200次。
- 限流响应:超出限流阈值时,API将返回HTTP 429状态码(Too Many Requests)。
- 重试建议:遇到限流时,建议等待60秒后重试。
URI
POST /v1/{project_id}/maas/monitoring/{service_id}/list-errors
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释:项目ID。关于如何获取项目ID,请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:只能由小写英文字母和数字组成,长度32字符。 默认取值:不涉及。 |
|
service_id |
是 |
String |
参数解释:待查询的服务ID列表服务,根据传入的服务ID列表筛选;不传则所有服务ID对应的服务名称。服务ID在创建服务时即可在返回体中获取,也可通过获取服务列表接口获取当前用户拥有的服务,其中service_id字段即为服务ID。 约束限制:不涉及。 取值范围:每个服务ID长度 1-128 字符,仅支持大小写字母、数字、下划线 (_)、短横线 (-)。 默认取值:不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释:用户Token。通过调用IAM服务的获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取方式请参见认证鉴权。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
Accept-Language |
否 |
String |
参数解释:用于指定期望的响应内容语言类型,服务端可根据该参数返回对应语言的信息或数据。 约束限制:语言代码-地区代码,示例:zh(中文)、en-US(英语 - 美国),支持多语言优先级,用英文逗号分隔,可搭配q参数(0~1,默认 1)指定权重,示例:Accept-Language:zh-CN,en-US;q=0.9。 取值范围:不涉及(客户端传递标准语言标签即可,如zh-CN、en-US)。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
service_type |
是 |
Integer |
参数解释:服务类型。 约束限制:不涉及。 取值范围:枚举类型,取值如下:
默认取值:不涉及。 |
|
api_keys |
否 |
Array of strings |
参数解释:API Key列表,根据传入的API Key列表筛选。 Maas的服务支持API Key调用和在线体验两种方式。请参见管理API Key和MaaS在线体验。
约束限制:不涉及。 取值范围: 传入的API Key需满足长度 1-128 字符,仅支持大小写字母、数字、下划线 (_)、短横线 (-)。 默认取值:不涉及。 |
|
version_id |
否 |
String |
参数解释:服务版本ID,不传则查找服务所有版本下的数据。可以根据查询服务版本调用数据接口查询服务的版本ID。 约束限制:不涉及。 取值范围:长度 1-128 字符,仅支持大小写字母、数字、下划线 (_)、短横线 (-)。 默认取值:不涉及。 |
|
ips |
否 |
Array of strings |
参数解释:IP地址列表,指已产生调用量的客户端源IP地址,不传则查询用户全部IP地址下的数据。可使用查询IP列表接口查询IP地址。 约束限制:需符合IP地址格式。 取值范围:不涉及。 默认取值:不涉及。 |
|
start_time |
是 |
Long |
参数解释:开始时间,毫秒时间戳。 约束限制:结束时间与开始时间相差不超过30天。 取值范围:数值大于0,小于等于end_time的取值。 默认取值:不涉及。 |
|
end_time |
是 |
Long |
参数解释:结束时间,毫秒时间戳。 约束限制:结束时间与开始时间相差不超过30天。 取值范围:数值大于0。 默认取值:不涉及。 |
|
timezone |
否 |
String |
参数解释:时区。 约束限制:不涉及。 取值范围:遵循IANA时区规范(如Asia/Shanghai、UTC)。 默认取值:Asia/Shanghai(东八区)。 |
|
infer_type |
是 |
String |
参数解释:服务的推理类型。 取值范围:枚举类型,取值如下:
约束限制:不涉及。 默认取值:不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释:错误码种类,4xx和5xx。 取值范围:固定为2。 |
|
count |
Integer |
参数解释:错误码种类,4xx和5xx。 取值范围:固定为2。 |
|
items |
Array of ErrorsStatisticsItem objects |
参数解释:错误码详细信息列表。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:错误码。 取值范围:4xx或 5xx。 |
|
error_count |
Integer |
参数解释:错误次数。 取值范围:不涉及。 |
|
ratio |
Double |
参数解释:该错误码发生次数占全部错误次数的比例。 取值范围:0-1。 |
|
error_desc |
String |
参数解释:错误描述 取值范围:不涉及。 |
|
details |
Array of ErrorsStatisticsItem objects |
参数解释:4xx/5xx类错误码下具体错误码的信息,包含具体错误码、错误次数、错误占比、错误描述。 取值范围:具体错误码取值范围如下
|
状态码:400
请求示例
查询服务ID为69fefc89-7d71-4936-bf4d-c0c33616558d、版本ID为943cb312-2dac-4402-b9a9-d99de4861cb2、服务类型为我的服务的14天内在线推理的错误明细数据。
/v1/{{project_id}}/maas/monitoring/69fefc89-7d71-4936-bf4d-c0c33616558d/list-errors
{
"service_type" : 2,
"start_time" : 1768320000000,
"end_time" : 1769523118705,
"timezone" : "Asia/Shanghai",
"version_id" : "943cb312-2dac-4402-b9a9-d99de4861cb2",
"infer_type" : "real_time"
}
响应示例
状态码:200
成功响应。
{
"total" : 2,
"count" : 2,
"items" : [ {
"error_code" : "4xx",
"error_count" : 0,
"ratio" : 0,
"error_desc" : "客户端错误(Client Errors):表示请求本身存在问题(如格式错误、权限不足等),问题一般出现在客户端。",
"details" : [ ]
}, {
"error_code" : "5xx",
"error_count" : 20,
"ratio" : 1,
"error_desc" : "服务器错误(Server Errors):表示服务器处理请求时发生内部错误,问题一般出现在服务端。",
"details" : [ {
"error_code" : "500",
"error_count" : 20,
"ratio" : 1,
"error_desc" : "服务端发生未知错误。",
"details" : [ ]
} ]
} ]
}
状态码:400
失败响应。
{
"error_code" : "ModelArts.0104",
"error_msg" : "参数无效,问题:结束时间不能早于开始时间。"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功响应。 |
|
400 |
失败响应。 |
错误码
请参见错误码。