Obtaining Database O&M Cluster Instances

Function

URI

POST /v2/{project_id}/db-om/instances

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: Specifies the project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user. Restrictions: N/A Value range: The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Parameter description: User token. You can obtain the token by calling the IAM API used to query the user token. The token is the value of X-Subject-Token in the response header. Restrictions: N/A Value range: Used by the IAM service to query the user token. Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
clusters	Array of Cluster objects	Instances

**Table 4** Cluster
Parameter	Type	Description
activate_info	InstanceActivateInfo object	Instance activation information
charge_model	String	Billing mode. The options are as follows: Period: yearly/monthly Demand: on-demand
comment	String	Remarks.
created	Long	Creation time.
deploy_mode	String	Deployment Mode CLOUD: cloud OUTSIDE: outside the cloud
detail	ServerList object	Service list
enterprise_project_id	String	Enterprise project ID
expired	Long	Expiration time
float_ip	String	Floating IP Address
instance_id	String	Instance ID
is_active_standby	Boolean	Whether to activate the standby
keep_days	String	Days
name	String	Instance name
new_version	String	Latest Version
public_ip	String	Public IP address
remain_days	String	Remaining period (days)

**Table 5** InstanceActivateInfo
Parameter	Type	Description
dsc_proxy_domain_name	String	Proxy Domain Name
dsc_proxy_ip	String	Proxy IP Address
dsc_proxy_port	Integer	Proxy Port
master_node_id	String	Master Node ID
slave_node_id	String	Standby Node ID

**Table 6** ServerList
Parameter	Type	Description
server	Array of ResponseServer objects	Server list.
total	Integer	Quantity

**Table 7** ResponseServer
Parameter	Type	Description
connect_ip	String	Connection IP address.
cpu	String	CPUs
created	String	Creation time.
description	String	Description
effect	Integer	Instance frozen status. The value can be: 1: frozen and can be released (default) 2: frozen and cannot be released 3: Frozen accounts cannot be renewed.
instance_id	String	Instance ID
is_active	Integer	Indicates whether an instance is a primary or standby instance in HA mode. -0: primary instance; -1: standby instance
name	String	Instance name
ram	String	Memory Size
region	String	Region
resource_spec_code	String	Instance specification code
scene	String	Frozen scenario - POLICE: frozen by the public security department - ILLEGAL: frozen due to violation - VERIFY: frozen due to non-real-name authentication - PARTNER: frozen due to partners - ARREAR: frozen due to common reasons
security_group_id	String	Security group ID.
specification	String	Resource specification type code.
status	String	Instance Status
subnet_id	String	Subnet ID
task_status	String	Instance processing status
update_status	String	Upgrade status SUCCESS: success FAILED: failed UPGRADING: The instance is being upgraded.
version	String	Version
vpc_id	String	VPC ID
zone	String	Region
server_id	String	Server ID

Status code: 400

**Table 8** 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 9** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 401

**Table 10** 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 11** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 403

**Table 12** 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 13** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 500

**Table 14** 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 15** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Example Requests

/v2/{project_id}/db-om/instances

Example Responses

Status code: 200

{
  "clusters" : [ {
    "name" : "DBSS-OM0819",
    "created" : 1755594767000,
    "expired" : 1758268799000,
    "comment" : null,
    "detail" : {
      "total" : 2,
      "server" : [ {
        "name" : "DBSS-OM0819-HA-1",
        "description" : null,
        "status" : "ACTIVE",
        "specification" : "dbss.opsmgmt.high",
        "zone" : "cn-north-7c",
        "created" : "2025-08-19 17:04:00",
        "cpu" : "8",
        "ram" : "16384",
        "region" : "cn-north-7",
        "version" : "2.0",
        "effect" : null,
        "scene" : null,
        "instance_id" : "a8c37c9be61ffd4ee8aacab7bae74e91",
        "connect_ip" : "10.0.169.77",
        "task_status" : "NO_TASK",
        "server_id" : "24307773-2399-495a-a6ad-5159b4bb6a43",
        "vpc_id" : "21f3dac4-f460-4173-ba5e-cb7a0d528605",
        "subnet_id" : "cbed162e-045a-4afd-aa2b-0da11219989c",
        "security_group_id" : "9e033f2d-04a5-4bdc-858e-17e31599d052",
        "resource_spec_code" : "dbss.opsmgmt.high",
        "update_status" : null,
        "is_active" : 1
      }, {
        "name" : "DBSS-OM0819-HA-2",
        "description" : null,
        "status" : "ACTIVE",
        "specification" : "dbss.opsmgmt.high",
        "zone" : "cn-north-7c",
        "created" : "2025-08-19 17:04:00",
        "cpu" : "8",
        "ram" : "16384",
        "region" : "cn-north-7",
        "version" : "2.0",
        "effect" : null,
        "scene" : null,
        "instance_id" : "a8c37c9be61ffd4ee8aacab7bae74e91",
        "connect_ip" : "10.0.9.187",
        "task_status" : "NO_TASK",
        "server_id" : "df392d71-f504-411e-b336-ad98dcfacad1",
        "vpc_id" : "21f3dac4-f460-4173-ba5e-cb7a0d528605",
        "subnet_id" : "cbed162e-045a-4afd-aa2b-0da11219989c",
        "security_group_id" : "9e033f2d-04a5-4bdc-858e-17e31599d052",
        "resource_spec_code" : "dbss.opsmgmt.high",
        "update_status" : null,
        "is_active" : 0
      } ]
    },
    "instance_id" : "a8c37c9be61ffd4ee8aacab7bae74e91",
    "float_ip" : "10.0.148.95",
    "charge_model" : "Period",
    "remain_days" : "31",
    "keep_days" : "33",
    "new_version" : null,
    "enterprise_project_id" : "0",
    "public_ip" : "100.85.120.66",
    "is_active_standby" : true,
    "deploy_mode" : "CLOUD",
    "activate_info" : null
  } ]
}