华为云用户手册

操作步骤 登录智能数据洞察控制台。 单击管理控制台左上角的，选择区域。 单击左下角的企业项目选择企业项目。 单击控制台左侧菜单“系统设置”，进入系统设置页面。 图1 菜单栏 选择“标签管理”。 单击“新增标签”。 输入标签名称与标签的描述信息。 单击“确定”保存标签。 标签设置完成后，请为用户/用户组赋予标签值。 双击标签值的输入框，输入标签值后回车即可保存。 示例：按数据集授权要求，新增用户标签country、industry、segment。 分别为用户P1、P2、P3赋予标签值，如图2所示。 图2 用户标签示例 如果编辑/删除标签，则单击标签名右侧三点处，编辑/删除标签。

样式 本章节介绍台阶图样式各项配置项的含义。 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位px。 X：设置图表在画布中的位置。单位为px。 Y：设置图表在画布中的位置。单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 字体：设置图表中文字的字体。 数据点位置：设置台阶图数据点位置，支持设置为起点、中点、终点。 图2 全局样式 边距 顶部：设置图表与图层顶部的间距，可以通过输入数值或单击“-”或“+”调节。 底部：设置图表与图层底部的间距，可以通过输入数值或单击“-”或“+”调节。 左侧：设置图表与图层左侧的间距，可以通过输入数值或单击“-”或“+”调节。 右侧：设置图表与图层右侧的间距，可以通过输入数值或单击“-”或“+”调节。 图3 边距

样式 设置仪表盘样式参考表2、表3。 表2 仪表盘样式参数 参数 说明 卡片标题 卡片支持有和无标题的设置。设置卡片的标题，在卡片的左上角展示。 无标题：当未勾选框时，为无标题格式。 有标题：当勾选框时，为有标题格式。 文本 设置文本字体的大小和字体颜色。可通过输入修改字体大小也可通过和修改字体的大小。 说明： 输入不能为空，且输入值必须在14到32之间。 对齐方式 支持左对齐和居中对齐方式。 下边距 设置仪表盘标题与图表之间的距离。可通过输入修改边距的大小也可通过和修改边距的大小。 说明： 输入不能为空，且输入值必须在0到32之间。 分割线 卡片支持无和有分割线的设置。 无分割线：当未勾选框时，为无分割线格式。 有分割线：当勾选框时，为有分割线格式。支持对分割线的样式和下框边距进行设置。分割线样式和下边框支持输入设置，也可通过和进行设置。 说明： 分割线样式的输入不能为空，且输入值必须在0到8之间。在设置样式之后才可以设置下边距，分割线的下边距输入不能为空，且输入值必须在0到32之间。 卡片背景 卡片背景支持有背景和无背景设置。 无背景：当未勾选框时，为无背景格式。 有背景：当勾选框时，为有背景格式。支持背景颜色的设置。 状态icon 可以设置icon的显示方式和颜色，支持始终显示和悬停显示。卡片icon支持有状态icon和无状态icon设置。 无背景：当未勾选框时，为无状态icon。 有背景：当勾选框时，为有状态icon。 表3 仪表盘图表样式参数 参数 说明 可视化样式 支持对坐标轴的坐标线和颜色的设置。 数值设置 支持对轴标签的文本和文本颜色的设置。 数据标签 支持对网格线的粗细和颜色设置。 测量轴色彩配置 支持对尺度类型设置，有线性和对数两种功能。 刻度分区 设置仪表盘的刻度分区。 起点 起点支持设置为固定值或动态值。 终点 终点支持设置为固定值或动态值 坐标轴：支持对轴标签的文本字体大小进行设置。 表4 系列设置 参数 说明 选择度量 根据字段里面选择的度量选择。 语境 对系列的语境进行设置，支持中文（简体）和English 单位 单位支持自动、无、百、千、万、亿、百亿、万亿。 科学计数法 支持使用科学计数法或不支持。 使用千分位分割符 支持使用千分位分割符或不支持。 小数位 支持设置小数位或不支持。

更多操作 您还可以根据需要执行以下操作，具体请参见表 相关操作。 表6 相关操作 操作 说明 改变指标排列顺序 在“指标量（最近10分钟）”或“占比”列后单击，可改变指标在列表中的排列顺序。为默认排序，为按大小正序排序（即数据大的显示在最后方），为按大小倒序排序（即数据小的显示在最后方）。 新增指标 单击“新增指标”，在指标列表中选择需要新增的指标，单击“确定”。 说明： 单次新增指标最多支持新增100个指标。 废弃指标 废弃一个指标：选择一个指标，单击操作列的。 废弃一个或多个指标：选中一个或多个指标前的复选框，在弹出框中选择“废弃”，可以废弃一个或多个指标。 说明： 单次废弃指标最多支持废弃100个指标。

注意事项 目前仅default类型、CCE类型、云服务类型、通用实例、E CS 类型的Prometheus实例支持指标查看、新增和废弃功能。 default类型的Prometheus实例下，指标名以“aom_”、“apm_”开头以及资源类型为ICAgent的指标暂不支持废弃。 ECS类型的Prometheus实例仅支持展示和配置UniAgent插件采集的指标。 CCE类型的Prometheus实例仅支持废弃如下指标： 只有在CCE “插件市场” 页面或 AOM “集成中心” 页面安装的3.9.0以上的云原生监控插件（kube-prometheus-stack）上报的指标可以被废弃，且只有kube-prometheus-stack处于“运行中”状态时，指标才能废弃成功。 查看kube-prometheus-stack插件状态的方法：登录CCE控制台，单击集群名称进入集群，在左侧导航栏中选择“插件中心”，在右侧找到“云原生监控插件”卡片，查看插件的状态。

前提条件 服务已接入CCE类型Prometheus 监控并接入CCE集群，具体请参见Prometheus实例 for CCE。 服务已接入云服务类型Prometheus 监控并接入云服务，具体请参见Prometheus实例 for 云服务。 服务已接入ECS类型Prometheus监控并接入插件，具体请参见Prometheus实例 for ECS。 服务已接入通用实例类型Prometheus 监控，具体请参见Prometheus 通用实例。

前提条件 已购买弹性 云服务器ECS ，具体操作请参见《弹性云服务器快速入门》。 已购买弹性公网IP，并绑定到购买的弹性云服务器ECS上，具体操作请参见《弹性公网IP快速入门》。 服务已接入可观测Prometheus 监控。具体操作，请参见： Prometheus实例 for 云服务 Prometheus实例 for ECS Prometheus实例 for CCE Prometheus 通用实例 Prometheus实例 for 多账号聚合实例

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 backup_policy 是 Object 备份策略信息。 详情参见表3。 表3 backup_policy字段数据结构说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 备份文件可以保存的天数。 取值范围：1-36500天。 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1，mm和MM取值必须相同，且取值必须为00。 取值示例： 21:00-22:00 说明： 该时间段为执行备份的UTC时间段。比如备份时间是当地时间05:00-06:00，时区为UTC+08:00，则接口需要传入21:00-22:00；如果时区为UTC+04:00，接口传入01:00-02:00。 period 是 String 全量备份周期配置。自动全量备份将在每周对应的UTC日期进行。 取值范围：格式为逗号隔开的数字，数字代表星期，取1~7。 取值示例： 1,2,3,4 表示备份周期配置为星期一、星期二、星期三和星期四。 1,2,3,4,5,6,7 则表示星期一至星期日每天执行一次自动备份。 1,3,5表示周一、周三、周五执行一次自动备份。 说明： 该时间段为执行备份的UTC日期。比如备份时间为当地时间周一、周二05:00-06:00，时区为UTC+08:00，则period传入1,7；如果时区为UTC+04:00，period传入1,2。 differential_period 是 String 差异备份间隔时间配置。每次自动差异备份的间隔时间。 取值范围：15、30、60、180、360、720、1440。单位：分钟。 取值示例：30 rate_limit 否 Integer 备份限速,默认值为0MB/s，表示不限速。控制备份是备份数据上传OBS的速度，限速用于限制上传备份对上传带宽的影响 取值范围：0~ 1024 最小值：0 MB/s prefetch_block 否 Integer 控制差量备份时读取磁盘上表文件差量修改页面的预取页面个数。当差量修改页面非常集中时（如数据导入场景），可以适当调大该值；当差量修改页面非常分散时（如随机更新），可以适当调小该值。默认为64,单位个数 取值范围：1 ~ 8192 最小值：1 最大值：8192 file_split_size 否 Integer 全量、差量备份时产生的备份文件会根据该参数的值进行拆分，可设置范围为0~1024GB，设置需为4的倍数，默认4GB，0GB表示不限制大小。 取值范围：0 ~ 1024 最小值：0 最大值：1024 enable_standby_backup 否 Boolean 是否启用备机备份。(不支持单节点实例及3.100.0以下的实例)

URI PUT https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/backups/policy 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 设置 GaussDB 实例备份策略，备份文件保存时长7天，备份时间段为19:00-20:00。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy { "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2,3,4,5", "differential_period": "30", "rate_limit": 75 , "prefetch_block": 64 , "file_split_size": 4 , "enable_standby_backup" : false } }

请求示例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy { "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2,3,4,5", "differential_period": "30" } }

URI PUT https://{Endpoint}/gaussdb/v3/{project_id}/instances/{instance_id}/backups/policy 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 backup_policy 是 Object 备份策略信息。 详情参见表3。 表3 backup_policy字段数据结构说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 备份文件可以保存的天数。 取值范围：1-732天。 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1，mm和MM取值必须相同，且取值必须为00。 取值示例： 21:00-22:00 period 是 String 全量备份周期配置。自动全量备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字代表星期。取值示例：1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。 differential_period 是 String 差异备份间隔时间配置。每次自动差异备份的间隔时间。 取值范围：15、30、60、180、360、720、1440。单位：分钟。 取值示例：30

