Help Center/ Database Security Service/ API Reference/ API Description/ Audit Instance/ Obtaining the Resource List via the SecMaster Connector
Updated on 2026-07-10 GMT+08:00

Obtaining the Resource List via the SecMaster Connector

Function

This API is used to obtain the resource list via SecMaster connector.

URI

GET /v1/resource-manager/domains/{domain_id}/all-resources/{region_id}/{resource_type}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Definition

Account ID. Obtain the value by calling the IAM API for querying IAM user details.

Constraints

N/A

Range

The value is subject to the IAM API for querying IAM user details.

Default value

N/A

resource_type

Yes

String

Definition

Resource type.

Constraints

N/A

Range

  • cloudservers: audit

  • dbEncrypt: encryption

  • dbOm: O&M

Default value

N/A

region_id

Yes

String

Definition

Use the current region ID.

Constraints

N/A

Range

Use the current region ID.

Default value

Use the current region ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition

Page size

Constraints

Positive integer

Range

Greater than 0 and less than or equal to 100

Default value

100

marker

No

String

Definition

Next page marker

Constraints

The value is subject to the response returned by the list query API.

Range

N/A

Default value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. The token can be queried by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

page_info

PageInfo object

Pagination information.

resources

Array of CsbResource objects

Resource list.

Table 5 PageInfo

Parameter

Type

Description

current_count

Integer

Current page size.

next_marker

String

Next page marker

Table 6 CsbResource

Parameter

Type

Description

tags

Array of CsbResourceTag objects

Resource tags

affected_resources

Array of AffectedResource objects

Protected resource object list.

create_time

String

Creation time

description

String

Resource description

environment

ResourceEnvironment object

Resource environment attributes

name

String

Resource name.

provider

String

Cloud service. The value is dbss.

resource_id

String

Resource ID.

security_group_id

String

Security group ID.

subnet_id

String

Subnet ID.

type

String

Resource type. The options are as follows:

  • cloudservers: audit

  • dbEncrypt: encryption

  • dbOm: O&M

update_time

String

Update time

urn

String

Resource URN.

urnext

String

Resource URN extension

vpc_id

String

VPC ID

Table 7 CsbResourceTag

Parameter

Type

Description

key

String

Tag key

value

String

Tag value

Table 8 AffectedResource

Parameter

Type

Description

affected_attached_domain_id

String

Protected object account ID

affected_attached_project_id

String

Protected object project ID

affected_head

DataResourceHead object

Protected object header information

affected_properties

Object

Resource extension information.

affected_protected_id

String

Unique ID of the protected (affected) object in the defense system.

affected_subtype

String

Protected (affected) object subtype. The value is fixed to DB.

affected_type

String

Protected (affected) object type. The value is fixed to Data.

affected_urn

String

Protected object URN

affected_urnext

String

Protected object URN extension

affected_value

String

Value of the protected (affected) object. The value is the same as that of affectedProtectedId for on-premises databases and is not transferred for cloud databases.

Table 9 DataResourceHead

Parameter

Type

Description

alias

String

Database instance alias

datastore

DbDataStore object

Database objects

db_ip

String

Database IP address

db_name

String

Database name.

db_port

String

Database port

db_user_list

Array of DbUser objects

Database user list

provider

String

Cloud service name, for example, RDS

rds_id

String

RDS database ID

status

String

Database status

type

String

Database type.

Table 10 DbDataStore

Parameter

Type

Description

type

String

Database type.

version

String

Database version

Table 11 DbUser

Parameter

Type

Description

user_name

String

Username.

user_permission

String

User permissions

Table 12 ResourceEnvironment

Parameter

Type

Description

domain_id

String

Account ID.

ep_id

String

Enterprise project ID

ep_name

String

Enterprise project name

project_id

String

Project ID.

region_id

String

regionID

Status code: 400

Table 13 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 14 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 401

Table 15 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 16 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

Table 17 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 18 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 19 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 20 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v1/resource-manager/domains/{domain_id}/all-resources/{region_id}/{resource_type}

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.