检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 通过使用态势感知提供的接口,您可以完整的使用态势感知的所有功能,包括产品事件接入、健康检查等接口。 类型 API 说明 事件管理 上报安全产品数据 接入安全产品事件的接口。 产品管理 检查心跳健康 检查安全产品接入健康的接口。
如何调用API 构造请求 认证鉴权 返回结果
API 事件管理 产品管理
历史API 上报安全产品数据(V1)
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
调用说明 态势感知提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
事件管理 上报安全产品数据 父主题: API
此接口为继承态势感知 SA的接口。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
父主题: 历史API
Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 父主题: 如何调用API
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。
产品管理 检查心跳健康 父主题: API
检查心跳健康 功能介绍 SA提供心跳接口,集成产品定时(每五分钟)发送心跳报文到态势感知,用来确认集成产品与态势感知之间的通路是否健康。 此接口为继承态势感知 SA的接口。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。
对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
状态码 正常 返回值 说明 201 成功。 异常 状态码 编码 说明 400 Bad Request 参数错误。 401 Unauthorized 认证失败。 403 Forbidden 拒绝访问。 500 Internal Server Error 系统内部错误。 父主题: 附录
您可以使用本文档提供的API对云上安全态势对进行相关操作,如上报产品数据、检查产品心跳健康等。支持的全部操作请参见API概览。 在调用态势感知API之前,请确保已经充分了解态势感知相关概念,详细信息请参见产品介绍。 父主题: 使用前必读
附录 状态码 错误码 获取项目ID
使用前必读 概述 调用说明 终端节点 基本概念