API概览 通过使用GaussDB接口，您可以使用GaussDB的创建实例、删除实例、查询实例列表、获取与修改指定实例参数、设置与查询自动备份策略等功能，详情请参见下表。 类型 子类型 说明 GaussDB 接口 引擎版本和规格 包括查询数据库引擎的版本、查询数据库规格、查询引擎列表、查询实例可变更规格接口。 GaussDB 接口 磁盘管理 包括查询数据库磁盘类型等接口。 GaussDB 接口 实例管理 包括创建实例、扩容实例磁盘空间、删除实例、查询实例列表、获取指定实例、CN横向扩容、DN分片扩容、重置数据库密码、修改实例名称接口，查询实例组件列表，规格变更，分片节点主备切换、重启数据库实例、查询实例主备平衡状态、查询解决方案模板配置、查询已绑定的EIP列表、弱密码校验、绑定公网IP、解绑公网IP、查询实例SSL证书下载地址、查询租户的实例配额接口。 GaussDB 接口 参数配置 包括修改指定实例参数、获取参数模板列表、获取指定实例的参数、创建参数模板、删除参数模板、查询参数模板详情、复制参数模板、重置参数组、比较两个参数组模板之间的差异、查询可应用实例列表、校验参数组名称是否存在、应用参数模板、查询参数模板的应用记录、查询参数模板的修改历史接口。 GaussDB 接口 备份恢复管理 包括设置自动备份策略、查询自动备份策略、查询备份列表、创建手动备份、删除手动备份、查询可恢复时间段、恢复到新实例、查询可用于备份恢复的实例列表、根据时间点或者备份文件查询原实例信息接口。 GaussDB 接口 管理数据库和用户 包括创建数据库、创建数据库用户、创建数据库SCHEMA、授权数据库账号、重置数据库账号密码、查询数据库列表、查询数据库用户列表、查询数据库SCHEMA列表接口。 GaussDB 接口 标签管理 包括查询实例标签、查询项目标签、查询预定义标签、添加实例标签接口。 GaussDB 接口 配额管理 包括修改企业项目配额、查询企业项目配额组接口。 GaussDB 接口 任务管理 包括获取任务信息、查询任务列表、删除任务记录接口。 GaussDB 接口 回收站 包括设置回收站策略、查看回收站策略、查询回收站所有引擎实例列表接口。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 upgrade_type 是 String 实例升级类型，区分大小写。包括就地升级，灰度升级，热补丁升级三种，三种升级方式的异同，详见接口描述。 inplace：就地升级。 grey：灰度升级。 hotfix：热补丁升级。 upgrade_action 否 String 实例升级操作，区分大小写。 实例升级类型是就地升级时非必选。 灰度升级包括升级自动提交、升级待观察、提交升级和升级回退四种。 热补丁升级包括升级自动提交，升级回退两种。 upgradeAutoCommit：升级自动提交 。 upgrade：升级待观察。 commit：提交升级。 rollback：升级回退。 target_version 否 String 实例升级目标版本。 热补丁升级场景下支持传入多个热补丁版本。 upgrade_shard_num 否 Integer 分布式实例灰度升级分片数。分布式实例灰度升级，升级待观察必填。该值不能大于实例未升级分片总数。 upgrade_az 否 String 灰度升级，升级待观察AZ值，升级待观察时必填。可以支持多AZ一起升级，AZ之间以英文逗号分隔。不能填入不属于该实例的AZ值。

请求示例 就地升级。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "inplace", "target_version": "xxx" } 热补丁升级 实例热补丁升级。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "hotfix", "target_version" : "xxxx,xxxx,xxxx", "upgrade_action" : "upgradeAutoCommit" } 实例热补丁升级回退。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type": "hotfix", "target_version": "xxxx,xxxx,xxxx", "upgrade_action": "rollback" } 灰度升级 实例灰度升级并采用升级自动提交升级方式升级。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "upgradeAutoCommit" } 实例灰度升级并采用升级待观察方式升级。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "upgrade", "upgrade_shard_num" : 1, } 实例灰度升级并采用升级待观察方式升级，当实例处于升级待观察状态中，可进行升级回退，会回退全部已升级的分片，实例恢复正常后回退成功。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "rollback" } 实例灰度升级并采用升级待观察方式升级，当实例处于升级待观察状态中，且全部分片都升级完成后，可进行升级提交。实例恢复正常后升级完成。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "commit" } 主备版实例灰度升级并采用升级待观察方式升级传参。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "upgrade_action" : "upgrade", "target_version": "xxx", "upgrade_az" : "az1,az2" }

URI PUT https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/db-upgrade 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID，严格匹配UUID规则。

功能介绍 GaussDB实例版本升级。包括就地升级，灰度升级，热补丁升级三种升级方式。 就地升级 就地升级需要停止业务进行，会一次性升级集群中所有节点。就地升级需要暂停业务30分钟来升级。 灰度升级 每个主DN或者CN组件升级就有一次10秒业务中断。升级过程均是先管理面，再数据面，由备到主的升级方式。灰度升级支持升级自动提交和升级待观察两种操作方式。 升级自动提交：所有节点进程一起升级，在升级过程中有大概10秒的业务中断，不阻塞其他业务操作。 升级待观察：升级待观察，将数据库升级过程细分为升级，提交两个阶段。 升级阶段可以根据部署方式细分为按分片或者按AZ的滚动升级。 分布式实例：根据分片数滚动升级。 主备版实例：根据AZ数进行滚动升级。 提交阶段可以对升级完成后的实例进行业务测试，根据需要可以选择提交升级或者升级回退。 提交升级：在升级完成进入提交阶段时，业务测试正常后提交升级，完成本次升级流程。 升级回退：在升级完成进入提交阶段时，可以根据需要回退本次升级，回退到升级前的版本。 热补丁升级 升级自动提交：热补丁自动升级并提交，中间无业务中断。 升级回退：热补丁回退，无业务中断时间。 调用接口前，您需要了解API 认证鉴权。 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

请求示例 查询所有实例列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/97b026aa9cc4417888c14c84a1ad9860/instances 根据指定条件查询实例列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in14&name=hy&type=Enterprise&datastore_type=GaussDB&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10

URI GET https://{Endpoint}/v3.1/{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} 表1 参数说明 参数 参数类型 是否必选 描述 project_id String 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 id String 否 参数解释： 实例ID，此参数是用户创建实例的唯一标识，用于查询某一实例的列表。 约束限制： “*”为系统保留字符，如果id是以“*”起始，表示按照*后面的值模糊匹配，否则，按照id精确匹配查询。不能只传入“*”。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 name String 否 参数解释： 实例名称，可按照实例名称查询实例列表。 约束限制： “*”为系统保留字符，如果name是以“*”起始，表示按照*后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“*”。 取值范围： 实例名称长度在4个到64个字符之间，必须以字母开头，可以包含字母、数字、中划线或下划线，不能包含其他特殊字符。 默认取值： 不涉及。 type String 否 参数解释： 实例类型，可按照实例类型查询实例列表。 约束限制： 不涉及。 取值范围： Enterprise（区分大小写），对应分布式实例（独立部署）。 Centralization_standard（区分大小写），对应主备版实例。 默认取值： 不涉及。 datastore_type String 否 参数解释： 数据库类型，不区分大小写，可按照数据库类型查询实例列表。 约束限制： 不涉及 取值范围： GaussDB 默认取值： 不涉及。 vpc_id String 否 参数解释： 虚拟私有云ID。可按照实例所在虚拟私有云查询实例列表。获取方法如下。 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 约束限制： 不涉及。 取值范围： 符合UUID形式。 默认取值： 不涉及。 subnet_id String 否 参数解释： 子网的网络ID信息。可按照实例所在子网的网络ID查询实例列表。获取方法如下。 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 约束限制： 不涉及。 取值范围： 符合UUID形式。 默认取值： 不涉及。 offset Integer 否 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 必须为数字，不能为负数。 取值范围： [0, 2^31-1] 默认取值： 默认为0偏移0条数据，表示从第一条数据开始查询）。 limit Integer 否 参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： [1, 100] 默认取值： 默认为100。 tags String 否 参数解释： {key}表示标签键。 {value}表示标签值。 可根据实例标签键值查询实例列表。 约束限制： 如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，最多包含20组。 取值范围： {key}最大长度127个unicode字符。key不能为空或者空字符串，不能为空格，使用之前先trim前后半角空格。不能包含+/?#&=,%特殊字符。 {value}可以为空。最大长度255个unicode字符，使用之前先trim 前后半角空格。不能包含+/?#&=,%特殊字符。如果value为空，则表示any_value（查询任意value）。 默认取值： 不涉及。 charge_mode String 否 参数解释： 计费模式。可按照计费模式查询实例列表。 约束限制： 不涉及。 取值范围： postPaid：后付费，即按需付费。 prePaid：预付费，即 包年/包月。 默认取值： 不涉及。

