获取服务错误码时间分布统计信息
功能介绍
获取服务错误码时间分布统计信息接口用于展现服务的错误码统计时间分布信息。仅保存30天内的统计数据。
接口约束
- 区域限制:仅支持西南-贵阳一区域。
- API流量限制:所有用户对该API的总请求次数上限,20秒内不超过80次。
- 用户流量限制:单个用户对该API的请求次数上限,20秒内不超过1次。
- 限流响应:超出限流阈值时,API将返回HTTP 429状态码(Too Many Requests)。
- 重试建议:遇到限流时,建议等待20秒后重试。
URI
POST /v1/{project_id}/maas/monitoring/{service_id}/error-code-chart
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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的值)。获取方式请参见认证鉴权。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
service_type |
是 |
Integer |
参数解释:服务类型。 约束限制:不涉及。 取值范围:枚举类型,取值如下:
默认取值:不涉及。 |
|
api_keys |
否 |
Array of strings |
参数解释:API Key列表,根据传入的API Key列表筛选。 Maas的服务支持API Key调用和在线体验两种方式。请参见管理API Key和MaaS在线体验。
约束限制:不涉及。 取值范围: 传入的API Key需满足长度 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 |
参数解释:服务的推理类型。 取值范围:枚举类型,取值如下:
约束限制:不涉及。 默认取值:不涉及。 |
|
error_code_type |
否 |
String |
参数解释:错误码类型。 约束限制:不涉及。 取值范围:取值如下:
·为空字符串或者不传:以4开头错误码和以5开头错误码都展示。 默认取值:不涉及。 |
|
time_granularity |
是 |
Integer |
参数解释:时间粒度。 约束限制:时间范围(开始时间和结束时间间隔)与时间精度需满足如下规则:
取值范围:枚举类型,取值为1~3的整数:
默认取值:不涉及。 |
|
version_id |
否 |
String |
参数解释:服务版本ID,根据传入的版本ID筛选;不传则查找所有版本的数据。可以使用查询服务版本调用数据接口查询服务的版本ID。 约束限制:不涉及。 取值范围:长度 1-128 字符,仅支持大小写字母、数字、下划线 (_)、短横线 (-)。 默认取值:不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释:总错误数。 取值范围:不涉及。 |
|
count |
Integer |
参数解释:总错误数。 取值范围:不涉及。 |
|
list_4xx |
Array of ErrorCodeCount objects |
参数解释:4xx错误详情列表。 取值范围:不涉及。 |
|
list_5xx |
Array of ErrorCodeCount objects |
参数解释:5xx错误详情列表。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:4xx或5xx类错误码下具体的错误码。 取值范围:具体错误码取值范围如下:
|
|
list |
Array of TimestampErrorCnt objects |
参数解释:具体错误码在各时间段的次数列表,包含毫秒时间戳和对应时间的错误次数。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
time |
Long |
参数解释:毫秒时间戳。 取值范围:不涉及。 |
|
count |
Long |
参数解释:该时间段错误码数量。 取值范围:不涉及。 |
状态码:400
请求示例
查询服务ID为4f6d50ec-0e80-4ea0-983b-d0ad1ede7596,版本ID为ac73463d-4453-4d62-a3d9-31b627a116b1的预置服务14天内在线推理文本生成的指标数据信息。
/v1/{{project_id}}/maas/monitoring/4f6d50ec-0e80-4ea0-983b-d0ad1ede7596/error-code-chart
{
"service_type" : 2,
"start_time" : 1768406400000,
"end_time" : 1769532163224,
"timezone" : "Asia/Shanghai",
"time_granularity" : 3,
"infer_type" : "real_time"
}
响应示例
状态码:200
成功响应。
{
"total" : 2,
"count" : 2,
"list_4xx" : [ {
"error_code" : "400",
"list" : [ {
"time" : 1768406400000,
"count" : 2
}, {
"time" : 1768492800000,
"count" : 0
}, {
"time" : 1768579200000,
"count" : 0
}, {
"time" : 1768665600000,
"count" : 0
}, {
"time" : 1768752000000,
"count" : 0
}, {
"time" : 1768838400000,
"count" : 0
}, {
"time" : 1768924800000,
"count" : 0
}, {
"time" : 1769011200000,
"count" : 0
}, {
"time" : 1769097600000,
"count" : 0
}, {
"time" : 1769184000000,
"count" : 0
}, {
"time" : 1769270400000,
"count" : 0
}, {
"time" : 1769356800000,
"count" : 0
}, {
"time" : 1769443200000,
"count" : 0
}, {
"time" : 1769529600000,
"count" : 0
} ]
} ],
"list_5xx" : [ {
"error_code" : "500",
"list" : [ ]
} ]
}
状态码:400
失败响应。
{
"error_msg" : "The project ID in the request does not match that in the token.",
"error_code" : "ModelArts.0210"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功响应。 |
|
400 |
失败响应。 |
错误码
请参见错误码。