Query Security Situation Awareness Configurations

Function

This API is used by an application to query the list of security situation awareness configurations.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iotda:securityprofile:queryList	List	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
security_type	No	String	Parameter description: name of the security situation awareness configuration item.
target_type	No	String	Parameter description: type of the resource to be bound. Currently, only products are supported.
target_id	No	String	Parameter description: ID of the resource to be bound. This parameter must be used together with target_type. If target_type is set to PRODUCT, the format of target_id is Resource space ID:Product ID.
limit	No	Integer	Parameter description: number of records to display on each page. Value: The value is an integer ranging from 1 to 50. The default value is 10.
marker	No	String	Parameter description: ID of the last record in the previous query. The value is returned by the platform during the previous query. Records are queried in descending order of record IDs (the marker value). A newer record will have a larger ID. If marker is specified, only the records whose IDs are smaller than marker are queried. If marker is not specified, the query starts from the record with the largest ID, that is, the latest record. If all data needs to be queried in sequence, this parameter must be filled with the value of marker returned in the last query response each time. Value: The value must contain 24 hexadecimal characters. The default value is ffffffffffffffffffffffff.
offset	No	Integer	Parameter description: If offset is set to N, the query starts from the N+1 record after the last record in the previous query. If offset is set to 0, the output starts from the first record after the last record in the previous query. To ensure API performance, you can use this parameter together with marker to turn pages. For example, if there are 50 records on each page, you can directly specify offset to jump to the specified page within page 1 and 11. If you want to view records displayed on pages 12 to 22, you need to use the marker value returned on page 11 as the marker value for the next query. Value: The value is an integer ranging from 0 to 500. The default value is 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Instance-Id	No	String	Parameter description: instance ID. This parameter is required only when the API is called from the management plane in the physical multi-tenant scenario. Log in to the IoTDA console and choose Overview in the navigation pane to check the instance ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
security_profiles	Array of SecurityProfileDTO objects	Security situation awareness configuration information list.
page	Page object	Structure of the batch query result pagination. It defines page numbers, the number of records on each page, the total number of records, and ID of the last record on the current page.

**Table 5** SecurityProfileDTO
Parameter	Type	Description
profile_id	String	Security situation awareness configuration ID.
security_type	String	Security situation awareness configuration type.
alarm_level	String	Parameter description: severity of a security situation awareness alarm. Constraints: none. Range: CRITICAL MAJOR MINOR Default value: N/A
security_level	String	Parameter description: severity of a security situation awareness item. Constraints: none. Range: BASIC_SECURITY ADVANCE_SECURITY ULTIMATE_SECURITY Default value: N/A
enable	Boolean	Whether security situation awareness is enabled.
profile	Array of SecurityProfile objects	Security situation awareness configuration structure, which is used to deliver device-side detection items to the device.
profile_targets	SecurityTarget object	Structure of binding objects for security situation awareness configuration.

**Table 6** SecurityProfile
Parameter	Type	Description
key	String	Name of the security situation awareness item.
value	Object	Configuration value of the security situation awareness item. For details about the data format, see the description of the API for creating security situation awareness.

**Table 7** SecurityTarget
Parameter	Type	Description
target_type	String	Object bound to the security situation awareness configuration. Currently, only the product level is supported, and only the device-level security situation awareness items take effect.
target_ids	Array of strings	List of bound object IDs. When target_type is set to PRODUCT, the product ID can be duplicate in different resource spaces. The value of target_id is in the format of Resource space ID:Product ID. The resource space ID and product ID are combined using a colon (:).

**Table 8** Page
Parameter	Type	Description
count	Long	Total number of records that meet the filter criteria.
marker	String	ID of the last record in this query, which can be used in the next query.

Example Requests

Queries the list of security situation awareness configurations of a specified security type for a tenant.

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

Example Responses

Status code: 200

{
  "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"
  }
}