响应示例 实例列表： { "instances": [ { "id": "b331ed66cc3249f78bc20737308c01f4in14", "status": "ACTIVE", "name": "gauss-9e88", "port": 8000, "type": "Enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "eu-de", "datastore": { "type": "GaussDB", "version": "2.7", "complete_version": "2.7.2", "hotfix_versions": "2.7.2.1,2.7.2.2", "target_version": "3.208.0", "hotfix_finished_times": [ "2020-12-23 03:21:41 UTC", "2020-12-23 03:22:41 UTC" ] }, "created": "2021-01-15 01:46:40 UTC", "updated": "2021-01-15 02:05:03 UTC", "volume": { "type": "ULTRAHIGH", "size": 120 }, "nodes": [ { "id": "02ebf757aaf94074855f49cc6e0e4712no14", "name": "gauss-9e88_gaussdbv5cn_2", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.16.253", "component_names": "cn_5001:" }, { "id": "0a87b8ecbfeb46aba1409cfc0f0d5c34no14", "name": "gauss-9e88_gaussdbv5cn_0", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.28.81", "component_names": "cn_5002:" }, { "id": "2d9fec1ab3834936b074d63acf48b1f2no14", "name": "gauss-9e88_gaussdbv5dn3_2", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "48bb08a2d635435891ac0caa1c0bf2e3no14", "name": "gauss-9e88_gaussdbv5dn1_0", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "5df830f652204827ada32f8bc28b107eno14", "name": "gauss-9e88_gaussdbv5dn1_1", "role": "slave", "status": "ACTIVE", "component_names": "dn_6002:60011", "availability_zone": "az2xahz" }, { "id": "8a97a246cee841b38c5b47290d4c9c38no14", "name": "gauss-9e88_gaussdbv5cn_1", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.27.52", "component_names": "cn_5003:" }, { "id": "8c1a3f8eecca4d9e9974a868bb6dd942no14", "name": "gauss-9e88_gaussdbv5dn2_0", "role": "master", "status": "ACTIVE", "component_names": "dn_6004:60042", "availability_zone": "az2xahz" }, { "id": "9bd0c80b8a684cc9bd7d99dd5adffb07no14", "name": "gauss-9e88_gaussdbv5dn3_1", "role": "slave", "status": "ACTIVE", "component_names": "dn_6005:60073", "availability_zone": "az2xahz" }, { "id": "9e2a3cd541e249d4af5aa57c5d3a7f39no14", "name": "gauss-9e88_gaussdbv5dn1_2", "role": "slave", "status": "ACTIVE", "component_names": "dn_6006:60011", "availability_zone": "az2xahz" }, { "id": "b046d28989ec4ae5a1a9ab20fe65f248no14", "name": "gauss-9e88_gaussdbv5dn2_2", "role": "slave", "status": "ACTIVE", "component_names": "dn_6007:60042", "availability_zone": "az2xahz" }, { "id": "b614cc12fd3742dbb230245f88a7bf00no14", "name": "gauss-9e88_gaussdbv5dn3_0", "role": "slave", "status": "ACTIVE", "component_names": "dn_6008:60073", "availability_zone": "az2xahz" }, { "id": "caba8e88c3c84ae58202f1f589490611no14", "name": "gauss-9e88_gaussdbv5dn2_1", "role": "slave", "status": "ACTIVE", "component_names": "dn_6009:60042", "availability_zone": "az2xahz" } ], "private_ips": [ "192.168.16.253 / 192.168.28.81 / 192.168.27.52" ], "replica_num": 3, "db_user_name": "root", "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info": { "vcpu": 2, "mem": 16 }, "switch_strategy": "Reliability", "charge_info": { "charge_mode": "postPaid" }, "backup_strategy": { "start_time": "19:00-20:00", "keep_days": 7 }, "maintenance_window": "18:00-22:00", "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab", "enterprise_project_id": "6e76681b-a2f5-4c5f-97c5-ba4fd3c0dfb2", "time_zone": "UTC+08:00", "instance_mode":"enterprise", "disk_usage": "0.9890", "backup_used_space": "37846" }, { "id": "226b4afcfcc84c86bf1b9cb345d3b00fin14", "status": "ACTIVE", "name": "UTS-gauss-ad53-2C3D", "port": 8000, "type": "Enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "cn-xianhz-1", "datastore": { "type": "GaussDB", "version": "2.7", "complete_version": "2.7.2", "hotfix_versions": "2.7.2.1,2.7.2.2", "target_version": "3.208.0", "hotfix_finished_times": [ "2020-12-23 03:21:41 UTC", "2020-12-23 03:22:41 UTC" ] }, "created": "2021-01-08 09:18:27 UTC", "updated": "2021-01-14 13:25:03 UTC", "volume": { "type": "ULTRAHIGH", "size": 120 }, "nodes": [ { "id": "07538a1def584cee99e2a5685eeab36ano14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_1", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "21f41baba1e2454f82331b7cb5aeabe5no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_2", "role": "master", "status": "ACTIVE", "component_names": "dn_6008:60042", "availability_zone": "az2xahz" }, { "id": "2909771a3b3e4e3998f9388e77d22391no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_0", "role": "slave", "status": "ACTIVE", "component_names": "dn_6007:60011", "availability_zone": "az2xahz" }, { "id": "2bd9a90a5da242a6b0743a7f597f6106no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_2", "role": "master", "status": "ACTIVE", "component_names": "dn_6006:60042", "availability_zone": "az2xahz" }, { "id": "77092f1dadb74d3ea13d28269cdd3590no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_2", "role": "master", "status": "ACTIVE", "component_names": "dn_6005:60072", "availability_zone": "az2xahz" }, { "id": "a46bfaa6d5a24355a60fce7432b964cano14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_0", "role": "slave", "status": "ACTIVE", "component_names": "dn_6004:60072", "availability_zone": "az2xahz" }, { "id": "aa5277736f3844e2a7adeb9de529e2b1no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_1", "role": "slave", "status": "ACTIVE", "component_names": "dn_6003:60042", "availability_zone": "az2xahz" }, { "id": "b1d798e4ea7344dfa95032984bc6cfd7no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5cn_1", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.29.231", "component_names": "cn_5002:" }, { "id": "b9a46540186f4c0781eabaa2a79594cbno14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_1", "role": "slave", "status": "ACTIVE", "component_names": "dn_6002:60011", "availability_zone": "az2xahz" }, { "id": "d283813030364060ab64371d50294977no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_0", "role": "slave", "status": "ACTIVE", "component_names": "dn_6001:60042", "availability_zone": "az2xahz" }, { "id": "eb7bce29b2284cd290405eaddc1b1a1eno14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5cn_0", "role": "master", "status": "FAILED", "availability_zone": "az2xahz", "private_ip": "192.168.30.44", "component_names": "cn_5001:", "public_ip": "10.154.217.248" } ], "private_ips": [ "192.168.29.231 / 192.168.30.44" ], "public_ips": [ "10.154.217.248" ], "replica_num": 3, "db_user_name": "root", "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info": { "vcpu": 2, "mem": 16 }, "switch_strategy": "Reliability", "charge_info": { "charge_mode": "postPaid" }, "backup_strategy": { "start_time": "18:00-19:00", "keep_days": 7 }, "maintenance_window": "18:00-22:00", "enterprise_project_id": "0", "time_zone": "UTC+08:00", "instance_mode":"enterprise", "disk_usage": "1.0000", "backup_used_space": "55824" }, { "id": "7139e0eee4ac4922927f22e22114a548in14", "status": "ACTIVE", "name": "gauss-readonly", "port": 8000, "type": "centralization_standard", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "cn-xianhz-1", "datastore": { "type": "GaussDB", "version": "3.220", "complete_version": "3.220.0", "complete_kernel_version": "503.1.0.SPC1500", "target_version": "3.208.0", "hotfix_finished_times": [ "2020-12-23 03:21:41 UTC", "2020-12-23 03:22:41 UTC" ] }, "created": "2024-06-04 03:41:19 UTC", "updated": "2024-06-18 02:01:17 UTC", "volume": { "type": "ULTRAHIGH", "size": 40 }, "nodes": [ { "id": "7fd28bb9a142491a8b0f57ef3c662a2ano14", "name": "gauss-readonly_readonly_4", "role": "readreplica", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.167.105", "component_names": "dn_6005:60011", "flavor_ref": "gaussdb.opengauss.ee.c3.xlarge.x864.ha", "flavor_info": { "vcpu": "4", "mem": "16" } }, { "id": "c532d75f8ee44b4e8ef8bf291bf8ed98no14", "name": "gauss-readonly_readonly_3", "role": "readreplica", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.184.6", "component_names": "dn_6004:60011", "flavor_ref": "gaussdb.opengauss.ee.c3.xlarge.x864.ha", "flavor_info": { "vcpu": "4", "mem": "16" } }, { "id": "1624226d9281469fa2fc865299b62999no14", "name": "gauss-readonly_root_1", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.243.237", "component_names": "cm_2:,dn_6002:60011,etcd_7002:" }, { "id": "236b7fb1e28e4caba6cf90e4739ed4d8no14", "name": "gauss-readonly_root_0", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.232.222", "component_names": "cm_1:,dn_6001:60011,etcd_7001:" }, { "id": "bfe9bff81020427a983588f5e00c7832no14", "name": "gauss-readonly_root_2", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.135.66", "component_names": "cm_3:,dn_6003:60011,etcd_7003:" } ], "private_ips": [ "192.168.167.105 / 192.168.184.6 / 192.168.243.237 / 192.168.232.222 / 192.168.135.66" ], "replica_num": 3, "db_user_name": "root", "vpc_id": "caacd96c-6643-4106-9fea-8cab88f556c08", "subnet_id": "be02c6ca-b3b9-423e-a472-fd043e19d7b7", "security_group_id": "6b95cf16-0555-4997-96c3-udb19ac24384", "flavor_ref": "gaussdb.opengauss.ee.c3.xlarge.x864.ha", "flavor_info": { "vcpu": 4, "mem": 16 }, "charge_info": { "charge_mode": "postPaid" }, "backup_strategy": { "start_time": "18:00-19:00", "keep_days": 7 }, "maintenance_window": "18:00-22:00", "enterprise_project_id": "0", "time_zone": "UTC+08:00", "instance_mode": "basic", "backup_used_space": "1595991", "disk_usage": "0.6922" } ], "total_count": 3 }

错误码 错误码列表： 表1 错误码列表 状态码 错误码 错误信息 描述 处理措施 400 DBS.200001 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 400 DBS.200004 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 400 DBS.200006 The request is null. Enter a request parameter. 请求为空，请输入请求参数。 请输入请求参数后重试。 400 DBS.200021 Invalid DB instance name. 实例名非法。 请参考对应实例名的参数说明输入符合要求的实例名后重试。 400 DBS.200023 Storage space is out of range. 卷大小超出允许范围。 检查磁盘大小的值是否正确。 400 DBS.200024 Invalid region. Region非法。 请输入正确的 Region ID。 400 DBS.200025 Invalid AZ. 可用区取值非法。 检查可用区的参数是否正确，可用区是否存在。 400 DBS.200026 Invalid storage type. 卷类型非法。 检查磁盘的类型是否正确，是否符合要求。 400 DBS.200027 Storage space must be a multiple of 10. 卷大小不是10的整数倍。 检查磁盘大小是否是10的倍数。 400 DBS.200040 The DB engine or version is not supported. 不支持的数据库类型或版本。 检查数据库引擎或版本是否支持。 400 DBS.200041 Invalid database version. 数据库版本非法。 检查数据库的版本号是否支持。 400 DBS.200042 The DB engine does not exist. 不支持的数据库类型或版本。 检查数据库类型或版本是否正确。 400 DBS.200043 Invalid synchronize model. HA同步模式非法。 检查同步模式是否正确。 400 DBS.200048 Invalid VPC ID. VPC ID非法。 检查VPC ID是否正确。 400 DBS.200049 Invalid subnet ID. 子网的网络ID非法。 检查子网ID是否正确。 400 DBS.200051 Invalid HA mode. 不合法的HA模式。 检查HA模式是否正确。 400 DBS.200052 Invalid database root password. 数据库root密码非法。 检查数据库root密码是否符合要求。 400 DBS.200053 The selected specifications do not exist. 所选规格不存在。 检查所选规格是否正确。 400 DBS.200054 Invalid specifications. 所选规格非法。 检查规格码是否正确，规格在当前可用区是否存在，规格是否支持。 400 DBS.200056 The maximum number of nodes has been reached. 节点个数达到最大值。 检查节点个数是否已达到最大值。 400 DBS.200063 Invalid cluster mode. 集群模式非法。 检查集群模式是否合法。 400 DBS.200068 This is a weak password. Please enter a strong password. 这是一个弱密码，请输入一个强度大一些的密码。 请参考对应的密码参数说明，输入符合密码复杂度要求，且强度更高的密码。 400 DBS.200085 The quota is insufficient. 配额不足。 检查配额是否充足。 400 DBS.200086 This operation is not allowed by the DB instance status. 实例状态不允许做该操作。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.200087 The number of tags added for the DB instance has reached the quota. 单个实例标签数量达到最大配额。 检查实例标签数量是否达到了最大配额。 400 DBS.200098 The tag already exists. 该资源标签已存在。 检查标签是否已存在。 400 DBS.200175 The engine version is not permitted to enable force switch. 该引擎版本不支持设置切换策略。 检查该引擎版本是否高于1.2.2。 400 DBS.200203 Failed to query the DB instance. 查询实例失败。 检查查询的实例是否存在或重试。 400 DBS.200302 Storage space must be a multiple of 10. 卷大小不是10的整数倍。 检查磁盘大小是否是10的倍数。 400 DBS.200303 The scale-up times have reached the maximum value. 扩容次数达到最大限制。 检查扩容次数是否达到最大限制。 400 DBS.200306 The new storage space must be greater than or equal to the original storage space. 扩容参数不合法。 检查扩容参数是否合法。 400 DBS.200308 The new storage space after scaling up cannot be greater than that of the primary DB instance. 备机扩容后的大小不能超过主机。 检查备机扩容后的大小是否超过了主机。 400 DBS.200405 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 400 DBS.200461 The parameter value is out of range. 参数值超出范围。 检查参数值是否超出范围。 400 DBS.200475 New password should not equal to the old ones. 新密码不能与旧密码相同。 检查新旧密码是否符合要求。 400 DBS.200504 Invalid database version. 数据库版本非法。 检查数据库的版本号是否支持。 400 DBS.200506 Invalid KMS key ID. 密钥非法。 检查密钥是否正确。 400 DBS.200507 The KMS key is invalid or has been deleted. 密钥失效或已删除。 检查密钥是否正确。 400 DBS.200543 The job does not exist. 任务不存在。 检查任务是否正确。 400 DBS.200823 The database does not exist. 数据库不存在。 检查数据库名称是否合法。 400 DBS.200824 The database account does not exist. 数据库账号不存在。 检查数据库用户名称是否合法。 400 DBS.200825 Modifying permission is not allowed on read replicas. 不允许在只读实例上执行修改权限操作。 请确认权限后操作。 400 DBS.200943 Agent async requet failed. 调用agent异步请求失败。 请检查Agent连接是否正常。 400 DBS.201004 The backup type does not exist. 备份类型不存在。 检查备份类型。 400 DBS.201014 This operation is not allowed by the DB instance status. 实例状态不允许做该操作。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.201019 The restoration task does not exist. 恢复任务不存在。 该实例没有相关恢复任务或者不需要进行恢复后的数据确认。 400 DBS.201035 The database name must be different from the original and target database names. 输入的数据库名重复或者输入的数据库名与目标库上的重复。 检查数据库名是否正确。 400 DBS.201101 Invalid backup cycle. 备份周期非法。 检查备份周期是否正确，是否符合要求。 400 DBS.201103 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求，备份开始时间和备份结束时间的关系是否正确。 400 DBS.201106 Invalid retention days. 保留天数非法。 检查保留天数是否合法。 400 DBS.201203 The backup file does not exist. 备份文件不存在。 检查该备份是否存在，备份是否匹配实例。 400 DBS.201207 The DB engine or version is not supported. 不支持的数据库类型或版本。 检查数据库引擎或版本是否支持。 400 DBS.201208 The operation is not allowed by the backup status. 备份状态不允许。 请明确具体操作约束，按照约束进行操作。 400 DBS.201210 Invalid backup name. 备份名非法。 检查备份名称是否合法。 400 DBS.212002 Incorrect parameter group quota. 参数组配额错误。 检查参数组配额是否正确。 400 DBS.212003 Operation not allowed. 不支持此操作。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.212004 Parameter group update error. 参数组更新错误。 检查参数是否正确。 400 DBS.212005 The node does not belong to the group. 节点不属于组。 检查节点及所属组是否正确。 400 DBS.212007 The DB engine does not exist. 引擎不存在。 检查数据库引擎是否正确。 400 DBS.212008 The DB engine is not supported. 不支持的引擎。 检查数据库引擎是否支持。 400 DBS.212009 Task processing failed. 任务处理失败。 稍后请重试，或联系技术支持。 400 DBS.212010 The parameter group is being applied. 绑定正在执行。 稍后请重试。 400 DBS.212011 Application failed. 绑定失败。 重新绑定或联系技术支持。 400 DBS.212012 The parameter does not exist. 参数不存在。 检查参数是否正确。 400 DBS.212014 The node does not have a default parameter group. 节点没有默认参数组。 检查默认参数组。 400 DBS.212015 Partial success. 部分成功。 检查任务部分失败原因或联系技术支持。 400 DBS.212016 Parameter update failed. 参数更新失败。 检查参数是否正确。 400 DBS.212017 Invalid parameter. 参数非法。 检查参数是否正确。 400 DBS.212025 Update failed. 更新失败。 检查更新失败原因或联系技术支持。 400 DBS.212030 The parameter template name already exists. 参数组名已存在。 检查参数是否正确。 400 DBS.212032 The parameter template has been applied. 参数模板已被应用。 检查参数模板是否正确。 400 DBS.212037 Parameters are incorrectly set. 参数设置不正确。 检查参数设置是否正确。 400 DBS.216028 Insufficient internal resource quota. 内部资源配额不足。 检查内部资源配额。 400 DBS.216030 The queried node does not belong to the current instance. 操作节点不属于该实例。 检查操作节点信息是否正确。 400 DBS.280001 Parameter error. 参数错误。 检查参数是否正确。 400 DBS.280006 The request is null. Enter a request parameter. 请求为空，请输入请求参数。 检查请求参数是否正确。 400 DBS.280124 Invalid backup file id 备份文件ID非法 检查备份文件ID是否合法 400 DBS.280127 Invalid backup description. 备份描述不合法。 检查备份描述是否合法。 400 DBS.280128 The database information of the DB instance is not found. Check the database name to see whether the instance database information exists. 请检查数据库名，确认所填数据库名信息，找不到该实例的数据库信息。 检查数据库名称是否正确。 400 DBS.280203 This is a weak password. Please enter a strong password. 这是一个弱密码，请输入一个强度大一些的密码. 请参考对应的密码参数说明，输入符合密码复杂度要求，且强度更高的密码。 400 DBS.280204 Invalid parameter. 输入参数不合法。 检查参数是否正确。 400 DBS.280214 Invalid retention days. 保留天数非法。 检查保留天数是否合法。 400 DBS.280215 Invalid backup cycle. 备份周期非法。 检查备份周期是否合法。 400 DBS.280216 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否合法。 400 DBS.280234 Invalid DB instance name. 实例名非法。 检查实例名称是否合法。 400 DBS.280235 Invalid database type. 数据库类型非法 检查数据库类型是否正确。 400 DBS.280236 Invalid database version. 数据库版本非法。 检查数据库版本是否正确。 400 DBS.280237 Datastore not specified. Datastore为空。 检查Datastore是否合法。 400 DBS.280238 The DB engine or version is not supported. 不支持的数据库类型或版本。 检查数据库引擎或版本是否支持。 400 DBS.280239 Invalid specifications. 所选规格非法。 检查所选规格是否正确。 400 DBS.280241 Invalid storage type. 卷类型非法。 检查磁盘的类型是否正确，是否符合要求。 400 DBS.280242 Storage space is out of range. 卷大小超出允许范围。 检查磁盘大小的值是否正确。 400 DBS.280246 Invalid database root password 数据库root密码非法。 检查数据库root密码是否符合要求。 400 DBS.280250 Invalid backup retention days. 备份保留天数非法。 检查保留天数是否合法。 400 DBS.280251 Invalid backup cycle. 备份周期不合法。 检查备份周期是否符合要求。 400 DBS.280253 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求，备份开始时间和备份结束时间的关系是否正确。 400 DBS.280270 The parameter does not exist. 参数不存在。 检查参数是否正确。 400 DBS.280271 The parameter value is out of range. 参数值超出范围。 检查参数是否正确。 400 DBS.280272 The tag key must be unique. 新增标签存在重复的键值。 请检查请求参数中的标签键值。 400 DBS.280277 Invalid object name. 对象名称非法。 检查对象名称是否合法。 400 DBS.280285 Invalid AZ. 可用区取值非法。 检查可用区的参数是正确，可用区是否存在。 400 DBS.280288 Invalid FlavorRef. 规格非法。 检查规格是否合法。 400 DBS.280311 Invalid storage space size. 存储空间大小非法。 检查存储空间大小是否合法。 400 DBS.280325 Invalid storage information. 硬盘信息不合法。 检查硬盘信息是否合法。 400 DBS.280342 Invalid cluster mode. 集群模式非法。 检查集群模式是否合法。 400 DBS.280364 Invalid database port. 数据库端口号无效。 检查数据库端口号是否合法。 400 DBS.280365 Invalid billing mode. 付款模式无效。 检查传入的付款模式是否正确。 400 DBS.280402 Invalid HA mode. HA模式非法。 检查HA模式是否合法。 400 DBS.280404 Invalid DB instance ID or node ID format. 实例ID或者节点ID非法。 检查实例ID是否合法。 400 DBS.280407 Invalid node ID. 节点ID非法。 检查节点ID是否合法。 400 DBS.280416 Invalid backup end time. 备份结束时间非法。 检查备份结束时间是否合法。 400 DBS.280432 Invalid duration for yearly/monthly DB instances. 不合法的包周期时长。 请检查包周期时长是否正确。 400 DBS.280433 Invalid enterprise project ID. 不合法的企业项目ID。 检查企业项目ID是否符合要求。 400 DBS.280434 Invalid specification code. 所选规格码非法。 检查规格码是否合法。 400 DBS.280439 Invalid records. The number of records must be an integer less than or equal to 100. 无效的查询记录数，请输入小于等于100的正整数。 检查查询记录数是否合法。 400 DBS.280440 Invalid offset, please enter a non negative integer. 无效的偏移量，请输入非负整数 检查偏移量是否合法。 400 DBS.280447 Invalid time zone. 不合法的time zone。 检查时区参数是否填写正确。 400 DBS.280448 The storage type is sold out. 当前卷类型已售罄。 请创建其他卷类型或切换其他可用区或区域。 400 DBS.280449 This operation cannot be performed because the object is frozen. 不能对冻结的对象执行该操作。 解冻该实例，再重试。 400 DBS.280450 The DB instance specifications are sold out. 当前规格已售罄。 请创建其他规格集群或切换其他可用区或区域。 400 DBS.280600 Invalid coordinator node quantity. 协调节点数量非法。 检查协调节点数量是否合法。 400 DBS.280601 Invalid shard quantity. 分片数量非法。 检查分片数量是否合法。 400 DBS.280604 Invalid number of added shards for cluster capacity expansion. 扩容分片数非法。 检查扩容分片数量是否合法。 400 DBS.280618 Differential backup cycle invalid. 差异备份周期无效。 检查差异备份周期是否合法。 400 DBS.280628 Invalid replica count. 副本数非法。 检查副本数量是否合法。 400 DBS.280629 The database version does not support two-replica instances. 数据库版本不支持2副本实例。 检查副本数量是否合法，或者修改为支持的数据库版本，再重试。 400 DBS.280630 Two-replica instances can only be deployed within a single AZ. 2副本实例只支持单可用区。 检查2副本实例可用区是否合法。 400 DBS.280631 Invalid database name. 数据库名非法。 检查数据库名称是否合法。 400 DBS.280632 Invalid schema. 数据库模式非法。 检查数据库模式是否合法 400 DBS.280633 Invalid source node group. 源Node Group非法。 检查源Node Group是否合法。 400 DBS.280634 Invalid target node group. 目标Node Group非法。 检查目标Node Group是否合法。 400 DBS.280635 Invalid Solution Solution非法。 检查solution参数是否填写正确。 400 DBS.290000 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确，是否符合要求。 400 DBS.290001 Parameter error. 参数错误。 检查参数是否填写正确。 403 DBS.200010 The DB instance ID or user ID may be null, or the operation is not authorized. 实例ID和用户ID可能为空，或者操作越权。 检查实例ID或用户ID是否正确，或者检查访问权限。 403 DBS.200044 Resource not found or permission denied. 访问资源不存在，或者无访问权限。 修改资源ID或者检查访问权限。 403 DBS.200174 No permission to enable force switch. 没有设置切换策略参数的权限。 检查是否有设置切换策略参数的权限。 403 DBS.200604 The DB instance ID or user ID may be null, or the operation is not authorized. 实例ID和用户ID可能为空，或者操作越权。 检查实例ID或用户ID是否正确，获取检查访问权限。 403 DBS.200810 You are not allowed to create databases on read replicas. 不能在只读实例创建数据库。 检查只读实例操作限制。 403 DBS.200819 You are not allowed to delete database users on read replicas. 不能在只读实例执行删除数据库用户。 检查只读实例操作限制。 403 DBS.280020 The account is restricted. 账户受限。 检查账号是否权限不足。 400 DBS.280800 This operation is not allowed by the cluster status. 集群状态受限，操作不允许执行。 检查集群状态是否正常。 400 DBS.280804 This operation is not allowed for primary/standby instances with kernel version 1.x 1.X内核版本不支持对主备版实例进行操作。 检查操作实例内核版本，如有必要需要升级内核版本。 400 DBS.280828 The component ID must be the standby DN ID. 组件ID必须是备DN。 检查组件ID状态，不允许传入主DN组件ID。 403 DBS.201003 Resource not found or permission denied. 访问资源不存在，或者无访问权限。 修改资源ID或者检查访问权限 403 DBS.280015 Resource not found or permission denied. 访问资源不存在，或者无访问权限。 修改资源ID或者检查访问权限 403 DBS.280056 Invalid token. Token非法。 请检查token是否正确，或者重新获取token后再试 404 DBS.200002 The DB instance does not exist. 实例不存在。 检查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 404 DBS.200008 The ECS information of the DB instance cannot be found. 请检查数据库，确认实例的虚拟机信息，找不到该实例的虚拟机信息。 检查实例虚拟机是否正常。 404 DBS.200013 The original DB instance does not exist. 源实例不存在。 检查源实例是否存在。 404 DBS.200045 The DB instance does not exist. 实例不存在。 查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 404 DBS.200050 The security group does not exist or does not belong to the VPC. 安全组不存在，或不属于该VPC。 检查安全组是否正确。 404 DBS.200408 The DB instance abnormal, no normal nodes. 实例异常，无正常节点。 检查实例或节点状态。 404 DBS.200470 The region or AZ does not exist. Region或可用区不存在。 请输入正确的 Region ID或可用区。 404 DBS.200501 The subnet does not exist or does not belong to the VPC. 子网不存在，或不属于该VPC。 检查子网是否正确。 404 DBS.200503 The VPC does not exist or does not belong to the user. VPC不存在，或不属于该用户。 检查VPC是否正确。 404 DBS.200602 The DB instance does not exist. 该实例不存在。 查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 404 DBS.201010 The backup file does not exist. 备份文件不存在。 检查该备份是否存在，备份是否匹配实例。 404 DBS.201028 The DB instance does not exist. 实例不存在或已删除。 查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 404 DBS.212001 The parameter group does not exist. 参数组不存在。 检查参数组是否存在。 404 DBS.212013 The object does not exist. 对象不存在。 请确定操作的对象存在。 404 DBS.290002 The selected specifications do not exist. 所选规格不存在。 检查所选规格是否正确。 404 DBS.290005 The DB instance does not exist. 该实例不存在。 检查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 404 DBS.290011 The DB instance does not exist. 实例不存在。 检查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 404 DBS.290013 Resource not found. 未找到资源。 检查入参是否正确，实例是否存在。 409 DBS.200011 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 检查实例的状态或实例正在进行的操作是否与请求冲突。 409 DBS.200019 This operation conflicts with the currently running task, please troubleshoot by yourself. 该操作与当前正在运行的任务是冲突的，请自行排查。 检查实例的状态或实例正在进行的操作是否与请求冲突。 409 DBS.200022 The DB instance name already exists. 实例名称已存在。 请输入一个与已存在的实例不相同的实例名。 409 DBS.200047 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 检查实例的状态或实例正在进行的操作是否与请求冲突。 409 DBS.200316 This operation cannot be performed because the DB instance status is Storage full. 当前实例状态为存储空间满，不能进行该操作。 检查实例存储空间是否已满。 409 DBS.200402 Invalid operation. 操作不合法。 检查请求是否合法。 409 DBS.200826 The database name already exists. 数据库名称已存在。 检查数据库名称是否合法。 409 DBS.200827 The database user already exists. 账号名称已存在。 检查数据库用户是否合法。 409 DBS.200828 Built-in database accounts cannot be edited. 数据库内置账号，用户不可操作。 检查用户操作权限。 409 DBS.201201 The backup name already exists. 备份名称已存在。 请确定操作的对象是否存在。 409 DBS.201202 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 检查实例的状态或实例正在进行的操作是否与请求冲突。 409 DBS.201205 Backup is in progress, please wait. 正在备份中，请稍等。 等待备份完成后，再重试。 409 DBS.212006 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 检查实例的状态或实例正在进行的操作是否与请求冲突。 409 DBS.212033 Failed to change parameter template values because the DB instance is currently being operated. 无法更改数据库实例的参数组值，因为当前正在操作数据库实例。 检查实例的状态或实例正在进行的操作是否与请求冲突。 409 DBS.280011 This operation cannot be performed because the DB instance is abnormal or has been deleted. 实例当前状态异常或已删除，不允许做该操作。 检查实例的状态是否正常或者该实例是否已经被删除了。 409 DBS.280406 Operation not allowed by the DB instance type or status. 实例类型或状态受限，操作不允许。 检查实例的状态或实例正在进行的操作是否与请求冲突。 413 DBS.200046 The number of DB instances has reached the quota. 实例数量达到配额。 检查配额。 413 DBS.290003 The number of DB instances has reached the quota. 实例数量达到配额。 检查配额。 422 DBS.212019 The parameter cannot be processed. 参数错误。 检查参数是否正确。 500 DBS.108000 Server failure. 服务器错误。 请联系客服管理员或者稍后重试。 500 DBS.108002 Server failure. 服务器错误。 请联系客服管理员或者稍后重试。 500 DBS.108005 Server failure. 服务器错误。 请联系客服管理员或者稍后重试。 500 DBS.200005 Server failure. 服务器错误。 请联系客服管理员或者稍后重试。 500 DBS.200208 Server failure. 服务器错误。 请联系客服管理员或者稍后重试。 500 DBS.200811 Failed to create the database. 创建数据库失败。 检查失败原因或联系技术支持。 500 DBS.200821 Failed to modify database user permissions. 修改数据库用户权限失败。 检查用户权限。 500 DBS.213002 Failed to process the request. 请求处理失败。 请联系客服管理员或者稍后重试。 500 DBS.213004 Failed to process the request. 请求处理失败。 请联系客服管理员或者稍后重试。 500 DBS.290006 Failed to process the request. 请求处理失败。 请联系客服管理员或者稍后重试。 500 DBS.290015 Failed to process the request. 请求处理失败。 请联系客服管理员或者稍后重试。 400 DBS.280266 Storage space must be a multiple of 10. 卷大小不是10的整数倍。 检查磁盘大小是否是10的倍数。 400 DBS.280611 Storage space must be a common multiple of 40GB and the number of shards. 所选磁盘容量大小必须为40GB和分片数的公倍数。 检查磁盘大小是否符合要求。 400 DBS.280612 Storage space excess max limit for current shard number. 所选磁盘容量大于当前分片数支持的最大值。 检查磁盘大小是否符合要求。 400 DBS.280243 Invalid region. Region非法。 请输入正确的 Region ID。 400 DBS.200505 The subnet does not exist or does not belong to the VPC. 子网不存在，或不属于该vpc。 请输入正确的子网后重试。 404 DBS.200502 The security group does not exist or does not belong to the VPC. 安全组不存在，或不属于该VPC。 请输入正确的安全组后重试。 400 DBS.200065 Invalid retention days. 保留天数非法。 检查保留天数是否合法。 400 DBS.280602 Invalid HA consistency. Ha一致性非法。 检查Ha一致性是否合法。 400 DBS.280262 Invalid synchronize model. Ha同步模式非法。 检查Ha模式是否合法。 400 DBS.200057 Invalid parameter template ID. 实例参数组的ID取值非法。 请输入正确的实例参数组ID后重试。 404 DBS.200058 The parameter template does not exist. 参数组不存在。 检查参数组是否存在。 400 DBS.200059 Invalid database port. 数据库端口号无效。 检查数据库端口号是否合法。 400 DBS.280654 The Ha instance is not supported to cancel parallel restore. 主备版实例不支持取消并行恢复。 主备版实例不支持设置并行恢复，请按照API文档在请求体中取消设置并行恢复。 400 DBS.280613 Please use specifications of data nodes. 请使用数据节点的规格。 检查数据节点规格是否正确。 404 DBS.200355 Resource not found. 未找到资源。 检查资源后重试。 400 DBS.200061 Invalid billing mode. 付款模式无效。 检查付款模式是否合法。 400 DBS.201218 The backup file is not manual. 不是手动备份文件。 选择手动备份文件进行操作。 404 DBS.280022 The DB instance does not exist. 实例不存在或已删除。 查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 400 DBS.280408 Invalid project id. project id 非法。 检查project id是否合法。 400 DBS.280607 Exceeding the upper limit of data nodes number in a single expand request. 超过单次数据节点扩容数量的上限。 检查单次数据节点扩容数量是否达到上限。 400 DBS.200082 The available IP addresses in the selected subnet are insufficient. 所选子网可用IP不足。 请输入正确可用的子网后重试。 400 DBS.280606 Expanding coordinator nodes and data nodes at the same time is not supported currently. 暂不支持同时扩容协调节点和数据节点。 检查扩容约束后重试。 400 DBS.280608 Exceeding the upper limit of coordinator nodes number in a single expand request. 超过单次协调节点扩容数量的上限。 检查单次协调节点扩容数量是否达到上限。 400 DBS.280609 Expand cluster request must contains at least one node type to expand. 扩容集群请求至少要包含一种要扩容的节点。 检查扩容规范后重试。 400 DBS.301024 The backup file is not normal. 备份文件状态异常。 检查该备份文件的状态。 400 DBS.280651 Failed to create all DB schemas. 创建数据库SCHEMA全部失败。 检查输入schema参数然后重试。 400 DBS.280652 Failed to create some DB schemas. 创建数据库SCHEMA部分失败。 检查输入schema参数然后重试。 400 DBS.200029 Incorrect username or password parameter. 用户名或密码参数错误。 检查输入输入用户名与密码然后重试。 400 DBS.280132 Database name not entered. 未输入数据库名称。 请输入数据库名称。 400 DBS.280661 Illegal instance specification, which does not exist or does not match the instance 非法的实例规格，该规格不存在或与实例不匹配。 请根据当前实例检查传入的规格参数。 400 DBS.280626 DR relationship established between primary and DR instances. 容灾主集群和灾备集群已存在容灾关系。 请检查容主备实例是否已经存在灾关系。 400 DBS.280638 The DR relationship does not exist. 容灾关系记录不存在。 请检查容灾关系是否存在。 400 DBS.280806 Cross-region DR operation failed. 跨region操作失败。 请检查目前region的project id是否合法。 400 DBS.280667 Invalid shard component ID. 分片组件id非法。 请检查组件ID是否合法。 400 DBS.280668 Component IDs are from the same shard. 存在同组DN分片异常。 请检查批量DN主备倒换时，多个组件ID是否来自不同组分片。 400 DBS.280676 The component ID does not belong to the current node ID. 组件id不属于当前节点id。 请检查DN主备倒换时，组件ID是否属于对应的节点ID。 400 DBS.200478 Failed to change the password. 修改密码失败。 请检查传入的密码是否正确。 400 DBS.200062 Invalid database username. 数据库用户名非法。 请输入正确的数据库用户名。 400 DBS.280653 Invalid database template. Use the template0. 数据库模板非法，建议使用template0数据库模板。 请输入正确的模板名称。 400 DBS.200064 Invalid retention days. 保留天数非法。 请输入正确的保留天数。 400 DBS.06010001 Instance status is invalid. 实例状态无效。 请检查当前的实例状态。 400 DBS.06020003 An operation that conflicts with the current operation is in progress. 与当前操作冲突的操作正在进行中。 请检查当前实例是否正在进行其他操作。 400 DBS.06020152 Incremental restoration in progress for the primary instance. Perform this operation when there is no DR relationship. 灾备实例增量恢复中，请在无容灾状态时执行该操作。 检查当前实例的容灾状态。 400 DBS.06020153 Incremental restoration failed for the DR instance. Perform this operation when there is no DR relationship. 灾备实例增量恢复失败，请在无容灾状态时执行该操作。 检查当前实例的容灾状态。 400 DBS.06020154 Promotion to primary in progress for the DR instance. Perform this operation when there is no DR relationship. 灾备实例升主中，请在无容灾状态时执行该操作。 检查当前实例的容灾状态。 400 DBS.06020175 Incremental synchronization failed for the primary instance. Perform this operation when incremental synchronization is in progress. 主实例处于增量同步失败，请在增量同步中执行该操作。 主实例处于增量同步失败，请在增量同步中执行该操作。 400 DBS.06020177 Switchover failed for the DR instance. Perform this operation when incremental restoration is in progress. 灾备实例处于主备切换失败，请在增量恢复中执行该操作。 灾备实例处于主备切换失败，请在增量恢复中执行该操作。 400 DBS.06020180 Incremental restoration failed for the DR instance. Perform this operation when incremental restoration is in progress. 灾备实例处于增量恢复失败，请在增量恢复中执行该操作。 灾备实例处于增量恢复失败，请在增量恢复中执行该操作。 400 DBS.06020161 The xlog_keep_radio field is invalid. xlog_keep_radio字段非法 xlog_keep_radio字段非法 400 DBS.06020162 This operation is not supported. 不支持此容灾操作。 不支持此容灾操作。 400 DBS.06280105 This feature is not enabled. 此功能特性未启用。 此功能特性未启用，请在运维管理平台开启相关特性白名单。 400 DBS.06010013 Parameter error: ${parameterName}${parameterValue} 调用接口时填写的参数错误。 请重新填写为正确的参数。 400 DBS.216003 Permission denied. 没有权限。 检查账号是否权限不足。 400 DBS.06280032 New OS does not match original instance. 备份恢复到新实例，操作系统不匹配。 检查原实例操作系统是否匹配。 400 DBS.06280033 The selected deployment model of the ${resourceType} type cannot be created. 资源类型：${resourceType}，暂不支持创建该部署形态的实例。 检查当前资源类型是否支持创建该形态的实例。 400 DBS.06010018 Failed to obtain the instance volume information. 获取实例磁盘信息失败。 检查获取磁盘信息的远程接口是否调用成功或者磁盘信息处理是否出现异常。 400 DBS.06010033 The current node type or role does not support this operation. 当前节点类型或角色不支持该操作。 请选择CN节点或者角色类型为只读、主、备的DN节点。 400 DBS.06010035 The component ID does not exist. 组件ID不存在。 请检查组件ID参数。 400 DBS.06010036 The pidstat system command is not supported. 不支持pidstat系统命令。 不支持pidstat系统命令。 400 DBS.06010041 None of the configuration parameter values to be modified are changed. 所有修改的配置参数值均未变化。 请填写不同于当前值的配置参数值。 403 DBS.06010037 Insufficient permissions for the KMS key. kms密钥操作权限不足。 请联系密钥管理员授权足够权限。 400 DBS.280659 Illegal number of grayscale upgrade shard, please check the parameters. 非法的灰度升级分片数，请检查传参。 非法的灰度升级分片数，请检查传参。 400 DBS.06013034 The maximum number of nodes that can be stopped must not exceed half of the total number. 停止节点数不能超过半数。 请检查实例节点类型。 400 DBS.06013039 Single node instance not support the operation. 单节点实例不支持此操作。 请检查实例节点类型。 400 DBS.06020109 This operation is not supported because ${paramName} is not enabled. Contact customer service. 暂时不支持该操作，${paramName}未开启，请联系客服人员处理。 特性开关未开启，联系客服人员处理。 400 DBS.200920 The number of batch operation exceeds the maximum. Please check. 批量操作数量超过最大限制, 请检查。 减小请求参数长度。 400 DBS.06013057 license configuration failure license许可配置失败。 检查许可是否正确。 400 DBS.06013061 config license extensions failed 插件拓展配置失败。 检查是否满足扩展配置的约束条件。 400 DBS.06013062 The plugin is not installed. Install the plugin first. 未安装插件，请先进行插件安装。 先完成插件的安装。 400 DBS.06013068 Plug-ins cannot be installed for instances running on Huawei Cloud EulerOS. HCE操作系统实例暂不支持安装插件。 使用欧拉操作系统的实例安装插件。 400 DBS.06013069 Plug-ins cannot be installed for distributed instances. 分布式实例不支持安装插件。 使用集中式实例安装插件。 父主题： 附录

响应示例 实例列表： { "instances" : [ { "id" : "b331ed66cc3249f78bc20737308c01f4in14", "status" : "ACTIVE", "name" : "gauss-9e88", "port" : 8000, "type" : "enterprise", "ha" : { "consistency" : "strong", "replication_mode" : "sync" }, "region" : "cn-xianhz-1", "datastore" : { "type" : "GaussDB", "version" : "2.7", "complete_version" : "2.7.2", "target_version" : "3.208.0", "complete_kernel_version" : "V500R002C10SPC610" }, "created" : "2021-01-15 01:46:40 UTC", "updated" : "2021-01-15 02:05:03 UTC", "volume" : { "type" : "ULTRAHIGH", "size" : 120 }, "nodes" : [ { "id" : "02ebf757aaf94074855f49cc6e0e4712no14", "name" : "gauss-9e88_gaussdbv5cn_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_5001:" }, { "id" : "0a87b8ecbfeb46aba1409cfc0f0d5c34no14", "name" : "gauss-9e88_gaussdbv5cn_0", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_5002:" }, { "id" : "2d9fec1ab3834936b074d63acf48b1f2no14", "name" : "gauss-9e88_gaussdbv5dn3_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6003:60073" }, { "id" : "48bb08a2d635435891ac0caa1c0bf2e3no14", "name" : "gauss-9e88_gaussdbv5dn1_0", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6001:60011" }, { "id" : "5df830f652204827ada32f8bc28b107eno14", "name" : "gauss-9e88_gaussdbv5dn1_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6002:60011" }, { "id" : "8a97a246cee841b38c5b47290d4c9c38no14", "name" : "gauss-9e88_gaussdbv5cn_1", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_5003:" }, { "id" : "8c1a3f8eecca4d9e9974a868bb6dd942no14", "name" : "gauss-9e88_gaussdbv5dn2_0", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6004:60042" }, { "id" : "9bd0c80b8a684cc9bd7d99dd5adffb07no14", "name" : "gauss-9e88_gaussdbv5dn3_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6005:60073" }, { "id" : "9e2a3cd541e249d4af5aa57c5d3a7f39no14", "name" : "gauss-9e88_gaussdbv5dn1_2", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6006:60011" }, { "id" : "b046d28989ec4ae5a1a9ab20fe65f248no14", "name" : "gauss-9e88_gaussdbv5dn2_2", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6007:60042" }, { "id" : "b614cc12fd3742dbb230245f88a7bf00no14", "name" : "gauss-9e88_gaussdbv5dn3_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6008:60073" }, { "id" : "caba8e88c3c84ae58202f1f589490611no14", "name" : "gauss-9e88_gaussdbv5dn2_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6009:60042" } ], "private_ips" : [ "192.168.28.81 / 192.168.27.52 / 192.168.16.253" ], "public_ips" : [ ], "db_user_name" : "root", "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info" : { "vcpu" : 2, "mem" : 16 }, "switch_strategy" : "Reliability", "charge_info" : { "charge_mode" : "prePaid" }, "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "maintenance_window" : "18:00-22:00", "disk_encryption_id" : "24ae42b5-4009-4ea2-b66a-0b211e424dab", "enterprise_project_id" : "6e76681b-a2f5-4c5f-97c5-ba4fd3c0dfb2", "instance_mode" : "enterprise", "time_zone" : "UTC+08:00", "disk_usage" : "0.9890", "mysql_compatibility" : { "port" : 3306 } }, { "id" : "226b4afcfcc84c86bf1b9cb345d3b00fin14", "status" : "ACTIVE", "name" : "UTS-gauss-ad53-2C3D", "port" : 8000, "type" : "enterprise", "ha" : { "consistency" : "strong", "replication_mode" : "sync" }, "region" : "cn-xianhz-1", "datastore" : { "type" : "GaussDB", "version" : "2.7", "complete_version" : "2.7.2", "complete_kernel_version" : "V500R002C10SPC610", "target_version" : "3.208.0", "hotfix_version_infos" : [ { "version" : "2.7.2.1", "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" }, { "version" : "2.7.2.2", "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" } ] }, "created" : "2021-01-08 09:18:27 UTC", "updated" : "2021-01-14 13:25:03 UTC", "volume" : { "type" : "ULTRAHIGH", "size" : 120 }, "nodes" : [ { "id" : "07538a1def584cee99e2a5685eeab36ano14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn3_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6009:60072" }, { "id" : "21f41baba1e2454f82331b7cb5aeabe5no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn1_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6008:60042" }, { "id" : "2909771a3b3e4e3998f9388e77d22391no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn1_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6007:60011" }, { "id" : "2bd9a90a5da242a6b0743a7f597f6106no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn2_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6006:60042" }, { "id" : "77092f1dadb74d3ea13d28269cdd3590no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn3_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6005:60072" }, { "id" : "a46bfaa6d5a24355a60fce7432b964cano14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn3_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6004:60072" }, { "id" : "aa5277736f3844e2a7adeb9de529e2b1no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn2_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6003:60042" }, { "id" : "b1d798e4ea7344dfa95032984bc6cfd7no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5cn_1", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_5002:" }, { "id" : "b9a46540186f4c0781eabaa2a79594cbno14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn1_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6002:60011" }, { "id" : "d283813030364060ab64371d50294977no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn2_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6001:60042" }, { "id" : "eb7bce29b2284cd290405eaddc1b1a1eno14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5cn_0", "role" : "master", "status" : "FAILED", "availability_zone" : "az2xahz", "component_names" : "cn_5001:" } ], "private_ips" : [ "192.168.30.44 / 192.168.29.231" ], "public_ips" : [ "10.154.217.248" ], "db_user_name" : "root", "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info" : { "vcpu" : 2, "mem" : 16 }, "switch_strategy" : "Reliability", "charge_info" : { "charge_mode" : "prePaid" }, "backup_strategy" : { "start_time" : "18:00-19:00", "keep_days" : 7 }, "maintenance_window" : "18:00-22:00", "enterprise_project_id" : "0", "instance_mode" : "enterprise", "time_zone" : "UTC+08:00", "disk_usage" : "1.0000", "mysql_compatibility" : { "port" : 3306 } }, { "id" : "706c65c3dd7d497ab16f5b3a113690abin14", "status" : "ACTIVE", "name" : "UTS-gauss-7362", "port" : 8000, "type" : "enterprise", "ha" : { "replication_mode" : "sync" }, "region" : "cn-xianhz-1", "datastore" : { "type" : "GaussDB", "version" : "2.7", "complete_version" : "2.7.2", "complete_kernel_version" : "V500R002C10SPC610", "target_version" : "3.208.0", "hotfix_version_infos" : [ { "version" : "2.7.2.1", "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" }, { "version" : "2.7.2.2", "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" } ] }, "created" : "2020-12-23 03:21:41 UTC", "updated" : "2021-01-15 02:32:13 UTC", "volume" : { "type" : "ULTRAHIGH", "size" : 80 }, "nodes" : [ { "id" : "25b7f16ee4084b7884d52f1bdfab4e68no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6003:60011" }, { "id" : "ad6f02f31744422fa8ce487e81c9e7afno14", "name" : "UTS-gauss-7362_gaussdbv5cn_0", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_5001:" }, { "id" : "b30c56582bf44a548e3bb5b5af6c4773no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6002:60011" }, { "id" : "f79ea0600cba42b2888bd9bd67e52a79no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6001:60011" } ], "private_ips" : [ "192.168.26.70" ], "public_ips" : [ ], "db_user_name" : "root", "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info" : { "vcpu" : 2, "mem" : 16 }, "switch_strategy" : "Reliability", "charge_info" : { "charge_mode" : "postPaid" }, "backup_strategy" : { "start_time" : "16:00-17:00", "keep_days" : 7 }, "maintenance_window" : "18:00-22:00", "enterprise_project_id" : "0", "instance_mode" : "enterprise", "time_zone" : "UTC+08:00", "disk_usage" : "0.9940", "mysql_compatibility" : { "port" : 3306 } }, { "id" : "4ad42d079a3948d88c28d6236211b21ein14", "status" : "ACTIVE", "name" : "UTS-gauss-4336", "port" : 8000, "type" : "enterprise", "ha" : { "replication_mode" : "sync" }, "region" : "cn-xianhz-1", "datastore" : { "type" : "GaussDB", "version" : "2.7", "complete_version" : "2.7.2", "complete_kernel_version" : "V500R002C10SPC610", "target_version" : "3.208.0", "hotfix_version_infos" : [ { "version" : "2.7.2.1", "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" }, { "version" : "2.7.2.2", "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" } ] }, "created" : "2020-12-03 14:28:53 UTC", "updated" : "2021-01-14 13:20:10 UTC", "volume" : { "type" : "ULTRAHIGH", "size" : 40 }, "nodes" : [ { "id" : "254dbda6f03643519ad64b39481bd11cno14", "name" : "UTS-gauss-4336_gaussdbv5dn1_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az1xahz", "component_names" : "dn_6001:60011" }, { "id" : "6ad76d4db26443c2a93b280739a31558no14", "name" : "UTS-gauss-4336_gaussdbv5dn1_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az1xahz", "component_names" : "dn_6002:60011" }, { "id" : "9fdebf821bdf444a8689b19c0ff588ceno14", "name" : "UTS-gauss-4336_gaussdbv5cn_0", "role" : "master", "status" : "FAILED", "availability_zone" : "az1xahz", "component_names" : "cn_5001:" }, { "id" : "dd64bdbc02a542d88823b1582f772d25no14", "name" : "UTS-gauss-4336_gaussdbv5cn_1", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az1xahz", "component_names" : "cn_5002:" }, { "id" : "de3c41461045466faf6c2b96eb709540no14", "name" : "UTS-gauss-4336_gaussdbv5dn1_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az1xahz", "component_names" : "dn_6001:60011" } ], "private_ips" : [ "192.168.30.93 / 192.168.29.232" ], "public_ips" : [ ], "db_user_name" : "root", "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info" : { "vcpu" : 2, "mem" : 16 }, "switch_strategy" : "Reliability", "charge_info" : { "charge_mode" : "postPaid" }, "backup_strategy" : { "start_time" : "18:00-19:00", "keep_days" : 7 }, "maintenance_window" : "18:00-22:00", "enterprise_project_id" : "0", "instance_mode" : "basic", "time_zone" : "UTC+08:00", "disk_usage" : "1.0000", "mysql_compatibility" : { "port" : 3306 } } ], "total_count" : 4 } 实例详情 { "instances" : [ { "id" : "706c65c3dd7d497ab16f5b3a113690abin14", "status" : "ACTIVE", "name" : "UTS-gauss-7362", "port" : 8000, "type" : "enterprise", "ha" : { "replication_mode" : "sync" }, "region" : "cn-xianhz-1", "datastore" : { "type" : "GaussDB", "version" : "2.7", "complete_version" : "2.7.2", "complete_kernel_version" : "V500R002C10SPC610", "target_version" : "3.208.0", "hotfix_version_infos" : [ { "version" : "2.7.2.1", "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" }, { "version" : "2.7.2.2", "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" } ] }, "created" : "2020-12-23 03:21:41 UTC", "updated" : "2021-01-15 02:32:13 UTC", "volume" : { "type" : "ULTRAHIGH", "size" : 80 }, "nodes" : [ { "id" : "25b7f16ee4084b7884d52f1bdfab4e68no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6003:60011" }, { "id" : "ad6f02f31744422fa8ce487e81c9e7afno14", "name" : "UTS-gauss-7362_gaussdbv5cn_0", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_6004:" }, { "id" : "b30c56582bf44a548e3bb5b5af6c4773no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6002:60011" }, { "id" : "f79ea0600cba42b2888bd9bd67e52a79no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6001:60011" } ], "private_ips" : [ "192.168.26.70" ], "public_ips" : [ ], "db_user_name" : "root", "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info" : { "vcpu" : 2, "mem" : 16 }, "switch_strategy" : "Reliability", "charge_info" : { "charge_mode" : "postPaid" }, "backup_strategy" : { "start_time" : "16:00-17:00", "keep_days" : 7 }, "maintenance_window" : "18:00-22:00", "disk_encryption_id" : "", "enterprise_project_id" : "0", "instance_mode" : "enterprise", "time_zone" : "UTC+08:00", "disk_usage" : "0.9670" } ], "total_count" : 1 }

请求示例 根据指定条件查询实例列表。 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.2/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in14&name=hy&type=Enterprise&datastore_type=GaussDB&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10 查询所有实例列表。 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.2/97b026aa9cc4417888c14c84a1ad9860/instances

响应参数 表3 响应参数 参数 参数类型 描述 instances Array of 表4 objects 实例信息。 total_count Integer 总记录数。 表4 instances 参数 参数类型 描述 id String 实例ID。 name String 创建的实例名称。 status String 实例状态。 取值： 值为“BUILD”，表示实例正在创建。 值为“ACTIVE”，表示实例正常。 值为“FAILED”，表示实例异常。 值为“FROZEN”，表示实例冻结。 值为“MODIFYING”，表示实例正在扩容磁盘或者变更规格。 值为“EXPANDING”，表示实例正在添加只读节点或扩容CN或DN。 值为“REBOOTING”，表示实例正在重启。 值为“REDUCING”, 表示实例正在删除只读节点。 值为“UPGRADING”，表示实例正在升级。 值为“RESTORING”，表示实例正在恢复。 值为“SWITCHOVER”，表示实例正在主备切换。 值为“MIGRATING”，表示实例正在迁移。 值为“BACKING UP”，表示实例正在进行备份。 值为“UPGRADE TO BE OBSERVED”，表示实例正在进行升级待观察。 值为“REDUCING REPLICATION”，表示实例正在降副本。 值为“STORAGE FULL”，表示实例磁盘空间满。 private_ips Array of strings 实例内网IP地址列表。分布式CN所在的弹性云服务器创建成功后该值存在，主备版DN所在的弹性云服务器创建成功后该值存在，其他情况下为空字符串。 public_ips Array of strings 实例外网IP地址列表。绑定弹性公网IP后，该值不为空。 port Integer 数据库端口号。 GaussDB数据库 端口设置范围为1024~39998（其中2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,20049,20050,21731,21732被系统占用不可设置）。当不传该参数时，默认端口8000。 type String 实例类型，区分大小写。 Enterprise：分布式实例（企业版）。 centralization_standard：主备版实例。 Combined：分布式实例（混合部署）。 ha 表5 object 获取分布式/主备版实例时返回。 replica_num Integer 实例副本数。 region String 实例所在区域。 datastore 表6 object 数据库信息。 created String 创建时间，格式为“yyyy-mm-dd hh:mm:ss timezone”。 其中timezone是指时区。 说明：创建时该值为实例下发创建的时间，创建完成后，该值为创建完成时间。例如：2024-07-02 08:32:07 UTC。 updated String 更新时间，格式与“created”字段对应格式完全相同。 说明：创建时返回值为空，数据库实例创建成功后该值不为空。 db_user_name String 默认用户名。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 安全组ID。 flavor_ref String 规格码。参考查询数据库规格中“spec_code”字段获取。 flavor_info 表8 object 规格信息。 volume 表9 object Volume信息。 switch_strategy String 数据库切换策略。 如果创建实例时没有选择切换策略，则该字段不显示。 取值为“Reliability”或“Availability”，分别对应于可靠性优先和可用性优先。 若创建时没有选择切换策略，则不予显示。 backup_strategy 表10 object 备份策略。 maintenance_window String 可维护时间窗，为UTC时间。 nodes Array of 表11 objects 实例节点信息列表。 disk_encryption_id String 磁盘加密密钥ID。只有创建磁盘加密实例才会显示该参数。 enterprise_project_id String 企业项目标签ID。非企业项目账号的实例，企业项目默认0。 instance_mode String 实例类型。 basic：基础版。 enterprise：企业版。 disk_encryption_id String 磁盘加密密钥ID。只有创建磁盘加密实例才会显示该参数。 charge_info 表12 object 计费类型信息，支持按需和包周期。 time_zone String 时区。 tags Array of 表13 objects 标签列表，没有标签不返回该参数。 disk_usage String 实例磁盘的可使用率，值范围[0-1]，值保留四位小数。 mysql_compatibility 表14 mysql_compatibility object 实例M兼容配置。 表5 ha 参数 参数类型 描述 consistency String 数据库一致性类型，仅支持分布式实例。 取值范围： strong：强一致性。 eventual：最终一致性。 replication_mode String 备机同步参数，非空，支持“sync”，表示同步模式。 表6 datastore 参数 参数类型 描述 type String 数据库引擎。 version String 数据库大版本。 complete_version String 数据库小版本。 target_version String 数据库正在升级的目标版本。 complete_kernel_version String 数据库内核版本。 hotfix_version_infos Array of 表7 objects 热补丁信息列表。 表7 hotfix_version_infos 参数 参数类型 描述 version String 热补丁版本。 upgrade_finished_time String 热补丁升级完成时间列表。 热补丁升级完成时间，格式为“yyyy-mm-dd hh:mm:ss timezone”。 其中timezone是指时区。 表8 flavor_info 参数 参数类型 描述 vcpu Integer CPU核数。 mem Integer 内存大小。 表9 volume 参数 参数类型 描述 type String 磁盘类型。 仅支持ULTRAHIGH和ESSD，区分大小写，分别表示SSD和极速云盘。 size Integer 磁盘大小。 表10 backup_strategy 参数 参数类型 描述 start_time String 备份时间段。自动备份将在该时间段内触发。 当前时间指UTC时间。 keep_days Integer 已生成的备份文件可以保存的天数。 取值范围：1～732。 表11 nodes 参数 参数类型 描述 id String 节点ID。 name String 节点名称。 role String 节点类型。 master：主节点。 slave：备节点。 secondary：日志节点。 readreplica：只读节点。 status String 节点状态。 值为“BUILD_FAILED”，表示节点创建失败。 availability_zone String 可用区。 private_ip String 节点内网IP。分布式实例类型下该参数仅针对CN节点有效，主备版实例类型下该参数对所有节点有效，且在弹性云服务器创建成功后参数值存在。 public_ip String 绑定的外网IP。分布式实例类型下该参数仅针对CN节点有效，主备版实例类型下该参数对所有节点有效，且在弹性云服务器创建成功并绑定弹性公网IP后参数值存在。 component_names String 节点上组件信息（例组件ID:分布式ID），多个组件信息用;隔开。 表12 charge_info 参数 参数类型 描述 charge_mode String 计费模式。 取值范围： postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。 表13 tags 参数 参数类型 描述 key String 标签键。 value String 标签值。 表14 mysql_compatibility 参数 参数类型 描述 port String M兼容端口。

URI GET https://{Endpoint}/v3.2/{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} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 实例ID。 “*”为系统保留字符，如果iID是以“*”起始，表示按照*后面的值模糊匹配，否则，按照ID精确匹配查询。不能只传入“*”。 name 否 String 实例名称。 “*”为系统保留字符，如果name是以“*”起始，表示按照*后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“*”。 type 否 String 按照实例类型查询，取值区分大小写。 取值范围： Enterprise（区分大小写），对应分布式实例（独立部署）。 Centralization_standard（区分大小写），对应主备版实例。 datastore_type 否 String 数据库类型，支持“GaussDB”，区分大小写。 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 根据实例标签键值对进行查询。 {key}表示标签键，不可以为空或重复。最大长度127个unicode字符。key不能为空或者空字符串，不能为空格，使用之前先trim前后半角空格。不能包含+/?#&=,%特殊字符。 {value}表示标签值，可以为空。最大长度255个unicode字符，使用之前先trim 前后半角空格。不能包含+/?#&=,%特殊字符。 如果value为空，则表示any_value（查询任意value）。 如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，最多包含10组。 charge_mode 否 String 计费模式。 取值范围： postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。

响应示例 创建一个GaussDB分布式独立部署，按需付费，引擎版本为2.7，同一可用区下，3个协调节点，3个分片，3个副本，规格为8U64G的实例： { "instance": { "id": "ad8cd1440aa94a02ae4580fcbebb3143in14", "name": "user1-v3-independent-01", "status": "BUILD", "datastore": { "type": "GaussDB", "version": "2.7" }, "ha": { "mode": "Enterprise", "replication_mode": "sync", "consistency": "strong" }, "port": "8000", "volume": { "type": "ULTRAHIGH", "size": 120 }, "replica_num": 3, "region": "aaa", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "enterprise_project_id": "0", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "availability_zone": "bbb,bbb,bbb", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "charge_info": { "charge_mode": "postPaid" } }, "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af" } GaussDB分布式部署形态，包周期付费（1年），引擎版本为2.7，三个不同可用区下，3个协调节点，3个分片，3个副本，规格为8U64G的实例响应： { "instance": { "id": "ad8cd1440aa94a02ae4580fcbebb3143in14", "name": "user1-v3-independent-02", "datastore": { "type": "GaussDB", "version": "2.7" }, "ha": { "mode": "Enterprise", "replication_mode": "sync", "consistency": "strong" }, "port": "8000", "volume": { "type": "ULTRAHIGH", "size": 120 }, "replica_num": 3, "region": "aaa", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "enterprise_project_id": "0", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "availability_zone": "bbb,bbb,bbb", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "charge_info": { "charge_mode": "prePaid", "period_type": "year", "period_num": 1, "is_auto_renew": false, "is_auto_pay": false } }, "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af" } GaussDB主备版高可用（1主2备），按需付费，引擎版本为2.7，同一可用区下，规格为8U64G的实例响应： { "instance": { "id": "ad8cd1440aa94a02ae4580fcbebb3143in14", "name": "user1-v3-ha-01", "status": "BUILD", "datastore": { "type": "GaussDB", "version": "2.7" }, "ha": { "mode": "Enterprise", "replication_mode": "sync", "consistency": "strong" }, "port": "8000", "volume": { "type": "ULTRAHIGH", "size": 120 }, "region": "aaa", "replica_num": 3, "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "enterprise_project_id": "0", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "availability_zone": "bbb,bbb,bbb", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "charge_info": { "charge_mode": "postPaid" }, "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f" }, "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af" } GaussDB主备版高可用（1主2备），包周期付费（1年），引擎版本为2.7，三个不同可用区下，规格为8U64G的实例响应： { "instance": { "id": "ad8cd1440aa94a02ae4580fcbebb3143in14", "name": "user1-v3-ha-02", "datastore": { "type": "GaussDB", "version": "2.7" }, "ha": { "mode": "Enterprise", "replication_mode": "sync", "consistency": "strong" }, "port": "8000", "volume": { "type": "ULTRAHIGH", "size": 120 }, "replica_num": 3, "region": "aaa", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "enterprise_project_id": "0", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "availability_zone": "bbb,bbb,bbb", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "charge_info": { "charge_mode": "prePaid", "period_type": "year", "period_num": 1, "is_auto_renew": false, "is_auto_pay": false } }, "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af" }

请求示例 创建一个GaussDB实例，实例部署形态为分布式独立部署，包周期付费（1年），引擎版本为2.7，三个不同可用区下，3个协调节点，3个分片，3个副本，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-independent-02", "datastore": { "type": "GaussDB", "version": "2.7" }, "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "volume": { "type": "ULTRAHIGH", "size": 120 }, "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab", "region": "aaa", "availability_zone": "bbb,ccc,ddd", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "charge_info": { "charge_mode": "prePaid", "period_type": "year", "period_num": 1 }, "password": "xxxxxx", "configuration_id": "", "enterprise_project_id": "", "time_zone": "UTC+08:00", "ha":{ "mode":"enterprise", "consistency":"strong", "replication_mode":"sync" }, "sharding_num": 3, "coordinator_num": 3, "replica_num": 3, "port":8000, "enable_force_switch":true } 创建一个GaussDB实例，实例部署形态为主备版高可用（1主2备），按需付费，引擎版本为2.7，同一可用区下，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-ha-01", "datastore": { "type": "GaussDB", "version": "2.7" }, "flavor_ref": "gaussdb.opengauss.ee.km1.2xlarge.arm8.ha", "volume": { "type": "ULTRAHIGH", "size": 120 }, "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab", "region": "aaa", "availability_zone": "bbb,bbb,bbb", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "charge_info": { "charge_mode": "postPaid" }, "password": "xxxxxx", "configuration_id": "", "enterprise_project_id": "", "time_zone": "UTC+08:00", "ha": { "mode": "centralization_standard", "consistency": "strong", "replication_mode": "sync" }, "replica_num": 3, "port": 8000, "enable_force_switch": true } 创建一个GaussDB实例，实例部署形态为主备版高可用（1主2备），包周期付费（1年），引擎版本为2.，三个不同可用区下，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-ha-02", "datastore": { "type": "GaussDB", "version": "2.7" }, "flavor_ref": "gaussdb.opengauss.ee.km1.2xlarge.arm8.ha", "volume": { "type": "ULTRAHIGH", "size": 120 }, "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab", "region": "aaa", "availability_zone": "bbb,ccc,ddd", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "charge_info": { "charge_mode": "prePaid", "period_type": "year", "period_num": 1 }, "password": "xxxxxx", "configuration_id": "", "enterprise_project_id": "", "time_zone": "UTC+08:00", "ha": { "mode": "centralization_standard", "consistency": "strong", "replication_mode": "sync" }, "replica_num": 3, "port": 8000, "enable_force_switch": true }

响应参数 表8 响应参数 名称 参数类型 说明 instance Object 实例信息。 详情请参见表9。 job_id String 实例创建的任务ID。 仅创建按需实例时会返回该参数。 order_id String 订单号，创建包年包月时返回该参数。 表9 instance说明 名称 参数类型 说明 id String 实例ID。 name String 实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。 取值范围：4~64个字符之间，必须以字母开头，不区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 status String 实例状态。如BUILD，表示创建中。 仅创建按需实例时会返回该参数。 datastore Object 数据库信息。 详情请参见表10。 ha Object 数据库部署形态。 详情请参见表11。 replica_num Integer 实例副本集数。 port String 数据库端口信息，与请求参数相同。 backup_strategy Object 自动备份策略。 详情请参见表12。 enterprise_project_id String 项目标签。 flavor_ref String 规格码，取值范围：非空。 volume Object volume信息。 详情请参见表13。 region String 区域ID。 availability_zone String 可用区ID。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 实例所属的安全组。 charge_info Object 付费方式信息。 详情请参见表14。 表10 datastore字段数据结构说明 名称 参数类型 说明 type String 数据库引擎，返回值如下： GaussDB version String 数据库版本。 表11 ha字段数据结构说明 名称 参数类型 说明 mode String GaussDB分布式模式支持取值：enterprise(企业版) ，combined(基础版混合部署)，主备版取值:centralization_standard，不区分大小写。 replication_mode String 备机同步模式。固定取值为sync，表示数据同步方式为“同步模式”。 consistency String GaussDB的预留参数：指定事务一致性类型，取值范围： strong：强一致性。 eventual：最终一致性。 consistency_protocol String 指定副本一致性协议类型，取值范围：quorum 、paxos。不填时，默认为quorum。 表12 backup_strategy字段数据结构说明 名称 参数类型 说明 start_time String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 取值示例： 08:00-09:00 23:00-00:00 如果请求体中不填写“backup_strategy”字段，则响应体中 “start_time”默认返回“02:00-03:00”。 keep_days Integer 指定已生成备份文件的可保存天数。 取值范围：1～732。如果请求体中不填写“backup_strategy”字段，则响应体中 “keep_days”默认填写为7天。 表13 volume字段数据结构说明 名称 参数类型 说明 type String 磁盘类型。 取值如下，区分大小写： ULTRAHIGH，表示SSD盘。 ESSD,表示极速云盘。 size Integer 磁盘大小。 表14 charge_Info字段数据结构说明 名称 参数类型 说明 charge_mode String 计费模式。 postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。 period_type String 订购周期类型。month：包月。year：包年。说明：“charge_mode”为“prePaid”时生效，且为必选值。 枚举值： month year period_num Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。当“period_type”为“year”时，取值为1~3。 is_auto_renew Boolean 创建包周期实例时可指定,表示是否自动续订,续订时会自动支付。 按月订购时续订周期默认为1个月,按年订购时续订周期默认为1年,续订周期可自定义修改。 true,表示自动续订。 false,表示不自动续订,默认为该方式。 is_auto_pay Boolean 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该支付方式。

请求示例 设置GaussDB实例备份策略，备份文件保存时长7天，备份时间段为19:00-20:00。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy { "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2,3,4,5", "differential_period": "30", "rate_limit": 75 , "prefetch_block": 64 , "file_split_size": 4 , "enable_standby_backup" : false } }