计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询实例列表和详情

更新时间:2024-12-31 GMT+08:00

功能介绍

根据指定条件查询数据库实例列表和详情。

接口约束

该接口支持如下数据库实例:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

URI

GET https://{Endpoint}/v3/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一region下的project ID。获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

id

String

参数解释:

实例ID。

约束限制:

如果id以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的id精确匹配查询。

取值范围:

不涉及。

默认取值:

不涉及。

name

String

参数解释:

实例名称。

约束限制:

如果name以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的name精确匹配查询。

取值范围:

不涉及。

默认取值:

不涉及。

datastore_type

String

参数解释:

数据库类型。

约束限制:

不涉及。

取值范围:

取值为“cassandra”,表示查询GeminiDB Cassandra数据库实例。

取值为“mongodb”,表示GeminiDB Mongo查询数据库实例。

取值为“influxdb”,表示查询GeminiDB Influx数据库实例。

取值为“redis”,表示查询GeminiDB Redis数据库实例。

默认取值:

如果不传该参数,表示查询所有数据库实例。

mode

String

参数解释:

实例类型。

约束限制:

不涉及。

取值范围:

  • 取值为“Cluster”,表示GeminiDB CassandraGeminiDB InfluxGeminiDB Redis Proxy集群实例类型。
  • 取值为“RedisCluster”,表示GeminiDB Redis Cluster集群实例类型。
  • 取值为“InfluxdbSingle”,表示GeminiDB Influx单节点实例类型。
  • 取值为“ReplicaSet”,表示GeminiDB Mongo副本集实例类型。
  • 如果不传datastore_type参数,自动忽略该参数设置。

默认取值:

不涉及。

vpc_id

String

参数解释:

虚拟私有云ID,获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。
  • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询VPC列表

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

subnet_id

String

参数解释:

子网的网络ID,获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。
  • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询子网列表

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

offset

Integer

参数解释:

索引位置偏移量,表示从指定project ID下最新的实例创建时间开始,按时间的先后顺序偏移offset条数据后查询对应的实例信息。

约束限制:

不涉及。

取值范围:

取值大于或等于0。

默认取值:

不传该参数时,查询偏移量默认为0,表示从最新的实例创建时间对应的实例开始查询。

limit

Integer

参数解释:

查询实例个数上限值。

约束限制:

不涉及。

取值范围:

1~100。

默认取值:

不传该参数时,默认查询前100条实例信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

instances

Array of ListInstancesResult objects

参数解释:

实例信息。

total_count

Integer

参数解释:

总记录数。

取值范围:

不涉及。

表5 ListInstancesResult

参数

参数类型

描述

id

String

参数解释:

实例ID。

取值范围:

不涉及。

name

String

参数解释:

实例名称。

取值范围:

不涉及。

status

String

参数解释:

实例状态。

取值范围:

  • normal,表示实例正常。
  • abnormal,表示实例异常。
  • creating,表示实例创建中。
  • frozen,表示实例被冻结。
  • data_disk_full,表示实例磁盘已满。
  • createfail,表示实例创建失败。
  • enlargefail,表示实例扩容节点个数失败。

port

String

参数解释:

数据库端口。

取值范围:

不涉及。

mode

String

参数解释:

实例类型。

取值范围:

与请求参数相同。

region

String

参数解释:

实例所在区域。

取值范围:

不涉及。

datastore

ListInstancesDatastoreResult object

参数解释:

数据库信息。

engine

String

参数解释:

存储引擎。

取值范围

“rocksDB”。

created

String

参数解释:

实例创建时间。

取值范围:

不涉及。

updated

String

参数解释:

实例操作最新变更的时间。

取值范围:

不涉及。

db_user_name

String

参数解释:

默认用户名。

取值范围:

“rwuser”。

vpc_id

String

参数解释:

虚拟私有云ID。

取值范围:

不涉及。

subnet_id

String

参数解释:

子网ID。

取值范围:

GeminiDB Cassandra 实例使用多个子网的场景,请参见表 ListInstancesNodeResult字段数据结构说明中的“subnet_id”。

security_group_id

String

参数解释:

安全组ID。

取值范围:

不涉及。

backup_strategy

ListInstancesBackupStrategyResult object

参数解释:

备份策略。

pay_mode

String

参数解释:

计费方式。

取值范围:

  • 取值为“0”,表示按需计费。
  • 取值为“1”,表示包年/包月计费。

maintenance_window

String

参数解释:

系统可维护时间窗。

取值范围:

不涉及。

groups

Array of ListInstancesGroupResult objects

