接口功能介绍
服务器安全卫士系统,服务器安全卫士数据导出任务更新接口
接口约束
签约服务器安全卫士
URI
POST /v1/api/security/data/updateTask
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
userid | 是 | String | 用户id | 3416ab34d51e43bd97bc32b23ffbb443 | |
accountid | 是 | String | 账户id | 9e471e00e1c6485192b4478c96a14254 | |
regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
accessKey | 是 | String | 鉴权公钥(安全卫士系统提供) | 18ee9b6b63e411e8b4a7186590d96509 | |
contentMD5 | 是 | String | 参数MD5值。默认使用空字符("")计算 | 1B2M2Y8AsgTpgAmY7PhCfg== | |
requestDate | 是 | String | 请求时间 | Mon, 29 Aug 2022 00:59:26 UTC | |
hmac | 是 | String | 使用HMAC算法生成信息摘要。HMAC原始信息中需要的字段:使用HMAC加密是,需要密钥和待加密消息。 1.密钥使用接口方提供的secretKey,作为加密密钥。 2.待加密消息:contentMD5、requestDate 、servicePath;三个部分通过""进行连接。连接顺序contentMD5requestDateservicePath: | mTOyK30c+4Poit2857iXCb8N7Qc= | |
urlType | 否 | String | 请求地址类型。EOPAPI(默认),CTAPI,API | EOPAPI |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
exportTaskId | 是 | String | 导出任务id | ||
showStatus | 是 | String | 展示状态; DISPLAY-展示 NO_DISPLAY-临时不展示 FINISHED-完成,之后不再展示 |
DISPLAY |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 200-成功 | ||
error | String | 返回码 CTCSSCN_000000 :成功; CTCSSCN_000001:失败; CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用; CTCSSCN_000004:鉴权错误; CTCSSCN_000005:用户没有付费版配额,功能不可用 |
CTCSSCN_000000 | |
message | String | 返回信息 | 成功 | |
returnObj | Object | 返回对象 | ||
code | String | 返回码 取值范围: 0 成功 -1:失败 -3:用户未签署协议,安全卫士系统无法正常使用 -4:鉴权错误 -5:用户没有付费版配额,功能不可用 |
0 | |
data | Object | 返回对象 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"userid": "3416ab34d51e43bd97bc32b23ffbb443",
"accountid": "9e471e00e1c6485192b4478c96a14254",
"regionid": "100054c0416811e9a6690242ac110002",
"accessKey": "18ee9b6b63e411e8b4a7186590d96509",
"contentMD5": "1B2M2Y8AsgTpgAmY7PhCfg==",
"hmac": "mTOyK30c+4Poit2857iXCb8N7Qc=",
"requestDate": "Mon, 29 Aug 2022 00:59:26 UTC"
}
请求体body
{
"exportTaskId":"aaa",
"showStatus":"DISPLAY/NO_DISPLAY"
}
响应示例
{
"statusCode": "200",
"error": "CTCSSCN_000000",
"message": "查询成功!",
"returnObj":{
}
}
状态码
请参考 状态码
错误码
请参考 错误码