云数据库 RDS云数据库 RDS

计算
弹性云服务器 ECS
裸金属服务器 BMS
云手机 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器 HECS
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属企业存储服务
云存储网关 CSG
专属分布式存储服务 DSS
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘小站 IES
智能边缘平台 IEF
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
园区智能体 CampusGo
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
语音交互服务 SIS
知识图谱 KG
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
设备管理 IoTDM(联通用户专用)
全球SIM联接 GSL
IoT开发者服务
IoT数据分析
车联网服务 IoV
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
开发与运维
软件开发平台 DevCloud
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
开源镜像站 Mirrors
应用魔方 AppCube
云性能测试服务 CPTS
应用管理与运维平台 ServiceStage
云应用引擎 CAE
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
区块链
区块链服务 BCS
可信跨链服务 TCS
智能协作
IdeaHub
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
API问题定位指导
云生态
云市场
合作伙伴中心
华为云培训中心
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
云原生服务中心 OSC
容器批量计算 BCE
容器交付流水线 ContainerOps
应用服务网格 ASM
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB (for openGauss)
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
数据管理服务 DAS
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据湖治理中心 DGC
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
API网关 APIG
分布式缓存服务 DCS
分布式消息服务RocketMQ版
企业应用
域名注册服务 Domains
云解析服务 DNS
云速建站 CloudSite
网站备案
华为云WeLink
会议
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
API全生命周期管理 ROMA API
安全与合规
安全技术与应用
DDoS防护 ADS
Web应用防火墙 WAF
云防火墙 CFW
应用信任中心 ATC
企业主机安全 HSS
容器安全服务 CGS
云堡垒机 CBH
数据库安全服务 DBSS
数据加密服务 DEW
数据安全中心 DSC
云证书管理服务 CCM
SSL证书管理 SCM
漏洞扫描服务 VSS
态势感知 SA
威胁检测服务 MTD
管理检测与响应 MDR
安全治理云图 Compass
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
专属云
专属计算集群 DCC
解决方案
高性能计算 HPC
SAP
游戏云
混合云灾备
华为工业云平台 IMC
价格
成本优化最佳实践
专属云商业逻辑
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
更新时间:2021-11-30 GMT+08:00
分享

查询数据库实例列表

功能介绍

根据指定条件查询实例列表。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    GET /v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}&tags={key}={value}

  • URI样例
    • 查询所有实例列表

      https://rds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances

    • 根据指定条件查询实例列表

      https://rds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Ha&datastore_type=MySQL&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10&tags=rds001=001,rds002=002

  • 参数说明
    表1 参数说明

    名称

    参数类型

    是否必选

    说明

    project_id

    String

    租户在某一region下的project ID。

    获取方法请参见获取项目ID

    id

    String

    实例ID。

    “*”为系统保留字符,如果id是以“*”起始,表示按照*后面的值模糊匹配,否则,按照id精确匹配查询。不能只传入“*”。

    name

    String

    实例名称。

    “*”为系统保留字符,如果name是以“*”起始,表示按照*后面的值模糊匹配,否则,按照name精确匹配查询。不能只传入“*”。

    type

    String

    按照实例类型查询。取值Single、Ha、Replica、Enterprise,分别对应于单实例、主备实例和只读实例、分布式实例(企业版)。

    datastore_type

    String

    数据库类型,区分大小写。

    • MySQL
    • PostgreSQL
    • SQLServer

    vpc_id

    String

    虚拟私有云ID。

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

    subnet_id

    String

    子网的网络ID信息。

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

    offset

    Integer

    索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

    limit

    Integer

    查询记录数。默认为100,不能为负数,最小值为1,最大值为100。

    tags

    Array of objects

    根据实例标签键值对进行查询。

    • {key}表示标签键,不可以为空或重复。
    • {value}表示标签值,可以为空。

    如果同时使用多个标签键值对进行查询,中间使用逗号分隔开,最多包含10组。

    详情请参见表2

    表2 tags字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    key

    String

    键。最大长度127个unicode字符。key不能为空或者空字符串,不能为空格,使用之前先trim前后半角空格。不能包含+/?#&=,%特殊字符。

    value

    String

    值。最大长度255个unicode字符,使用之前先trim 前后半角空格。不能包含+/?#&=,%特殊字符。

    如果value为空,则表示any_value(查询任意value)。

请求消息

无。

