查询策略列表 - ListSecurityPolicies
功能介绍
功能介绍:查询策略列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/devices/security-policies
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 否 | String | 参数解释: 安全策略类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| name | 否 | String | 参数解释: 资源ID,唯一标识 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 分页偏移 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 每页数量限制 约束限制: 不涉及 取值范围: 不涉及 默认取值: 10 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Long | 参数解释: 总记录数 取值范围: 不涉及 |
| policy_list | Array of DevicePolicyDetail objects | 参数解释: 策略列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| name | String | 参数解释: 安全策略名称 取值范围: 不涉及 |
| type | String | 参数解释: 安全策略类型 取值范围: |
| related_device_id | String | 参数解释: 设备策略详情ID 取值范围: 不涉及 |
| related_device_name | String | 参数解释: 设备策略详情名称 取值范围: 不涉及 |
| related_device_type | Integer | 参数解释: 设备策略详情类型 取值范围: 不涉及 |
| related_datasource_id | String | 参数解释: 设备策略详情ID 取值范围: 不涉及 |
| related_datasource_name | String | 参数解释: 设备策略详情名称 取值范围: 不涉及 |
| related_datasource_type | String | 参数解释: 设备策略详情类型 取值范围: 不涉及 |
| target_datasource_id | String | 参数解释: 设备策略详情ID 取值范围: 不涉及 |
| target_datasource_name | String | 参数解释: 设备策略详情名称 取值范围: 不涉及 |
| target_datasource_type | String | 参数解释: 设备策略详情类型 取值范围: 不涉及 |
| enabled | Boolean | 参数解释: 已启用 取值范围: true-是,false-否 |
| status | String | 参数解释: 操作结果状态 取值范围: |
| update_time | Long | 参数解释: 更新时间 取值范围: 不涉及 |
| gde_policy | GdePolicy object | 参数解释: GDE策略 取值范围: 不涉及 |
| ddm_policy_list | Array of DdmPolicy objects | 参数解释: DDM策略列表 取值范围: 不涉及 |
| sdm_policy_list | Array of SdmPolicy objects | 参数解释: SDM策略列表 取值范围: 不涉及 |
| gde_config | GdeConfig object | 参数解释: GDE配置 取值范围: 不涉及 |
| ddm_config | DdmConfig object | 参数解释: DDM配置 取值范围: 不涉及 |
| sdm_config | SdmConfig object | 参数解释: SDM配置 取值范围: 不涉及 |
| resource | DeviceResourceInfo object | 参数解释: 资源 取值范围: 不涉及 |
| target_resource | DeviceResourceInfo object | 参数解释: 目标资源 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| table | String | 参数解释: 表名称 取值范围: 不涉及 |
| columns | Array of Column objects | 参数解释: 需加密的列信息 取值范围: 不涉及 |
| alg | String | 参数解释: 加密算法,SM4、AES-128、AES-256 取值范围: 不涉及 |
| action | Integer | 参数解释: 操作类型 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| namespace | String | 参数解释: 命名空间,HBase特有,动脱专用 取值范围: 不涉及 |
| table | String | 参数解释: 表名(如果有模式,则是模式.表) 取值范围: 不涉及 |
| columns | Array of Column objects | 参数解释: 列信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| namespace | String | 参数解释: 命名空间,HBase特有,动脱专用 取值范围: 不涉及 |
| table | String | 参数解释: 表名(如果有模式,则是模式.表) 取值范围: 不涉及 |
| columns | Array of Column objects | 参数解释: 列信息 取值范围: 不涉及 |
| do_move | Boolean | 参数解释: 是否迁移 取值范围: true-是,false-否 |
| do_mask | Boolean | 参数解释: 是否脱敏 取值范围: true-是,false-否 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 列名称 取值范围: 不涉及 |
| enc_status | Integer | 参数解释: 加密状态 取值范围: 不涉及 |
| comment | String | 参数解释: 列注释 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| proxy_port | Integer | 参数解释: 代理端口 取值范围: 不涉及 |
| enc_mode | Integer | 参数解释: 加密模式 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| proxy_port | Integer | 参数解释: 代理端口 取值范围: 不涉及 |
| zk_port | Integer | 参数解释: 自定义的ZK端口,大数据类型(HBase和Hive)才有 取值范围: 不涉及 |
| zk_election_port | Integer | 参数解释: 自定义ZK选举端口,大数据类型(HBase和Hive)才有 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| auto_rebuild_target | Boolean | 参数解释: 是否重建表 取值范围: true-是,false-否 |
| clear_target | Boolean | 参数解释: 是否清理目标表 取值范围: true-是,false-否 |
| skip_dirty_data | Boolean | 参数解释: 是否跳过脏数据 取值范围: true-是,false-否 |
| select_type | String | 参数解释: 数据库静脱配置类型 取值范围: |
| select_param | String | 参数解释: 抽取方式对应的值 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| res_id | String | 参数解释: 设备资源信息ID 取值范围: 不涉及 |
| address | String | 参数解释: 设备地址 取值范围: 不涉及 |
| address_type | String | 参数解释: 设备资源信息类型 取值范围: 不涉及 |
| port | Integer | 参数解释: 设备端口 取值范围: 不涉及 |
| res_type | String | 参数解释: 设备资源信息类型 取值范围: 不涉及 |
| res_version | String | 参数解释: 资源版本 取值范围: 不涉及 |
| database_name | String | 参数解释: 数据库名称 取值范围: 不涉及 |
| account | String | 参数解释: 账号 取值范围: 不涉及 |
| password | String | 参数解释: 密码 取值范围: 不涉及 |
| case_sensitive | Boolean | 参数解释: 区分大小写敏感 取值范围: true-是,false-否 |
| extra_params | String | 参数解释: 额外参数 取值范围: 不涉及 |
请求示例
查询策略列表
/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/devices/security-policies
响应示例
状态码:200
{
"total" : 2,
"policy_list" : [ {
"id" : 1001,
"name" : "gde-encrypt-policy-01",
"type" : "GDE",
"related_device_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"related_device_name" : "firewall-01",
"related_device_type" : 1,
"related_datasource_id" : "c4f3a8e1-2b6d-4e5f-9a8b-7c6d5e4f3a2b",
"related_datasource_name" : "mysql-datasource-01",
"related_datasource_type" : "MYSQL",
"target_datasource_id" : "d5e4b7f2-3c8e-4f6a-9b1c-8d7e6f5a4b3c",
"target_datasource_name" : "mysql-target-01",
"target_datasource_type" : "MYSQL",
"enabled" : true,
"status" : "SUCCESS",
"update_time" : 1700100000000,
"gde_policy" : {
"table" : "user_info",
"columns" : [ {
"name" : "phone_number",
"enc_status" : 1,
"comment" : "用户手机号"
} ],
"alg" : "aes-256",
"action" : 1
},
"ddm_policy_list" : [ {
"namespace" : "default",
"table" : "user_info",
"columns" : [ {
"name" : "id_card",
"enc_status" : 1,
"comment" : "身份证号"
} ]
} ],
"sdm_policy_list" : [ {
"namespace" : "default",
"table" : "user_info",
"columns" : [ {
"name" : "email",
"enc_status" : 1,
"comment" : "用户邮箱"
} ],
"do_move" : true,
"do_mask" : true
} ],
"gde_config" : {
"proxy_port" : 8080,
"enc_mode" : 1
},
"ddm_config" : {
"proxy_port" : 8081,
"zk_port" : 2181,
"zk_election_port" : 2888
},
"sdm_config" : {
"auto_rebuild_target" : true,
"clear_target" : false,
"skip_dirty_data" : true,
"select_type" : "ALL",
"select_param" : "100"
},
"resource" : {
"res_id" : "e6f5c8a3-4d9f-5b7a-ac2d-9e8f7a6b5c4d",
"address" : "192.168.0.100",
"address_type" : "IP",
"port" : 3306,
"res_type" : "MYSQL",
"res_version" : "8.0",
"database_name" : "user_db",
"account" : "root",
"password" : "P@ssw0rd123",
"case_sensitive" : true,
"extra_params" : ""
},
"target_resource" : {
"res_id" : "f7a6d9b4-5e0a-6c8b-2d3e-0f1a2b3c4d5e",
"address" : "192.168.0.200",
"address_type" : "IP",
"port" : 5432,
"res_type" : "POSTGRESQL",
"res_version" : "15.0",
"database_name" : "order_db",
"account" : "admin",
"password" : "Adm1n@456",
"case_sensitive" : true,
"extra_params" : ""
}
}, {
"id" : 1002,
"name" : "ddm-mask-policy-01",
"type" : "DDM",
"related_device_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"related_device_name" : "dbss-02",
"related_device_type" : 2,
"related_datasource_id" : "d5e4b7f2-3c8e-4f6a-9b1c-8d7e6f5a4b3c",
"related_datasource_name" : "pg-datasource-01",
"related_datasource_type" : "POSTGRESQL",
"target_datasource_id" : "c4f3a8e1-2b6d-4e5f-9a8b-7c6d5e4f3a2b",
"target_datasource_name" : "pg-target-01",
"target_datasource_type" : "POSTGRESQL",
"enabled" : false,
"status" : "SENDING",
"update_time" : 1700100000000,
"gde_policy" : {
"table" : "user_info",
"columns" : [ {
"name" : "phone_number",
"enc_status" : 1,
"comment" : "用户手机号"
} ],
"alg" : "aes-256",
"action" : 1
},
"ddm_policy_list" : [ {
"namespace" : "default",
"table" : "user_info",
"columns" : [ {
"name" : "id_card",
"enc_status" : 1,
"comment" : "身份证号"
} ]
} ],
"sdm_policy_list" : [ {
"namespace" : "default",
"table" : "user_info",
"columns" : [ {
"name" : "email",
"enc_status" : 1,
"comment" : "用户邮箱"
} ],
"do_move" : true,
"do_mask" : true
} ],
"gde_config" : {
"proxy_port" : 8080,
"enc_mode" : 1
},
"ddm_config" : {
"proxy_port" : 8081,
"zk_port" : 2181,
"zk_election_port" : 2888
},
"sdm_config" : {
"auto_rebuild_target" : true,
"clear_target" : false,
"skip_dirty_data" : true,
"select_type" : "ALL",
"select_param" : "100"
},
"resource" : {
"res_id" : "f7a6d9b4-5e0a-6c8b-2d3e-0f1a2b3c4d5e",
"address" : "192.168.0.200",
"address_type" : "IP",
"port" : 5432,
"res_type" : "POSTGRESQL",
"res_version" : "15.0",
"database_name" : "order_db",
"account" : "admin",
"password" : "Adm1n@456",
"case_sensitive" : true,
"extra_params" : ""
},
"target_resource" : {
"res_id" : "e6f5c8a3-4d9f-5b7a-ac2d-9e8f7a6b5c4d",
"address" : "192.168.0.100",
"address_type" : "IP",
"port" : 3306,
"res_type" : "MYSQL",
"res_version" : "8.0",
"database_name" : "user_db",
"account" : "root",
"password" : "P@ssw0rd123",
"case_sensitive" : true,
"extra_params" : ""
}
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。