华为云用户手册

响应示例 查询可应用当前参数组模板的实例列表成功。 { "instances": [ { "instance_id": "1995a67680474481b3e42ac1474e32e0in14", "instance_name": "gauss-a283" }, { "instance_id": "8303819fd8744ef69f34595e9710a33din14", "instance_name": "gauss-2423-lt-master" }], "total_count": 2}

URI DELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 backup_id 是 String 手动备份ID。

响应示例 查询数据库用户列表成功。 { "users": [ { "name": "root", "attribute": { "rolsuper": false, "rolinherit": true, "rolcreaterole": true, "rolcreatedb": true, "rolcanlogin": true, "rolconnlimit": -1, "rolreplication": false, "rolbypassrls": false, "rolpassworddeadline": "" }, "memberof": "{gs_role_copy_files,gs_role_signal_backend,gs_role_tablespace,gs_role_replication,gs_role_account_lock}", "lock_status": false } ], "total_count": 1}

URI GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applicable-instances 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 config_id 是 String 参数模板ID。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1~10条数据。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

响应参数 表2 参数说明 参数 参数类型 描述 users Array of objects 参数解释： 列表中每个元素表示一个数据库用户，详情参见表3。 total_count Integer 参数解释： 总记录数。 取值范围： [0, 2^31-1]，取决于实际查询大小。 表3 users字段数据结构说明 参数 参数类型 描述 name String 参数解释： 用户名称。 取值范围： 不涉及。 attribute Object 参数解释： 用户的权限属性，详情参见表 attribute字段数据结构说明。 memberof String 参数解释： 用户的默认权限。 取值范围： 不涉及。 lock_status Boolean 参数解释： 用户是否被锁。 取值范围： 取值为“true”或“false”。 表4 attribute字段数据结构说明 参数 参数类型 描述 rolsuper Boolean 参数解释： 用户是否具有管理员权限。 取值范围： 取值为“true”或“false”。 rolinherit Boolean 参数解释： 用户是否自动继承其所属角色的权限。 取值范围： 取值为“true”或“false”。 rolcreaterole Boolean 参数解释： 用户是否支持创建其他子用户。 取值范围： 取值为“true”或“false”。 rolcreatedb Boolean 参数解释： 用户是否可以创建数据库。 取值范围： 取值为“true”或“false”。 rolcanlogin Boolean 参数解释： 用户是否可以登录数据库。 取值范围： 取值为“true”或“false”。 rolconnlimit Integer 参数解释： 用户连接实例的最大并发连接数。-1表示没有限制。 取值范围： 不涉及。 rolreplication Boolean 参数解释： 用户是否属于复制角色。 取值范围： 取值为“true”或“false”。 rolbypassrls Boolean 参数解释： 用户是否绕过每个行级安全策略。 取值范围： 取值为“true”或“false”。 rolpassworddeadline String 参数解释： 用户密码过期时间。 取值范围： 不涉及。

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-users 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 offset 否 Integer 参数解释： 分页符。从第一条数据偏移offset页数据后开始查询例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。 约束限制： 不涉及。 取值范围： [0, 2^31-1] 默认取值： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 每页显示的条目数量。 约束限制： 不涉及。 取值范围： [1, 100] 默认取值： 默认为10。

URI DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 config_id 是 String 参数模板ID。

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

请求示例 创建一个用户标签，key为1，value为2。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/tags{"tags": [{"key":"1", "value":"2"}]}

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 tags 是 Array of objects 需要添加的用户标签列表。 详情请参见表3。 表3 tags参数说明 名称 是否必选 参数类型 说明 key 是 String 标签键。 说明： 允许包含任意语种字母、数字、空格和_ . : = + - @特殊字符，但首尾不能含有空格，不能以_sys_开头，限制长度最长128。 value 是 String 标签值。 说明： 允许包含任意语种字母、数字、空格和_ . : / = + - @特殊字符，限制长度最长255。

