检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 通过使用态势感知提供的接口,您可以完整的使用态势感知的所有功能,包括产品事件接入、健康检查等接口。 类型 API 说明 事件管理 上报安全产品数据 接入安全产品事件的接口。 产品管理 检查心跳健康 检查安全产品接入健康的接口。
API 事件管理 产品管理
历史API 上报安全产品数据(V1)
如何调用API 构造请求 认证鉴权 返回结果
上报安全产品数据 功能介绍 批量数据上报,每批次最多不超过50条。 此接口为继承态势感知 SA的接口。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v
检查心跳健康 功能介绍 SA提供心跳接口,集成产品定时(每五分钟)发送心跳报文到态势感知,用来确认集成产品与态势感知之间的通路是否健康。 此接口为继承态势感知 SA的接口。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SD
产品管理 检查心跳健康 父主题: API
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-tok
事件管理 上报安全产品数据 父主题: API
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scop
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:2097152 X-Language 否 String 最小长度:2
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https:
附录 状态码 错误码 获取项目ID
使用前必读 概述 调用说明 终端节点 基本概念
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 sa.00000001 Bad Request 参数错误 请检查请求参数 401 sa.00000012 Unauthorized 无效的用户TOKEN
调用说明 态势感知提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
行分类统计和综合分析,为用户呈现出全局安全攻击态势。 您可以使用本文档提供的API对云上安全态势对进行相关操作,如上报产品数据、检查产品心跳健康等。支持的全部操作请参见API概览。 在调用态势感知API之前,请确保已经充分了解态势感知相关概念,详细信息请参见产品介绍。 父主题: 使用前必读
由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块
状态码 正常 返回值 说明 201 成功。 异常 状态码 编码 说明 400 Bad Request 参数错误。 401 Unauthorized 认证失败。 403 Forbidden 拒绝访问。 500 Internal Server Error 系统内部错误。 父主题: 附录