Updated on 2026-01-13 GMT+08:00

Querying DBSS Instance Information

Function

This API is used to obtain DBSS instance information.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Instance type, which can be GDE (database encryption), DOM (database O&M), DDM (dynamic database masking), or DBSS (database audit).

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

ins_info_list

Array of OemInsInfo objects

Instance information list.

Table 4 OemInsInfo

Parameter

Type

Description

ins_id

String

Instance ID.

ins_name

String

Instance name.

related_datasource_policy_list

Array of RelatedDatasourceInfo objects

Associated data source and security policy information list.

subnet_id

String

Subnet ID.

vpc_id

String

VPC ID.

Table 5 RelatedDatasourceInfo

Parameter

Type

Description

datasource_address

String

Data source address.

datasource_id

String

Data source asset ID.

datasource_port

Integer

Data source port.

ddm_policies

Array of DdmPolicy objects

List of associated dynamic masking policies.

gde_policies

Array of GdePolicy objects

List of associated encryption policies.

proxy_port

Integer

Agent port.

sdm_policies

Array of SdmPolicy objects

array

Table 6 DdmPolicy

Parameter

Type

Description

columns

Array of Column objects

Columns configured for the policy.

namespace

String

Namespace name.

table

String

Table name.

Table 7 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 8 SdmPolicy

Parameter

Type

Description

columns

Array of Column objects

Column information.

do_mask

Boolean

Whether to mask data.

do_move

Boolean

Whether to migrate data.

namespace

String

Namespace, which is only available for HBase.

table

String

Table name.

Table 9 Column

Parameter

Type

Description

mask

Integer

Masking algorithm name or ID.

name

String

Column name.

Example Requests

None

Example Responses

None

Status Codes

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 or instance does not exist.

Error Codes

See Error Codes.