文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（即将下线）> 实例管理> 查询实例详细信息

更新时间：2024-04-01 GMT+08:00

在线调试

CLI示例

查看PDF

查询实例详细信息

功能介绍

查询指定实例的详细信息。

该接口计划于2025-03-31下线，建议及时切换到新接口查询实例详细信息。

调用接口前，您需要了解API认证鉴权。
调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

URI

URI格式
 GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}
URI样例
 GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07

参数说明

表1 参数说明
名称	参数类型	是否必选	说明
project_id	String	是	租户在某一Region下的project ID。获取方法请参见获取项目ID。
instance_id	String	是	实例ID。

请求消息

无。

响应消息

正常响应要素说明

表2 参数说明
名称	参数类型	说明
instance	Object	实例信息。详情请参见表3。

表3 instance字段数据结构说明
名称	参数类型	说明
id	String	实例ID。
name	String	创建的实例名称。
project_id	String	租户在某一Region下的project ID。
status	String	实例状态。取值：值为“BUILD”，表示实例正在创建。值为“ACTIVE”，表示实例正常。值为“FAILED”，表示实例异常。值为“FROZEN”，表示实例冻结。值为“MODIFYING”，表示实例正在扩容。值为“REBOOTING”，表示实例正在重启。值为“RESTORING”，表示实例正在恢复。值为“MODIFYING INSTANCE TYPE”，表示实例正在转主备。值为“SWITCHOVER”，表示实例正在主备切换。值为“MIGRATING”，表示实例正在迁移。值为“BACKING UP”，表示实例正在进行备份。值为“MODIFYING DATABASE PORT”，表示实例正在修改数据库端口。值为“STORAGE FULL”，表示实例磁盘空间满。
enterprise_project_id	String	企业项目ID。
type	String	实例类型，仅支持Cluster。
node_count	Integer	节点个数。
datastore	Object	数据库信息，详情请参见表4。
backup_used_space	Double	备份空间使用大小，单位为GB。
created	String	创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。说明：创建时返回值为空，数据库实例创建成功后该值不为空。
updated	String	更新时间，格式与"created"字段对应格式完全相同。说明：创建时返回值为空，数据库实例创建成功后该值不为空。
public_ips	String	实例的公网IP。
private_write_ips	Array of List	实例的写内网IP。
db_user_name	String	默认用户名。
port	String	数据库端口号。
vpc_id	String	虚拟私有云ID。
subnet_id	String	子网的网络ID信息。
security_group_id	String	安全组ID。
volume	Object	磁盘信息，详情请参见表7。
backup_strategy	Object	备份策略，详情请参见表5。
nodes	Arrays of object	节点信息，详情请参见表6。
time_zone	String	时区。
az_mode	String	可用区模式，单可用区single或多可用区multi。
master_az_code	String	主可用区。
maintenance_window	String	可维护时间窗，为UTC时间。
configuration_id	String	实例创建的模板ID，或者应用到实例的最新参数组模板ID。
tags	Arrays of object	实例标签。详情请参见表 tags字段数据结构说明。

表4 datastore字段数据结构说明
名称	参数类型	说明
type	String	数据库引擎。
version	String	数据库版本。

表5 backup_strategy字段数据结构说明
名称	参数类型	说明
start_time	String	备份时间段。自动备份将在该时间段内触发。
keep_days	Integer	已生成的备份文件可以保存的天数。

表6 nodes字段数据结构说明
名称	参数类型	说明
id	String	节点ID。
name	Array of object	节点名称。
type	String	节点类型，master或slave。
status	String	节点状态。
port	Integer	数据库端口号。
private_read_ips	Array of String	节点的读内网IP。
volume	Object	磁盘信息。
az_code	String	可用区。
region_code	String	实例所在区域。
created	String	创建时间。
updated	String	更新时间。
flavor_ref	String	规格码。详情请参见表3。
max_connections	String	允许的最大连接数
vcpus	String	CPU核数。
ram	String	内存大小，单位为GB。
need_restart	Boolean	是否需要重启使修改的参数生效
priority	String	主备倒换优先级。

表7 volume字段数据结构说明
名称	参数类型	说明
type	String	存储类型，现在仅有POOL。
used	String	已使用的存储大小，单位GB。

表8 tags 字段数据结构说明
名称	参数类型	说明
type	String	标签键。最大长度36个unicode字符。 key不能为空或者空字符串，不能为空格。字符集：A-Z，a-z ，0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。
used	String	标签值。最大长度43个unicode字符。可以为空字符串。字符集：A-Z，a-z ，0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

响应样例中，“region_code”和“az_code”的值为示例值。

正常响应样例

{
  "instance": {
    "id": "d2cda7b97a39488e8b30e3cea4066204in07",
    "name": "gauss-d616-lb07",
    "status": "FAILED",
    "project_id": "053f533ead80d5102f0cc012e8d468a4",
    "enterprise_project_id": "0",
    "type": "Cluster",
    "charge_info": {
      "charge_mode": "postPaid",
      "order_id": ""
    },
    "node_count": 2,
    "datastore": {
      "type": "GaussDB(for MySQL)",
      "version": "8.0"
    },
    "created": "2020-07-21T09:13:56+0800",
    "updated": "2020-07-21T09:27:54+0800",
    "public_ips": "",
    "private_write_ips": [
      "192.168.0.235"
    ],
    "db_user_name": "root",
    "port": "3306",
    "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
    "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186",
    "security_group_id": "c7f69884-fe2b-4630-8114-70a11499d902",
    "backup_strategy": {
      "start_time": "00:00-00:00",
      "keep_days": "0"
    },
    "nodes": [
      {
        "id": "799a0f2fa49a4151bf9f7063c1fbba36no07",
        "name": "gauss-d616-lb07_node01",
        "type": "master",
        "status": "FAILED",
        "port": 3306,
        "private_read_ips": [
          "192.168.0.163"
        ],
        "volume": {
          "type": "POOL",
          "used": "0.0"
        },
        "az_code": "az1xahz",
        "region_code": "cn-xianhz-1",
        "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
        "flavor_ref": "gaussdb.large.4",
        "max_connections": null,
        "vcpus": "1",
        "ram": "4",
        "need_restart": false,
        "priority": 1
      },
      {
        "id": "816459d771c444db9fa4c1d5c173cb1cno07",
        "name": "gauss-d616-lb07_node02",
        "type": "slave",
        "status": "FAILED",
        "port": 3306,
        "private_read_ips": [
          "192.168.0.160"
        ],
        "volume": {
          "type": "POOL",
          "used": "0.0"
        },
        "az_code": "az1xahz",
        "region_code": "cn-xianhz-1",
        "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
        "flavor_ref": "gausssdb.large.4",
        "max_connections": null,
        "vcpus": "1",
        "ram": "4",
        "need_restart": false,
        "priority": 1
      }
    ],
    "time_zone": "UTC+08:00",
    "backup_used_space": 0,
    "az_mode": "single",
    "master_az_code": "az1xahz",
    "maintenance_window": "18:00-22:00"
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

上一篇：批量查询实例详情

下一篇：新增只读节点

意见反馈

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

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消