查询某个具体id的安全态势感知配置详情 - ShowSecurityProfile
功能介绍
应用服务器可调用此接口查询某个具体id的安全态势感知配置详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
iotda:securityprofile:query
Read
instance *
-
g:EnterpriseProjectId
-
g:ResourceTag/<tag-key>
-
-
-
URI
GET /v5/iot/{project_id}/security-profiles/{profile_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明:项目ID。获取方法请参见 获取项目ID。 |
|
profile_id |
是 |
String |
参数说明:安全态势感知配置ID,在创建安全态势感知配置时由物联网平台分配。 取值范围:长度不超过24,数字与字符串的组合。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Instance-Id |
否 |
String |
参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
profile_id |
String |
安全态势感知配置id |
|
security_type |
String |
安全态势感知配置类型 |
|
alarm_level |
String |
参数解释:安全态势感知告警级别。 约束限制:无。 取值范围:
默认取值:不涉及 |
|
security_level |
String |
参数解释:安全态势感知项所属安全风险级别。 约束限制:无。 取值范围:
默认取值:不涉及 |
|
enable |
Boolean |
安全态势感知项是否开启 |
|
profile |
Array of SecurityProfile objects |
安全态势感知项配置结构体,用于设备侧检测项下发给设备 |
|
profile_targets |
SecurityTarget object |
安全态势感知配置绑定对象结构体 |
请求示例
查询指定id的安全态势感知配置详情
GET https://{endpoint}/v5/iot/{project_id}/security-profiles/{profile_id}
响应示例
状态码:200
OK
{
"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" ]
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
404 |
Not Found |
错误码
请参见错误码。