接口介绍
功能介绍
硬盘异常检测定时异步插入推理数据接口,包含对HDD硬盘中SAS盘和SATA盘的数据插入。调用接口插入全量数据,记录时间“update_time”,返回数据插入操作是否成功即可。
URI
在平台首页创建的硬盘异常检测任务界面,查看“API调用”页签中的URI地址。
URI格式示例,如下所示:
https://telcloud.huawei.com/TrainConsoleService/apigw/inference/v1.0/{uuid}?appid={appid}
请求消息头
通过指定请求头中“X-Auth-Token”字段的token值来完成鉴权。token值的获取,请参见获取请求认证。
headers = { "X-Auth-Token": "", "Content-Type": "application/json",
请求消息体
- SATA盘数据的POST请求样例,如下所示:
{ "taskId": 1, "userId": "", "data": [ { "interfacetype": "SATA", "disk_collect_time": "", "disk_pot": "", "disk_model": "", "disk_capacity": "", "disk_media_type": "", "disk_production": "", "disk_data_source": "", "disk_manufacturer": "", "disk_sn": "", "disk_slot": "", "device_sn": "", "disk_firmware_version": "", "disk_failure_status": "", "disk_errorlog_count": "", "disk_selftest_failure_count": "", "disk_phyevent_icrc_count": "", "disk_glist_count": "", "disk_plist_count": "", "disk_criticalevent_count": "", "disk_dha_logic_status": "", "disk_dha_link_status": "", "disk_size": "", "disk_io": "", "collect_type": "", "smart": [ { "id": 1, "raw": 27, "normalized": 73, "worst": 100, "threshold": 16 }, { "id": 2, "raw": 0, "normalized": 100, "worst": 100, "threshold": 16 } ] } ] }
参数说明如表1所示。
表1 参数说明 字段名
字段说明
interfacetype
硬盘的类型。
必填字段,字段类型:varchar
值:SATA。
disk_collect_time
采集时间(年月日时分秒)。
格式(yyyymmdd)至少8位,并可以正常转换时间。
必填字段,字段类型:timestamp
示例:20191114。
disk_pot
硬盘通电小时数。
非必填字段,字段类型:varchar(32),整型。
disk_model
硬盘型号。
非必填字段,字段类型:varchar(42)
字符串+数字长度上限:40(字符串加数字)。
disk_capacity
硬盘容量,单位:GB。
非必填字段,字段类型:integer,允许中间带空格。
disk_media_type
硬盘媒体类型。
非必填字段,字段类型:varchar
支持字符串加数字的形式。
disk_production
硬盘来源。
字段类型:varchar
disk_data_source
硬盘数据源。
必填字段,字段类型:varchar
disk_manufacturer
硬盘厂家信息。
非必填字段,字段类型:varchar(16)
字符串长度上限:40。
disk_sn
磁盘唯一序列号信息。
必填字段,字段类型:varchar(22)
字符串+数字长度上限:40。
disk_slot
磁盘的槽位。
非必填字段,字段类型:varchar(16)
字符串长度上限:40。
device_sn
磁盘所在服务器的序列号
非必填字段,字段类型:varchar(64)
字符串+数字长度上限:40。
disk_firmware_version
固件版本。
非必填字段,字段类型:varchar(16)
字符串+数字长度上限:40。
disk_errorlog_count
Error Log的个数。
非必填字段,字段类型:INT UNSIGNED
数字长度上限:40。
disk_selftest_failure_count
Self-Test Log中自检不通过的个数。“Status”出现“failure”或“failed”字段为自检不通过。
非必填字段,字段类型:INT UNSIGNED
数字长度上限:40。
disk_phyevent_icrc_count
Phy Event Log的ICRC个数。
非必填字段,字段类型:INT UNSIGNED
数字长度上限:20。
disk_glist_count
Grown Defect List的个数。
非必填字段,字段类型:INT UNSIGNED
数字长度上限:20。
disk_plist_count
Pending List的个数。
非必填字段,字段类型:INT UNSIGNED,数字类型。
disk_criticalevent_count
Critical Event Log的个数。
非必填字段,字段类型:INT UNSIGNED,数字类型。
disk_dha_logic_status
硬盘状态。
非必填字段,字段类型:INT,数字类型。
disk_dha_link_status
硬盘链路的状态。
非必填字段,字段类型:INT,数字类型。
disk_io
硬盘的读写速率。
非必填字段,字段类型:INT,数字类型。
collect_type
采集类型。
必填字段,字段类型:varchar。
如果值为 ONLINE,定时推理则采用此数据,如果值为OFFLINE或者空的,则不采用。
smart
硬盘可获得的全部smart的指标。
其中每项指标含义为:
{ "id": 1, # smart属性的编号,id为1即smart1底层数据读取错误率 "raw": 27, # 硬盘smart指标的原始值为27。 "normalized": 73, # 硬盘smart指标的当前值为73。 "worst": 100,# 硬盘smart指标的历史最差值为100。 "threshold": 16 # 硬盘smart指标的门限值为16。 }
所有字段类型:数字类型。各指标数字长度上限:20。
2. SAS盘数据的POST请求样例,如下所示:{ "taskId":1, "userId": "", "data": [{ "interfacetype": "SAS", "disk_collect_time": "", "disk_pot": "", "disk_model": "", "disk_capacity": "", "disk_media_type": "", "disk_production": "", "disk_data_source": "", "disk_manufacturer": "", "disk_sn": "", "disk_slot": "", "device_sn": "", "disk_firmware_version": "", "disk_failure_status": "", "disk_selftest_failure_count ": "", "disk_errorcount_logpage_info ": "", "disk_errorcount_nonmedium_ec ": "", "disk_glist_count ": "", "disk_temperature_current ": "", "disk_temperature_reference ": "", "disk_ie_asc ": "", "disk_ie_ascq ": "", "disk_bms_count ": "", "disk_dha_logic_status ": "", "disk_dha_link_status ": "", "disk_dha_disk_slow ": "", "disk_dha_slow_server_time ": "", "r_ecsd ": "", "r_ecpd ": "", "r_operations ": "", "r_ec ": "", "r_times ": "", "r_processed ": "", "r_uce ": "", "w_ecsd ": "", "w_ecpd ": "", "w_operations ": "", "w_ec ": "", "w_times ": "", "w_processed ": "", "w_uce ": "", "v_ecsd ": "", "v_ecpd ": "", "v_operations ": "", "v_ec ": "", "v_times ": "", "v_processed ": "", "collect_type": "", "v_uce ": "", "dha_log": [{ //以下是sas_dha_log表中的数据,可选字段 "error_type ": "", "lba ": "", "len ": "", "sense_key ": "", "sense_code ": "", "info ": "", "repeat_count ": "", }] } ] }
参数说明如表2所示。表2 参数说明 字段名
字段说明
interfacetype
硬盘的类型。
必填字段,字段类型:Varchar
值:SAS。
disk_collect_time
硬盘数据采集时间(年月日时分秒)。
格式(yyyymmdd)至少8位,并可以正常转换时间。
必填字段,字段类型:Varchar
示例:20191114。
disk_pot
Background Medium Scan Log中的Power on time。
非必填字段,字段类型:varchar(32),浮点型。
disk_model
硬盘型号。
非必填字段,字段类型:varchar(42)
字符串+数字长度上限:40(字符串加数字)。
disk_capacity
硬盘容量。
非必填字段,字段类型:integer,允许中间带空格。
disk_media_type
硬盘媒体类型。
非必填字段,字段类型:varchar
支持字符串加数字的形式。
disk_production
硬盘来源。
字段类型:Varchar
disk_data_source
硬盘数据源。
必填字段,字段类型:varchar
disk_manufacturer
硬盘厂家信息。
非必填字段,字段类型:varchar(16)
字符串长度上限:40。
disk_sn
磁盘唯一序列号。
必填字段,字段类型:varchar(22)
字符串+数字长度上限:40。
disk_slot
磁盘的槽位。
非必填字段,字段类型:varchar(16)
字符串长度上限:40。
device_sn
磁盘所在设备序列号。
非必填字段,字段类型:varchar(64)
字符串+数字长度上限:40。
disk_firmware_version
固件版本。
非必填字段,字段类型:varchar(16)
字符串+数字长度上限:40。
disk_selftest_failure_count
Self-Test Log中自检不通过的个数。“Status”出现“failure”或“failed”字段为自检不通过。
非必填字段,字段类型:INT UNSIGNED
数字长度上限:40。
disk_errorcount_logpage_info
硬盘日志页错误信息。
非必填字段,字段类型:TEXT,字符类型。
disk_errorcount_nonmedium_EC
非介质错误数量。
非必填字段,字段类型:INT UNSIGNED,数字类型。
数字长度上限:12。
disk_glist_count
Grown Defect List个数。
必填字段,字段类型:INT UNSIGNED,数字类型。
数字长度上限:12。
disk_temperature_current
硬盘当前温度。
非必填字段,字段类型:INT UNSIGNED
取值范围:0-150。
disk_temperature_reference
硬盘的参考温度。
非必填字段,字段类型:INT UNSIGNED
取值范围:0-150。
disk_ie_asc
信息异常日志。
非必填字段,字段类型:varchar(16)
取值为字符串加数字。
disk_ie_ascq
信息异常日志。
非必填字段,字段类型:varchar(16)
取值为字符串加数字。
disk_bms_count
后台介质扫描日志的个数。
非必填字段,字段类型:INT UNSIGNED
取值为字符串加数字。
disk_dha_logic_status
硬盘的状态。
非必填字段,字段类型:INT
取值为数字。
disk_dha_link_status
硬盘链路的状态。
非必填字段,字段类型:INT
取值为数字。
disk_dha_disk_slow
慢盘类型。
非必填字段,字段类型:INT
取值为数字。
disk_dha_slow_server_time
每2小时硬盘平均服务时间。
非必填字段,字段类型:DOUBLE
取值为浮点数。
r_ecsd
不带延迟的可恢复错误数(读)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
r_ecpd
可能有延迟的可恢复错误数(读)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
r_operations
使用retry恢复错误总数(读)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
r_ec
错误恢复的总数(读)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
r_times
调用恢复算法的次数(读)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
r_processed
处理字节总数(读)。
必填字段,字段类型:BIGINT
数字长度上限:12。
r_uce
不可恢复错误的总数(读)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
w_ecsd
不带延迟的可恢复错误数(写)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
w_ecpd
可能有延迟的可恢复错误数(写)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
w_operations
使用retry恢复错误总数(写)
必填字段,字段类型:INT UNSIGNED
w_ec
错误恢复的总数(写)
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
w_times
调用恢复算法的次数(写)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
w_processed
处理字节总数(写)。
必填字段,字段类型:BIGINT
数字长度上限:12。
w_uce
不可恢复错误的总数(写)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
v_ecsd
不带延迟的可恢复错误数(校验)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
v_ecpd
可能有延迟的可恢复错误数(校验)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
v_operations
使用retry恢复错误总数(校验)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
v_ec
错误恢复的总数(校验)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
v_times
调用恢复算法的次数(校验)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
v_processed
处理字节总数(校验)。
必填字段,字段类型:BIGINT
数字长度上限:12。
collect_type
采集类型。
必填字段,字段类型:varchar。
如果值为 ONLINE,定时推理则采用此数据,如果值为OFFLINE或者空的,则不采用。
v_uce
不可恢复错误的总数(校验)。
必填字段,字段类型:INT UNSIGNED
数字长度上限:12。
响应
成功响应的样例,如下所示:
//插入成功 { "errorCode": null, "message": "Save the data success.", "success": true } //插入失败 { "errorCode": "23469334.44000.20065", "message": "ultra virus", "success": false }