响应消息

  • 正常响应要素说明
    表3 参数说明

    名称

    参数类型

    说明

    instances

    Array of objects

    实例信息。

    详情请参见表4

    total_count

    Integer

    总记录数。

    表4 instances字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    实例ID。

    name

    String

    创建的实例名称。

    status

    String

    实例状态。

    取值:

    值为“BUILD”,表示实例正在创建。

    值为“ACTIVE”,表示实例正常。

    值为“FAILED”,表示实例异常。

    值为“FROZEN”,表示实例冻结。

    值为“MODIFYING”,表示实例正在扩容。

    值为“REBOOTING”,表示实例正在重启。

    值为“RESTORING”,表示实例正在恢复。

    值为“MODIFYING INSTANCE TYPE”,表示实例正在转主备。

    值为“SWITCHOVER”,表示实例正在主备切换。

    值为“MIGRATING”,表示实例正在迁移。

    值为“BACKING UP”,表示实例正在进行备份。

    值为“MODIFYING DATABASE PORT”,表示实例正在修改数据库端口。

    值为“STORAGE FULL”,表示实例磁盘空间满。

    alias

    String

    实例的备注信息。

    private_ips

    List<String>

    实例内网IP地址列表。弹性云服务器创建成功后该值存在,其他情况下为空字符串。

    private_dns_names

    List<String>

    实例内网域名列表。实例创建成功后,需要手动申请内网域名,否则查询内网域名为空。

    public_ips

    List<String>

    实例外网IP地址列表。

    port

    Integer

    数据库端口号。

    • MySQL数据库端口设置范围为1024~65535(其中12017和33071被RDS系统占用不可设置)。
    • PostgreSQL数据库端口修改范围为2100~9500。
    • Microsoft SQL Server实例的端口设置范围为1433和2100~9500(其中5355和5985不可设置。对于2017 EE、2017 SE、2017 Web版,5050、5353和5986不可设置)。

    当不传该参数时,默认端口如下:

    • MySQL默认3306。
    • PostgreSQL默认5432。
    • Microsoft SQL Server默认1433。

    enable_ssl

    Boolean

    实例开启SSL标志。

    • 取值为“true”:表示实例已开启SSL。
    • 取值为“false”:表示实例未开启SSL。

    type

    String

    实例类型,取值为“Single”,“Ha”或“Replica”, "Enterprise",分别对应于单机实例、主备实例、只读实例、分布式实例(企业版)。

    ha

    Object

    HA信息,获取HA实例时返回。

    详情请参见表4

    region

    String

    实例所在区域。

    datastore

    Object

    数据库信息。

    详情请参见表5

    created

    String

    创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

    说明:创建时返回值为空,数据库实例创建成功后该值不为空。

    updated

    String

    更新时间,格式与“created”字段对应格式完全相同。

    说明:创建时返回值为空,数据库实例创建成功后该值不为空。

    db_user_name

    String

    默认用户名。

    vpc_id

    String

    虚拟私有云ID。

    subnet_id

    String

    子网的网络ID信息。

    security_group_id

    String

    安全组ID。

    flavor_ref

    String

    规格码。

    cpu

    String

    CPU大小。例如,1表示1U。

    mem

    String

    内存大小(单位:GB)。

    volume

    Object

    Volume信息。

    详情请参见表6

    switch_strategy

    String

    数据库切换策略。取值为“reliability”或“availability”,分别对应于可靠性优先和可用性优先。

    backup_strategy

    Object

    备份策略。

    详情请参见表7

    maintenance_window

    String

    可维护时间窗,为UTC时间。

    nodes

    Array of objects

    主备实例信息。

    详情请参见表8

    related_instance

    Array of objects

    所关联的数据库实例列表。

    详情请参见表9

    disk_encryption_id

    String

    磁盘加密密钥ID。

    enterprise_project_id

    String

    企业项目标签ID。

    time_zone

    String

    时区。

    charge_info

    Object

    计费类型信息,支持包年包月和按需,默认为按需。

    详情请参见表11

    tags

    Array of objects

    标签列表,没有标签默认为空数组。

    详情请参见表12

    backup_used_space

    Double

    备份空间使用量,单位GB。

    该字段仅用于查询指定SQL Server单个实例信息时返回。

    storage_used_space

    Double

    磁盘空间使用量,单位GB。

    该字段仅用于查询指定SQL Server单个实例信息时返回。

    order_id

    String

    订单ID,仅包周期场景返回。

    associated_with_ddm

    Boolean

    是否已被DDM实例关联。

    max_iops

    Long

    实例磁盘的最大IOPS值。

    当前该字段仅对于SQL Server引擎实例返回。

    expiration_time

    String

    实例的到期时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

    仅包周期场景返回。

    表5 ha字段数据结构说明

    名称

    参数类型

    说明

    replication_mode

    String

    备机同步参数。

    取值:非空。

    • MySQL为“async”或“semisync”。
    • PostgreSQL为“async”或“sync”。
    • Microsoft SQL Server为“sync”。
    说明:
    • “async”为异步模式。
    • “semisync”为半同步模式。
    • “sync”为同步模式。
    表6 datastore字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    数据库引擎,不区分大小写:

    • MySQL
    • PostgreSQL
    • SQLServer

    version

    String

    数据库版本。

    complete_version

    String

    数据库完整版本号。仅在数据库引擎是”PostgreSQL”时返回。

    表7 volume字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    磁盘类型。

    size

    Integer

    磁盘大小。

    表8 backup_strategy字段数据结构说明

    名称

    参数类型

    说明

    start_time

    String

    备份时间段。自动备份将在该时间段内触发。

    当前时间指UTC时间。

    keep_days

    Integer

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

    取值范围:0~732。为0时,表示未设置自动备份策略或备份策略已关闭。如果需要延长保留时间请联系客服人员申请,自动备份最长可以保留2562天。

    表9 nodes字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    节点ID。

    name

    String

    节点名称。

    role

    String

    节点类型,取值为“master”、“slave”或“readreplica”,分别对应于主节点、备节点和只读节点。

    status

    String

    节点状态。

    availability_zone

    String

    可用区。

    表10 related_instance字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    关联实例id。

    type

    String

    关联实例类型。

    • “replica_of”对应于“主实例”。
    • “replica”对应于“只读实例”。
    表11 chargeInfo字段数据结构说明

    名称

    是否必选

    参数类型

    说明

    charge_mode

    String

    计费模式。

    取值范围:

    • prePaid:预付费,即包年/包月。
    • postPaid:后付费,即按需付费。
    表12 tags字段数据结构说明

    名称

    参数类型

    说明

    key

    String

    标签键。

    value

    String

    标签值。

    响应样例中,“region”和 “availability_zone”的值为示例值。

  • 正常响应样例

    根据指定条件查询实例列表:

    {
    	"instances": [{
    	"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
    	"status": "ACTIVE",
    	"name": "mysql-0820-022709-01",
    	"port": 3306,
    	"type": "Single",
    	"region": "aaa",
    	"datastore": {
    		"type": "MySQL",
    		"version": "5.7"
    
    	},
    	"created": "2018-08-20T02:33:49+0800",
    	"updated": "2018-08-20T02:33:50+0800",
    	"volume": {
    		"type": "ULTRAHIGH",
    		"size": 100
    	},
    	"nodes": [{
    		"id": "06f1c2ad57604ae89e153e4d27f4e4b8no01",
    		"name": "mysql-0820-022709-01_node0",
    		"role": "master",
    		"status": "ACTIVE",
    		"availability_zone": "bbb"
    	}],
            "alias": "description",
    	"private_ips": ["192.168.0.142"],
    	"private_dns_names": ["ed7cc6166ec24360a5ed5c5c9c2ed726in01.internal.cn-xianhz-1.mysql.rds.myhuaweicloud.com"],
    	"public_ips": ["10.154.219.187", "10.154.219.186"],
            "enable_ssl": false,
    	"db_user_name": "root",
    	"vpc_id": "b21630c1-e7d3-450d-907d-39ef5f445ae7",
    	"subnet_id": "45557a98-9e17-4600-8aec-999150bc4eef",
    	"security_group_id": "38815c5c-482b-450a-80b6-0a301f2afd97",
    	"flavor_ref": "rds.mysql.s1.large",
            "cpu": "2",
            "mem": "4",
    	"switch_strategy": "",
            "charge_info": {
                "charge_mode": "postPaid"
            },
    	"backup_strategy": {
    		"start_time": "19:00-20:00",
    		"keep_days": 7
    	},
    	"maintenance_window": "02:00-06:00",
    	"related_instance": [],
    	"disk_encryption_id": "",
    	"enterprise_project_id": "0",
    	"time_zone": "",
            "tags": [
                {
                    "key": "rds001",
                    "value": "001"
                },
                {
                    "key": "rds002",
                    "value": "002"
                }
             ],
    	"associated_with_ddm": false
    }], "total_count": 1
    }
  • 查询所有实例列表:

    {
    	"instances": [{
    		"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
    		"status": "ACTIVE",
    		"name": "mysql-0820-022709-01",
    		"port": 3306,
    		"type": "Single",
    		"region": "aaa",
    		"datastore": {
    			"type": "MySQL",
    			"version": "5.7"
    
    		},
    		"created": "2018-08-20T02:33:49+0800",
    		"updated": "2018-08-20T02:33:50+0800",
    		"volume": {
    			"type": "ULTRAHIGH",
    			"size": 100
    		},
    		"nodes": [{
    			"id": "06f1c2ad57604ae89e153e4d27f4e4b8no01",
    			"name": "mysql-0820-022709-01_node0",
    			"role": "master",
    			"status": "ACTIVE",
    			"availability_zone": "bbb"
    		}],
                    "alias": "description",
    		"private_ips": ["192.168.0.142"],
                    "enable_ssl": false,
    		"private_dns_names": ["ed7cc6166ec24360a5ed5c5c9c2ed726in01.internal.cn-xianhz-1.mysql.rds.myhuaweicloud.com"],
    		"public_ips": ["10.154.219.187", "10.154.219.186"],
    		"db_user_name": "root",
    		"vpc_id": "b21630c1-e7d3-450d-907d-39ef5f445ae7",
    		"subnet_id": "45557a98-9e17-4600-8aec-999150bc4eef",
    		"security_group_id": "38815c5c-482b-450a-80b6-0a301f2afd97",
    		"flavor_ref": "rds.mysql.s1.large",
                    "cpu": "2",
                    "mem": "4",
    		"switch_strategy": "",
                    "charge_info": {
                        "charge_mode": "postPaid"
                    },
    		"backup_strategy": {
    			"start_time": "19:00-20:00",
    			"keep_days": 7
    		},
    		"maintenance_window": "02:00-06:00",
    		"related_instance": [],
    		"disk_encryption_id": "",
    		"enterprise_project_id": "0",
    		"time_zone": "",
        		        "tags" [
         	       {
           		         "key": "rds001",
           		         "value": "001"
          		      },
         		       {
          		          "key": "rds002",
          		          "value": "002"
         		       }
       		      ],
    		"associated_with_ddm": false
    	}, {
    		"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in02",
    		"status": "ACTIVE",
    		"name": "mysql-0820-022709-02",
    		"port": 3306,
    		"type": "Single",
    		"region": "aaa",
    		"datastore": {
    			"type": "MySQL",
    			"version": "5.7"
    		},
    		"created": "2018-08-20T02:33:49+0800",
    		"updated": "2018-08-20T02:33:50+0800",
    		"volume": {
    			"type": "ULTRAHIGH",
    			"size": 100
    		},
    		"nodes": [{
    			"id": "06f1c2ad57604ae89e153e4d27f4e4b8no01",
    			"name": "mysql-0820-022709-01_node0",
    			"role": "master",
    			"status": "ACTIVE",
    			"availability_zone": "bbb"
    		}],
                    "alias": "description",
    		"private_ips": ["192.168.0.142"],
    		"private_dns_names": ["ed7cc6166ec24360a5ed5c5c9c2ed726in01.internal.cn-xianhz-1.mysql.rds.myhuaweicloud.com"],
    		"public_ips": ["10.154.219.187", "10.154.219.186"],
                    "enable_ssl": false,
    		"db_user_name": "root",
    		"vpc_id": "b21630c1-e7d3-450d-907d-39ef5f445ae7",
    		"subnet_id": "45557a98-9e17-4600-8aec-999150bc4eef",
    		"security_group_id": "38815c5c-482b-450a-80b6-0a301f2afd97",
    		"flavor_ref": "rds.mysql.s1.large",
                    "cpu": "2",
                    "mem": "4",
    		"switch_strategy": "",
                    "charge_info": {
                        "charge_mode": "postPaid"
                    },
    		"backup_strategy": {
    			"start_time": "19:00-20:00",
    			"keep_days": 7
    		},
    		"maintenance_window": "02:00-06:00",
    		"related_instance": [],
    		"disk_encryption_id": "",
    		"enterprise_project_id": "0",
    		"time_zone": "",
        		        "tags" [
         	       {
           		         "key": "rds001",
           		         "value": "001"
          		      },
         		       {
          		          "key": "rds002",
          		          "value": "002"
         		       }
       		      ],
    		"associated_with_ddm": false
    	}],
    	"total_count": 2
    }
  • 异常响应

    请参见异常请求结果

状态码

请参见状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读