参数解释:

组信息。

enterprise_project_id

String

参数解释:

企业项目ID。

取值范围:

“0”,表示为default企业项目。

time_zone

String

参数解释:

时区。

取值范围:

不涉及。

actions

Array of strings

参数解释:

实例正在执行的动作。示例:

  • CREATE
  • REBOOT
  • RESTORE

dedicated_resource_id

String

参数解释:

专属资源ID,只有数据库实例属于专属资源池才会返回该参数。

取值范围:

不涉及。

lb_ip_address

String

参数解释:

负载均衡IP。

约束限制

只有存在负载均衡IP,才会返回该参数。

取值范围:

不涉及。

lb_port

String

参数解释:

负载均衡端口。

约束限制

只有存在负载均衡ip,才会返回该参数。

取值范围:

不涉及。

availability_zone

String

参数解释:

实例可用区。

取值范围:

不涉及。

表6 ListInstancesDatastoreResult

参数

参数类型

描述

type

String

参数解释:

数据库接口

取值范围:

不涉及。

version

String

参数解释:

数据库版本号。

取值范围:

不涉及。

patch_available

Boolean

参数解释:

当前实例是否有可升级的补丁。

取值范围:

  • true,可以通过升级补丁接口进行数据库升级。
  • false,不可以通过升级补丁接口进行数据库升级。

whole_version

String

参数解释:

数据库的完整版本号。

约束限制

目前只有GeminiDB Cassandra支持

取值范围

不涉及。

表7 ListInstancesBackupStrategyResult

参数

参数类型

描述

start_time

String

参数解释:

备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。

取值范围

不涉及。

keep_days

Integer

参数解释:

已生成备份文件可以保存的天数。

取值范围:

0~35。

表8 ListInstancesGroupResult

参数

参数类型

描述

id

String

参数解释:

组ID。

取值范围

不涉及。

status

String

参数解释:

组状态。

取值范围:

  • normal,表示组正常。
  • abnormal,表示组异常。
  • creating,表示组创建中。
  • createfail,表示组创建失败。
  • deleted,表示组被删除。
  • resizefailed,表示组规格变更失败。
  • enlargefail,表示组扩容失败。

volume

Volume object

参数解释:

volume信息

nodes

Array of ListInstancesNodeResult objects

参数解释:

节点信息。

表9 Volume

参数

参数类型

描述

size

String

参数解释:

磁盘大小。单位:GB。

取值范围

不涉及。

used

String

参数解释:

磁盘使用量。单位:GB。

取值范围

不涉及。

表10 ListInstancesNodeResult

参数

参数类型

描述

id

String

参数解释:

节点ID。

取值范围

不涉及。

name

String

参数解释:

节点名称。

取值范围

不涉及。

status

String

参数解释:

节点状态。

取值范围

  • normal,表示节点正常。
  • abnormal,表示节点异常。
  • creating,表示节点创建中。
  • createfail,表示节点创建失败。
  • deleted,表示节点被删除。
  • resizefailed,表示节点规格变更失败。
  • enlargefail,表示节点扩容失败。

role

String

参数解释:

节点角色。

约束限制:

该参数仅对GeminiDB Mongo接口的副本集实例有效。

取值范围

不涉及。

subnet_id

String

参数解释:

节点所在的子网的ID。

取值范围

不涉及。

private_ip

String

参数解释:

节点内网IP。

约束限制:

在弹性云服务器创建成功后参数值存在,否则,值为""。

取值范围

不涉及。

public_ip

String

参数解释:

绑定的公网IP。

约束限制:

该参数仅针对绑定了公网IP的节点有效。

取值范围

不涉及。

spec_code

String

参数解释:

资源规格编码。关于实例的规格信息,请参见查询数据库规格中响应参数“flavors.spec_code”的值。

取值范围

不涉及。

availability_zone

String

参数解释:

可用区。

取值范围

不涉及。

support_reduce

Boolean

参数解释:

是否支持节点缩容。

取值范围

  • true,表示该节点支持节点缩容。
  • false,表示该节点不支持节点缩容。

请求示例

  • URI样例

    查询所有实例列表和详情

    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances
  • URI样例

    根据指定条件查询实例列表和详情

    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in06&name=hy&mode=Cluster&datastore_type=cassandra&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7

响应示例

状态码: 200

Success