请求示例 按备份文件恢复到新实例，新实例规格为8U64G，磁盘为160G。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances{ "name": "targetInst", "availability_zone": "aaa,bbb,ccc", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "volume": { "type": "ULTRAHIGH", "size": 160 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "password": "******", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14", "backup_id": "2f4ddb93b9014b0893d81d2e472f30febr14" }, "enable_parallel_restore": false, "configuration_id": "52e86e87445847a79bf807ceda213165pr01", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "port": 8000, "enable_force_switch": true, "time_zone": "UTC+04:00"} 按备份文件恢复到新实例，新实例规格为8U64G，磁盘为160G。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances{ "name": "targetInst", "availability_zone": "aaa,bbb,ccc", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "volume": { "type": "ULTRAHIGH", "size": 160 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "password": "******", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14", "backup_id": "2f4ddb93b9014b0893d81d2e472f30febr14", "type": "backup" }, "enable_parallel_restore": false, "configuration_id": "52e86e87445847a79bf807ceda213165pr01", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "port": 8000, "enable_force_switch": true, "time_zone": "UTC+04:00"} 按时间点恢复到新实例，新实例规格为8U64G，磁盘为160G。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances{ "name": "targetInst", "availability_zone": "aaa,bbb,ccc", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "volume": { "type": "ULTRAHIGH", "size": 160 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "password": "******", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14", "type": "timestamp", "restore_time": 1532001446987 }, "enable_parallel_restore": false, "configuration_id": "52e86e87445847a79bf807ceda213165pr01", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "port": 8000, "enable_force_switch": true, "time_zone": "UTC+04:00"}

响应消息 恢复到新实例成功。 { "instance": { "id": "2gfdsh844a4023a776fc5c5fb71fb4in14", "name": "gaussdb-instance-rep2", "status": "BUILD", "datastore": { "type": " GaussDB ", "version": "1.4" }, "ha": { "mode": "enterprise", "consistency": "strong", "replication_mode": "sync" }, "volume": { "type": "ULTRAHIGH", "size": 160 }, "port": "8000", "replica_num": 3, "region": "regionA", "enable_parallel_restore": false, "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "availability_zone": "aaa,bbb,ccc", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "charge_info": { "charge_mode": "postPaid" }, "enterprise_project_id": "fdsa-3rds", }, "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"}

响应参数 表7 要素说明 参数 参数类型 描述 instance Object 实例信息。 详情请参见表8。 job_id String 恢复新实例的任务id。 order_id string 创建实例的订单ID。 仅创建包周期实例时会返回该参数。 表8 instance说明 参数 参数类型 描述 id String 实例id。 name String 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。 取值范围：4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 status String 实例状态。如BUILD，表示创建中。 datastore Object 数据库信息。 详情请参见表9 ha Object 实例部署形态。 详情请参见表10 port String 数据库端口信息。 当不传该参数时，默认端口8000。 enterprise_project_id String 项目标签。 volume Object volume信息。 详情请参见表11 backup_strategy Object 自动备份策略。 详情请参见表12 replica_num Integer 实例副本数。 region String 区域ID。 取值范围：非空，请参见地区和终端节点。 flavor_ref String 规格码。 availability_zone String 可用区ID。可选部署在同一可用区或三个不同可用区，可用区之间用逗号隔开。 取值范围：非空，请参见地区和终端节点。 vpc_id String 虚拟私有云ID。 subnet_id String 子网ID。 security_group_id String 安全组ID。 charge_info Object 付费方式信息，支持按需和包周期。 详情请参见表13。 表9 datastore字段数据结构说明 参数 参数类型 描述 type String 数据库引擎，返回值如下： GaussDB 枚举值： GaussDB version String 数据库版本。 表10 ha字段数据结构说明 参数 参数类型 描述 mode String GaussDB 分布式模式，返回值为：enterprise（企业版）；主备版，返回值为：centralization_standard(主备版)。 replication_mode String 备机同步模式。固定取值为sync，表示数据同步方式为“同步模式”。 consistency String GaussDB的预留参数：指定实例一致性类型，取值范围：strong（强一致性） | eventual(最终一致性)。 枚举值： strong eventual 表11 volume字段数据结构说明 参数 参数类型 描述 type String 磁盘类型。 取值如下，区分大小写： ULTRAHIGH，表示SSD。 ESSD，表示极速云盘 枚举值： ULTRAHIGH ESSD size Integer 磁盘大小。 GaussDB分布式实例恢复时需指定大小：要求必须为（分片数*4GB）的倍数，取值范围：（分片数*40GB）~（分片数*16TB）。 表12 backup_strategy字段数据结构说明 参数 参数类型 描述 start_time String 废弃字段。无需关注。 keep_days Integer 废弃字段。无需关注。 表13 charge_info字段数据结构说明 参数 参数类型 描述 charge_mode String 计费模式。支持postPaid，后付费，即按需付费；perPaid，先付费，即包周期。 period_type string 订购周期类型。month:包月。year:包年。 说明: “charge_mode”为“prePaid”时生效,且为必选值。 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,表示手动从账户中支付,默认为该支付方式。

请求参数 表2 参数说明 参数 是否必选 参数类型 描述 name 是 String 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。 取值范围：4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 availability_zone 是 String 可用区ID。 GaussDB取值范围：非空，可选部署在同一可用区或三个不同可用区，可用区之间用逗号隔开。详见示例。 部署在同一可用区：需要输入三个相同的可用区。例如：部署在“cn-north-4a”可用区，则需要在此处输入"cn-north-4a,cn-north-4a,cn-north-4a"。 部署在三个不同可用区：需要分别输入三个不同的可用区。 取值范围：非空，请参见地区和终端节点。 flavor_ref 是 String 规格码，取值范围：非空。参考查询数据库规格中“spec_code”字段获取。 volume 是 Object volume信息。 详情请参见表3 disk_encryption_id 否 String 用于磁盘加密的密钥ID，默认为空。 vpc_id 是 String 虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 subnet_id 是 String 子网的网络ID信息，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 security_group_id 是 String 指定实例所属的安全组。如果不需要指定安全组，请联系客服申请白名单。 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。 password 是 String 数据库密码。 GaussDB密码取值范围: 非空； 至少包含大写字母（A-Z），小写字母（a-z），数字（0-9），非字母数字字符（限定为~!@#%^*-_=+?,）四类字符中的三类字符；长度8~32个字符。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 charge_info 否 Object 付费方式信息，支持按需和包周期。 详情请参见表4。 backup_strategy 否 Object 自动备份策略。 详情请参见表6。 restore_point 是 Object 恢复数据源对象。 详情请参见表5。 enable_parallel_restore 否 Boolean 是否支持备份并行恢复。当不传该参数时，企业版默认为不支持，主备版默认支持。 configuration_id 否 String 参数组ID。当不传该参数时，使用系统默认的参数模板。 enterprise_project_id 否 String 企业项目ID。 port 否 String 数据库对外开放的端口，不填默认为8000，可选范围为：1024-39998。限制端口： 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。 time_zone 否 String UTC时区。 不选择时，GaussDB国内站默认为UTC时间。 选择填写时，取值范围为UTC-12:00~UTC+12:00，且只支持整段时间，如UTC+08:00，不支持UTC+08:30。 enable_force_switch 否 Boolean enable_force_switch表示是否开启备机强升主功能，仅支持取值true，false。 enable_force_switch=true表示开启备机强升主功能，enable_force_switch=false表示关闭，默认关闭。仅支持1.2.2及以上版本。 说明： 备机强升主功能适用场景：在主机发生故障后，为了保障集群的可用性，强制拉起备机作为新主机对外提供服务的场景。 本功能在集群故障状态下，以丢失部分数据为代价换取集群尽可能快的恢复服务。本功能是集群状态为不可用时的一个逃生方法，如果操作者不清楚备机强升后丢失数据对业务的影响，请勿使用本功能。 表3 volume字段数据结构说明 参数 是否必选 参数类型 描述 type 是 String 磁盘类型。 主备模式仅支持LOCALSSD，分布式模式独立部署仅支持ULTRAHIGH，区分大小写，表示本地SSD盘及云磁盘。 支持ULTRAHIGH，表示本地盘；支持ESSD，表示极速云盘。 size 是 Integer 磁盘大小，需要大于等于原实例。例如：该参数填写为“40”，表示为恢复的实例分配40GB的磁盘空间。 E CS 部署方案取值范围：（分片数*40GB）~（分片数*16TB），且大小只能为分片数*4GB的整数倍。 表4 charge_info字段数据结构说明 参数 是否必选 参数类型 描述 charge_mode 是 String 计费模式。支持postPaid，后付费，即按需付费；prePaid，先付费，即包周期。 period_type 否 string 订购周期类型。month:包月。year:包年。 说明: “charge_mode”为“prePaid”时生效,且为必选值。 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,表示手动从账户中支付,默认为该支付方式。 表5 restore_point字段数据结构说明 参数 是否必选 参数类型 描述 instance_id 是 String 源实例ID。 backup_id 否 String 用于恢复的备份ID。 type 否 String 表示恢复方式，枚举值： “backup”，表示使用备份文件恢复，按照此方式恢复时，“type”字段为非必选，“backup_id”必选。 “timestamp”，表示按时间点恢复，按照此方式恢复时，“type”字段必选，“restore_time”必选。 枚举值： backup timestamp restore_time 否 Long 恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。 表6 backup_strategy字段数据结构说明 参数 是否必选 参数类型 描述 start_time 是 String 废弃字段，无需填写。 keep_days 否 Integer 废弃字段，无需填写。

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 offset 否 Integer 参数解释： 分页符。从第一条数据偏移offset页数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。 约束限制： 必须为数字，不能为负数。 取值范围： [0, 2^31-1] 默认取值： 默认为0（偏移0页数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 每页显示的条目数量。 约束限制： 不涉及。 取值范围： [1, 100] 默认取值： 默认为10。

响应示例 查询数据库列表成功。 { "databases": [ { "name": "gaussdb_test", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" }, { "name": "gaussdb_test1", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" }, { "name": "gaussdb_test2", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" } ], "total_count": 3}

响应参数 表2 参数说明 参数 参数类型 描述 databases Array of objects 参数解释： 列表中每个元素表示一个数据库。详情参见表3。 total_count Integer 参数解释： 总记录数。 取值范围： [0, 2^31 - 1]，实际总数取决于实例个数。 表3 databases字段数据结构说明 参数 参数类型 描述 name String 参数解释： 数据库名称。 取值范围： 不涉及。 owner String 参数解释： 数据库所属用户。 取值范围： 不涉及。 character_set String 参数解释： 数据库使用的字符集，例如UTF8。 取值范围： 不涉及。 collate_set String 参数解释： 数据库排序集，例如en_US.UTF-8等。 取值范围： 不涉及。 size String 参数解释： 数据库大小，单位MB。 取值范围： 不涉及。 datctype String 参数解释： 数据库使用的字符分类，例如en_US.UTF-8等。 取值范围： 不涉及。 compatibility_type String 参数解释： 数据库兼容的类型，如GaussDB，M。 取值范围： 不涉及。

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

请求示例 查询分布式版数据库磁盘类型 GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/storage-type?version=3.208&ha_mode=enterprise 查询主备版数据库磁盘类型 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/storage-type?version=3.208&ha_mode=centralization_standard

响应示例 查询数据库磁盘类型列表成功。 { "storage_type": [ { "name": "ULTRAHIGH", "az_status": { "aaa": "normal", "bbb": "normal", "ccc": "normal" }, "support_compute_group_type": [ "normal", "armFlavors", "armFlavors2Shared", "normal2" ] }, { "name": "ESSD", "az_status": { "az2xahz": "normal", "az1xahz": "normal", "az3xahz": "normal" }, "support_compute_group_type": [ "normal", "armFlavors", "armFlavors2Shared", "normal2" ] } ]}

请求示例 创建一个 GaussDB数据库 ，库名为gaussdb_test。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/database{ "name" : "gaussdb_test", "owner" : "test", "template" : "template0", "character_set" : "UTF8", "lc_collate" : "en_US.UTF-8", "lc_ctype" : "en_US.UTF-8" }

URI DELETE https://{Endpoint}/v3/{project_id}/jobs/{job_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 job_id 是 String 任务ID。

URI GET https://{Endpoint}/v3/{project_id}/storage-type?version={version}&ha_mode={ha_mode} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 version 是 String 参数解释： 数据库版本号。可通过查询数据库引擎的版本查询。 取值范围： 不涉及。 ha_mode 否 String 参数解释： 实例类型。 不区分大小写。 取值范围： enterprise(分布式版) centralization_standard(主备版)

请求示例 在gaussdb_test数据库中创建多个SCHEMA。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/schema{ "db_name" : "gaussdb_test", "schemas" : [ { "name" : "rds", "owner" : "teste123" }, { "name" : "rds001", "owner" : "teste123" } ] }

URI GET https://{Endpoint}/v3/{project_id}/predefined-tags 表1 请求参数 名称 类型 IN 是否必选 描述 project_id string path 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 不能使用模板库，且是已存在的数据库名称。 模板库包括postgres， template0 ，template1。 schemas 是 Array of objects 每个元素都是与数据库相关联的schema信息。单次请求最多支持20个元素。详情请参见表3 表3 schemas字段数据结构说明 名称 是否必选 参数类型 说明 name 是 String SCHEMA名称。 SCHEMA名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，且不能和模板库和已存在的schema重名。模板库包括postgres， template0 ，template1。 已存在的SCHEMA包括public，information_schema。 owner 是 String SCHEMA的属主用户。 不能使用系统用户，且是已存在的数据库用户名称。 系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”。

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

响应示例 查询任务列表成功。 { "tasks" : [ { "instance_info" : { "instance_id" : "ce2dce50f365430abe161bab79495a6ein14", "instance_name" : "gauss-6568-zzh", "instance_status" : "creating" }, "job_id" : "03bc055a-135c-4245-8bd8-b0bc6d3350b3", "name" : "CreateGaussDBV5Instance", "status" : "Failed", "process" : "", "created_at": "2022-08-05T08:15:07+0800", "ended_at": "2022-08-09T03:06:52+0800", "fail_reason" : "500000" }, { "instance_info" : { "instance_id" : "20ba433bd7ee40da9cf35064f04f9e4cin14", "instance_name" : "gauss-7875-lt-m", "instance_status" : "deleted" }, "job_id" : "2cc16e0b-75ab-4a28-9453-16517e990bba", "name" : "DeleteGaussDBV5Instance", "status" : "Completed", "process" : "", "created_at": "2022-08-06T09:15:07+0800", "ended_at": "2022-08-10T03:06:52+0800", "fail_reason" : null } ], "total_count" : 2 }

请求示例 查询任务状态为“运行中”的任务列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Running&name=CreateGaussDBV5Instance&offset=1&limit=10 查询任务状态为“完成”的任务列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Completed&name=CreateGaussDBV5Instance&offset=1&limit=10 查询任务状态为“失败”的任务列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Failed&name=CreateGaussDBV5Instance&offset=1&limit=10

URI GET https://{Endpoint}/v3/{project_id}/tasks 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 status 否 String 任务状态。 Running：运行中 Completed：完成 Failed：失败 name 否 String 任务名称。 CreateGaussDBV5Instance：创建实例。 BackupSnapshotGaussDBV5InInstance：手动创建备份。 CloneGaussDBV5NewInstance：恢复到新实例。 RestoreGaussDBV5InInstance：恢复到当前实例。 RestoreGaussDBV5InInstanceToExistedInst：恢复到已有实例 DeleteGaussDBV5Instance：删除实例。 EnlargeGaussDBV5Volume：磁盘扩容。 ResizeGaussDBV5Flavor：规格变更。 GaussDBV5ExpandClusterCN：协调节点扩容。 GaussDBV5ExpandClusterDN：分片扩容。 start_time 否 String 开始时间。UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time 否 String 结束时间。UNIX时间戳格式，单位是毫秒，时区是UTC。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。