文档首页/ 设备接入 IoTDA/ API参考/ 应用侧API参考/ API/ 安全态势感知配置管理/ 查询安全态势感知配置信息列表
更新时间：2025-09-19 GMT+08:00
查看PDF
分享

查询安全态势感知配置信息列表

功能介绍

接口说明：应用服务器调用该接口查询安全态势感知配置列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v5/iot/{project_id}/security-profiles

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数说明：项目ID。获取方法请参见 获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

security_type

否

String

参数说明：具体安全态势感知配置项名称。

target_type

否

String

参数说明：绑定资源类型，当前仅支持产品。

target_id

否

String

参数说明：绑定资源ID。必须配合target_type一起使用，target_type为PRODUCT时，target_id格式为:资源空间ID:产品ID

limit

否

Integer

参数说明：分页查询时每页显示的记录数。

取值范围：1-50的整数，默认值为10。

marker

否

String

参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。

取值范围：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。

offset

否

Integer

参数说明：表示从marker后偏移offset条记录开始查询。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。

取值范围：0-500的整数，默认为0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

否

String

参数说明：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

security_profiles

Array of SecurityProfileDTO objects

安全态势感知配置信息列表。

page

Page object

查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大Id。
表5 SecurityProfileDTO

参数

参数类型

描述

profile_id

String

安全态势感知配置id

security_type

String

安全态势感知配置类型

alarm_level

String

参数解释：安全态势感知告警级别。

约束限制：无。

取值范围：

  • CRITICAL: 严重告警。

  • MAJOR：重要告警。

  • MINOR：一般告警。

默认取值：不涉及

security_level

String

参数解释：安全态势感知项所属安全风险级别。

约束限制：无。

取值范围：

  • BASIC_SECURITY: 基础安全。

  • ADVANCE_SECURITY：高级安全。

  • ULTIMATE_SECURITY：极致安全。

默认取值：不涉及

enable

Boolean

安全态势感知项是否开启

profile

Array of SecurityProfile objects

安全态势感知项配置结构体，用于设备侧检测项下发给设备

profile_targets

SecurityTarget object

安全态势感知配置绑定对象结构体
表6 SecurityProfile

参数

参数类型

描述

key

String

安全态势感知项配置值名称

value

Object

安全态势感知项配置值，数据格式参考创建安全态势感知接口说明
表7 SecurityTarget

参数

参数类型

描述

target_type

String

安全态势感知配置绑定的对象，目前仅支持PRODUCT产品级别，仅对设备级别的安全态势感知项生效。

target_ids

Array of strings

绑定对象的id列表，当target_type为PRODUCT时，由于产品ID在不同资源空间下可以重复，target_id格式为：资源空间ID:产品ID；资源空间ID与产品ID使用冒号拼接而成。
表8 Page

参数

参数类型

描述

count

Long

满足查询条件的记录总数。

marker

String

本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。

请求示例

查询租户下指定security_type类型的安全态势感知配置列表

GET https://{endpoint}/v5/iot/{project_id}/security-profiles?security_type={security_type}

响应示例

状态码：200

OK

{
  "security_profiles" : [ {
    "profile_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
    "security_type" : "DEVICE_MEMORY_CHECK",
    "alarm_level" : "CRITICAL",
    "security_level" : "BASIC_SECURITY",
    "enable" : true,
    "profile" : [ {
      "key" : "memory_threshold",
      "value" : 80
    } ],
    "profile_targets" : {
      "target_type" : "PRODUCT",
      "target_ids" : [ "1d7616926636486cb05120018018cafc:67443bd4ad7db3647deb4f7a" ]
    }
  } ],
  "page" : {
    "count" : 10,
    "marker" : "5c90fa7d3c4e4405e8525079"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。