文档首页/ 数据库安全服务 DBSS/ API参考/ API/ 运维增强管理/ 获取数据库运维集群实例

更新时间：2025-09-10 GMT+08:00

查看PDF

获取数据库运维集群实例

功能介绍

获取数据库运维集群实例

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。约束限制：不涉及取值范围：以IAM服务接口返回值为准，字符长度32-64。默认取值：不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：不涉及取值范围： IAM服务查询用户Token接口为准默认取值：不涉及

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
clusters	Array of Cluster objects	实例列表

表4 Cluster
参数	参数类型	描述
activate_info	InstanceActivateInfo object	实例激活信息
charge_model	String	计费模式 Period: 包周期 Demand: 按需
comment	String	备注信息
created	Long	创建时间
deploy_mode	String	部署方式 CLOUD: 云上 OUTSIDE：云外
detail	ServerList object	服务列表
enterprise_project_id	String	企业项目ID
expired	Long	过期时间
float_ip	String	浮动IP
instance_id	String	实例ID
is_active_standby	Boolean	是否激活备用
keep_days	String	使用天数
name	String	实例名称
new_version	String	最新版本
public_ip	String	公网IP
remain_days	String	剩余天数

表5 InstanceActivateInfo
参数	参数类型	描述
dsc_proxy_domain_name	String	代理DOMAIN名称
dsc_proxy_ip	String	代理IP
dsc_proxy_port	Integer	代理端口
master_node_id	String	主节点ID
slave_node_id	String	备节点ID

表6 ServerList
参数	参数类型	描述
server	Array of ResponseServer objects	server列表
total	Integer	数量

表7 ResponseServer
参数	参数类型	描述
connect_ip	String	连接IP
cpu	String	CPU数
created	String	创建时间
description	String	描述
effect	Integer	实例冻结状态 1：冻结可释放（默认） 2：冻结不可释放 3：冻结后不可续费
instance_id	String	实例ID
is_active	Integer	双机实例HA中用来标注实例为主机还是备机, -0: 主机 -1:备机
name	String	实例名称
ram	String	内存大小
region	String	所属REGION
resource_spec_code	String	实例所属规格编码
scene	String	冻结场景 - POLICE: 公安冻结 - ILLEGAL: 违规冻结 - VERIFY: 未实名认证冻结 - PARTNER: 合作伙伴冻结 - ARREAR: 普通冻结（普通）
security_group_id	String	安全组ID
specification	String	资源规格类型编码
status	String	实例状态
subnet_id	String	子网ID
task_status	String	实例处理中状态
update_status	String	升级状态 SUCCESS：成功 FAILED：失败 UPGRADING：升级中
version	String	版本号
vpc_id	String	VPC ID
zone	String	所属区域
server_id	String	服务器ID

状态码：400

表8 响应Body参数
参数	参数类型	描述
details	Array of DbssErrorDetail objects	PDP5鉴权异常信息
encoded_authorization_message	String	PDP5鉴权异常信息
error_code	String	错误码
error_msg	String	错误信息

表9 DbssErrorDetail
参数	参数类型	描述
error_code	String	错误码
error_msg	String	PDP5错误信息

状态码：401

**表10** 响应Body参数
参数	参数类型	描述
details	Array of DbssErrorDetail objects	PDP5鉴权异常信息
encoded_authorization_message	String	PDP5鉴权异常信息
error_code	String	错误码
error_msg	String	错误信息

**表11** DbssErrorDetail
参数	参数类型	描述
error_code	String	错误码
error_msg	String	PDP5错误信息

状态码：403

**表12** 响应Body参数
参数	参数类型	描述
details	Array of DbssErrorDetail objects	PDP5鉴权异常信息
encoded_authorization_message	String	PDP5鉴权异常信息
error_code	String	错误码
error_msg	String	错误信息

**表13** DbssErrorDetail
参数	参数类型	描述
error_code	String	错误码
error_msg	String	PDP5错误信息

状态码：500

**表14** 响应Body参数
参数	参数类型	描述
details	Array of DbssErrorDetail objects	PDP5鉴权异常信息
encoded_authorization_message	String	PDP5鉴权异常信息
error_code	String	错误码
error_msg	String	错误信息

**表15** DbssErrorDetail
参数	参数类型	描述
error_code	String	错误码
error_msg	String	PDP5错误信息

请求示例

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

响应示例

状态码：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
  } ]
}

状态码

状态码	描述
200	OK
400	请求参数有误。
401	认证失败
403	未授权
500	服务端错误

错误码

请参见错误码。

父主题： 运维增强管理

上一篇：运维增强管理

下一篇：更改数据库运维实例的名称

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

获取数据库运维集群实例

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？