{
  "instances" : [ {
    "id" : "8436a91546294036b75931e879882200in06",
    "name" : "nosql-efa6",
    "status" : "normal",
    "port" : "8635",
    "mode" : "Cluster",
    "region" : "aaa",
    "datastore" : {
      "type" : "Cassandra",
      "version" : "3.11",
      "whole_version" : "3.11.3.11204", 
      "patch_available" : false
    },
    "engine" : "rocksDB",
    "created" : "2019-01-17T07:05:52",
    "updated" : "2019-01-17T07:05:47",
    "db_user_name" : "rwuser",
    "vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
    "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
    "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58",
    "backup_strategy" : {
      "start_time" : "16:00-17:00",
      "keep_days" : 7
    },
    "pay_mode" : 0,
    "maintenance_window" : "02:00-06:00",
    "groups" : [ {
      "id" : "0b0ff12541794e1084f6827e424be2d6gr06",
      "status" : "creating",
      "volume" : {
        "size" : 10,
        "used" : 0.33
      },
      "nodes" : [ {
        "id" : "233eaac9c6f245c0bb9c2d21eea12d1bno06",
        "name" : "nosql-efa6_priam_node_1",
        "status" : "normal",
        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
        "private_ip" : "192.168.0.174",
        "spec_code" : "geminidb.redis.xlarge.4",
        "availability_zone" : "bbb"
      }, {
        "id" : "d57d76d6320a4a7b86db82c317550c4ano06",
        "name" : "nosql-efa6_priam_node_2",
        "status" : "normal",
        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
        "private_ip" : "192.168.0.175",
        "spec_code" : "geminidb.redis.xlarge.4",
        "availability_zone" : "bbb"
      }, {
        "id" : "f46b0a1cf4d9400e9fd7af17f8742d37no06",
        "name" : "nosql-efa6_priam_node_3",
        "status" : "normal",
        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
        "private_ip" : "192.168.0.176",
        "spec_code" : "geminidb.redis.xlarge.4",
        "availability_zone" : "bbb"
      } ]
    } ],
      "enterprise_project_id" : "0",
      "availability_zone": "cn-north-4a,cn-north-4b,cn-north-4c",
      "time_zone" : "",
      "actions" : [ "CREATE" ],
      "lb_ip_address" : "192.168.11.145",
      "lb_port" : "8635"
  }, {
    "id" : "1236a91546294036b75931e879882200in02",
    "name" : "nosql-efa7",
    "status" : "normal",
    "port" : "8635",
    "mode" : "ReplicaSet",
    "region" : "aaa",
    "datastore" : {
      "type" : "ReplicaSet",
      "version" : "4.0",
      "patch_available" : false
    },
    "engine" : "rocksDB",
    "created" : "2019-01-17T07:05:52",
    "updated" : "2019-01-17T07:05:47",
    "db_user_name" : "rwuser",
    "vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
    "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
    "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58",
    "backup_strategy" : {
      "start_time" : "16:00-17:00",
      "keep_days" : 7
    },
    "pay_mode" : 0,
    "maintenance_window" : "02:00-06:00",
    "groups" : [ {
      "id" : "0b0ff12541794e1084f6827e424be2d1gr02",
      "status" : "normal",
      "volume" : {
        "size" : 100,
        "used" : 0.003
      },
      "nodes" : [ {
        "id" : "233eaac9c6f245c0bb9c2d21eea12d1bno02",
        "name" : "nosql-efa7_replica_node_2",
        "status" : "normal",
        "role" : "Primary",
        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
        "private_ip" : "192.168.0.174",
        "public_ip" : "10.154.217.134",
        "spec_code" : "geminidb.mongodb.xlarge.4",
        "availability_zone" : "bbb"
      }, {
        "id" : "d57d76d6320a4a7b86db82c317550c4ano02",
        "name" : "nosql-efa7_replica_node_1",
        "status" : "normal",
        "role" : "Secondary",
        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
        "private_ip" : "192.168.0.39",
        "spec_code" : "geminidb.mongodb.xlarge.4",
        "availability_zone" : "bbb"
      }, {
        "id" : "f46b0a1cf4d9400e9fd7af17f8742d37no02",
        "name" : "nosql-efa7_replica_node_3",
        "status" : "normal",
        "role" : "Secondary",
        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
        "private_ip" : "192.168.0.176",
        "spec_code" : "geminidb.mongodb.xlarge.4",
        "availability_zone" : "bbb"
      } ]
    } ],
      "enterprise_project_id" : "0", 
      "availability_zone": "cn-north-4a,cn-north-4b,cn-north-4c",
      "time_zone" : "",
      "actions" : [ ]
  } ],
  "total_count" : 2
}

状态码

请参见状态码

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容