Obtaining the Security Policy List

This API is used to obtain security policy configurations in a project.

For details, see Calling APIs.

GET /v1/{project_id}/security-policies

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Unique project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records on each page.
name	No	String	Policy name (for filtering).
offset	No	Integer	Pagination offset.
type	No	String	Policy type, which can be GDE (database encryption), GDE_DECRYPT (database decryption), DOM (database O&M), DBSS (DBSS service), DDM (dynamic database masking), or SDM (static database masking).

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
policy_list	Array of PolicyResponse objects	Policy information list.
total	Long	Total number of policies.

**Table 4** PolicyResponse
Parameter	Type	Description
dbss_policy	DbssPolicy object	Database audit policy.
ddm_config	DdmConfig object	Dynamic data masking policy.
ddm_policy_list	Array of DdmPolicy objects	array
dom_config	DomConfig object	Database O&M policy (not supported currently).
dom_policy	DomPolicy object	Database O&M policy information.
enabled	Boolean	Whether a policy is enabled.
gde_config	GdeConfig object	Database encryption policy.
gde_policy	GdePolicy object	Encryption policy.
id	Long	Policy ID.
name	String	Policy name.
related_datasource_id	String	ID of the data source associated with the policy.
related_datasource_name	String	Name of the data source associated with the policy.
related_datasource_type	String	Type of the data source associated with the policy.
related_instance_id	String	ID of the instance that executes the policy.
related_instance_name	String	Name of the instance that executes the policy.
related_instance_type	String	Type of the instance that executes the policy.
resource	ResourceInfo object	Data source information.
status	String	Policy status.
type	String	Policy type.
update_time	Long	Policy update time.

**Table 5** DbssPolicy
Parameter	Type	Description
data_mask	Boolean	Privacy data masking.
show_result	Boolean	Whether to display the result set.

**Table 6** DdmConfig
Parameter	Type	Description
proxy_port	Integer	Agent port.
zk_election_port	Integer	User-defined ZooKeeper election port, which is available only for big data (HBase and Hive).
zk_port	Integer	User-defined ZooKeeper port, which is available only for big data (HBase and Hive).

**Table 7** DdmPolicy
Parameter	Type	Description
columns	Array of Column objects	Columns configured for the policy.
namespace	String	Namespace name.
table	String	Table name.

**Table 8** DomConfig
Parameter	Type	Description
deploy_mode	String	Deployment mode.

**Table 9** DomPolicy
Parameter	Type	Description
custom_policy	Boolean	Whether to use a custom policy.
data_audit	Boolean	Whether to perform data audit.
default_action	String	Default action of a policy, such as pass, block, and audit.
intelligent_protection_baseline	Boolean	Whether to enable the intelligent protection baseline.
virtual_patch	Boolean	Whether to use virtual patches.

**Table 10** GdeConfig
Parameter	Type	Description
enc_mode	Integer	Encryption mode. 1: encryption, 2: decryption.
proxy_port	Integer	Agent port.

**Table 11** GdePolicy
Parameter	Type	Description
action	Integer	1: encryption, 2: decryption.
alg	String	Encryption algorithm, which can be sm4, aes-128, or aes-256.
columns	Array of Column objects	Column information to be encrypted.
table	String	Table name.

**Table 12** Column
Parameter	Type	Description
mask	Integer	Masking algorithm name or ID.
name	String	Column name.

None

None

Status Code	Description
200	Query result.
401	Unauthorized. The user is not logged in or the token is invalid.
403	Unauthorized to access the resource.
404	The specified project does not exist.