文档首页/ 数据安全中心 DSC/ API参考/ API/ 安全策略管理/ 查询DBSSOEM实例信息 - ShowDbssOemInsInfo
更新时间:2026-11-13 GMT+08:00
分享

查询DBSSOEM实例信息 - ShowDbssOemInsInfo

功能介绍

功能介绍:查询DBSS OEM实例信息,按实例类型返回OEM实例列表,供安全策略关联使用。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/security-policies/dbss-oem-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

参数解释:

实例类型

约束限制:

不涉及

取值范围:

  • DISTRIBUTED:分布式

  • PRIMARY_STANDBY:主备

  • UNRECOGNIZED:未识别

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

ins_info_list

Array of OemInsInfo objects

参数解释:

OEM实例信息列表,数组元素为OemInsInfo对象

取值范围:

不涉及

表5 OemInsInfo

参数

参数类型

描述

ins_id

String

参数解释:

实例ID

取值范围:

不涉及

ins_name

String

参数解释:

实例名称

取值范围:

不涉及

vpc_id

String

参数解释:

VPCID

取值范围:

不涉及

subnet_id

String

参数解释:

子网ID

取值范围:

不涉及

related_datasource_policy_list

Array of RelatedDatasourceInfo objects

参数解释:

关联数据源策略列表,数组元素为RelatedDatasourceInfo对象

取值范围:

不涉及

表6 RelatedDatasourceInfo

参数

参数类型

描述

datasource_address

String

参数解释:

数据源连接地址

取值范围:

不涉及

datasource_port

Integer

参数解释:

数据源连接端口

取值范围:

不涉及

datasource_id

String

参数解释:

数据源唯一标识ID

取值范围:

不涉及

proxy_port

Integer

参数解释:

代理端口,用于数据源代理访问

取值范围:

不涉及

gde_policies

Array of GdePolicy objects

参数解释:

动态数据脱敏策略列表

取值范围:

不涉及

ddm_policies

Array of DdmPolicy objects

参数解释:

动态数据脱敏管理策略列表

取值范围:

不涉及

sdm_policies

Array of SdmPolicy objects

参数解释:

静态数据脱敏策略列表

取值范围:

不涉及

表7 GdePolicy

参数

参数类型

描述

table

String

参数解释:

数据库表名称

取值范围:

不涉及

columns

Array of Column objects

参数解释:

需要脱敏的列信息列表

取值范围:

不涉及

alg

String

参数解释:

脱敏算法名称

取值范围:

不涉及

action

Integer

参数解释:

操作类型

取值范围:

不涉及

表8 DdmPolicy

参数

参数类型

描述

namespace

String

参数解释:

命名空间,用于标识数据脱敏策略的作用范围

取值范围:

不涉及

table

String

参数解释:

数据库表名称

取值范围:

不涉及

columns

Array of Column objects

参数解释:

需要脱敏的列信息列表

取值范围:

不涉及

表9 SdmPolicy

参数

参数类型

描述

namespace

String

参数解释:

命名空间

取值范围:

不涉及

table

String

参数解释:

表名

取值范围:

不涉及

columns

Array of Column objects

参数解释:

列列表

取值范围:

不涉及

do_move

Boolean

参数解释:

是否移动

取值范围:

true-是,false-否

do_mask

Boolean

参数解释:

是否脱敏

取值范围:

true-是,false-否

表10 Column

参数

参数类型

描述

name

String

参数解释:

列名称

取值范围:

不涉及

family

String

参数解释:

列族名称,用于数据库中的列分组

取值范围:

不涉及

level

String

参数解释:

脱敏级别,用于标识列的脱敏优先级或敏感程度

取值范围:

不涉及

mask

Integer

参数解释:

脱敏标识,1表示需要脱敏,0表示不需要脱敏

取值范围:

  • 0:不脱敏

  • 1:脱敏

tag

String

参数解释:

标签

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

{
  "ins_info_list" : [ {
    "ins_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "ins_name" : "dbss-instance-01",
    "vpc_id" : "c3d4e5f6-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
    "subnet_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e",
    "related_datasource_policy_list" : [ {
      "datasource_address" : "192.168.1.100",
      "datasource_port" : 3306,
      "datasource_id" : "d3e4f5a6-7b8c-4d9e-0f1a-2b3c4d5e6f7a",
      "proxy_port" : 9797,
      "gde_policies" : [ ],
      "ddm_policies" : [ ],
      "sdm_policies" : [ ]
    } ]
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档