华为云用户手册

请求示例 创建一个 GaussDB 实例，实例部署形态为分布式独立部署，包周期付费（1年），引擎版本为V2.0-2.7，三个不同可用区下，3个协调节点，3个分片，3个副本，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.2/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-independent-02", "datastore": { "type": "GaussDB", "version": "V2.0-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备），按需付费，引擎版本为V2.0-2.7，同一可用区下，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.2/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-ha-01", "datastore": { "type": "GaussDB", "version": "V2.0-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年），引擎版本为V2.0-2.7，三个不同可用区下，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.2/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-ha-02", "datastore": { "type": "GaussDB", "version": "V2.0-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(企业版) ，集中式版取值: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，表示手动从账户中支付，默认为该支付方式。

请求参数 表2 请求参数 名称 是否必选 参数类型 说明 name 是 String 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。 取值范围：4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 datastore 是 Object 数据库信息。 详情请参见表3。 ha 是 Object 实例部署形态。详情请参见表4。 configuration_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。 password 是 String 数据库密码。 GaussDB密码取值范围: 非空; 至少包含大写字母(A-Z)，小写字母(a-z)，数字(0-9)，非字母数字字符(限定为~!@#%^*-_=+?,)四类字符中的三类字符;长度8~32个字符。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 backup_strategy 否 Object 备份策略。 详情请参见表5。 enterprise_project_id 否 String 企业项目ID。只有企业租户时该参数才生效。 使用请参考《企业管理 API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。 disk_encryption_id 否 String 用于磁盘加密的密钥ID，默认为空。 密钥授权请参考《 数据加密 服务 用户指南》的“创建授权”章节。 flavor_ref 是 String 规格码，取值范围：非空。参考查询数据库规格中“spec_code”字段获取。 volume 是 Object volume信息。 详情请参见表6。 region 是 String 区域ID。 取值范围：非空，请参见地区和终端节点。 availability_zone 是 String 可用区ID。 GaussDB取值范围：非空，可选部署在相同可用区或不同可用区，可用区之间用逗号隔开。 取值范围：非空，请参见地区和终端节点。 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接口查询，具体操作可参考查询安全组列表。 charge_info 否 Object 计费类型信息，仅支持按需和包周期。 详情请参见表7。 time_zone 否 String UTC时区。 不选择时，GaussDB国内站默认为UTC时间。 选择填写时，取值范围为UTC-12:00~UTC+12:00，且只支持整段时间，如UTC+08:00，不支持UTC+08:30。 sharding_num 否 Integer 仅分布式形态需要填写该参数。分片数量，取值范围1~9。 coordinator_num 否 Integer 仅分布式形态需要填写该参数。协调节点数量，取值范围1~9。CN数量必须小于或等于两倍的分片数。 replica_num 否 Integer 实例副本集数，支持取值3。不填默认为3。 enable_force_switch 否 Boolean enable_force_switch表示是否开启备机强升主功能，仅支持取值true，false。true表示开启备机强升主功能，false表示关闭，默认关闭。仅支持1.2.2及以上版本。 说明： 备机强升主功能适用场景：在主机发生故障后，为了保障集群的可用性，强制拉起备机作为新主机对外提供服务。本功能在集群故障状态下，以丢失部分数据为代价换取集群尽可能快的恢复服务，是集群状态为不可用时的一个逃生方法。 enable_single_float_ip 否 Boolean 单浮动IP策略，仅V2.0-3.207及以上版本的集中式版实例支持。默认值是false，表示不开启单浮动IP策略。 取值范围： true：开启单浮动IP策略，实例将只有一个浮动IP绑定主节点，如果发生主备倒换，浮动IP不会发生变化。 false：不开启单浮动IP策略，每个节点都会绑定一个浮动IP，如果发生主备倒换，浮动IP会发生变化。 表3 datastore字段数据结构说明 名称 是否必选 参数类型 说明 type 是 String 数据库引擎，取值如下： GaussDB。不区分大小写。 version 否 String 数据库版本。不填时，默认为当前最新版本。 GaussDB支持的版本参考查询数据库引擎的版本查询。 表4 ha字段数据结构说明 名称 是否必选 参数类型 说明 mode 是 String GaussDB为分布式模式取值：enterprise(企业版) ，集中式版取值:centralization_standard，不区分大小写。 consistency 是 String 指定事务一致性类型，取值如下，不区分大小写： strong：强一致性。 eventual：最终一致性。 replication_mode 是 String 备机同步模式。固定取值为sync，表示数据同步方式为“同步模式”。 instance_mode 否 String 指定创建实例的产品类型。不传该参数默认创建企业版实例，创建基础版和生态版需要指定参数值。 enterprise：创建企业版实例。 basic：创建基础版实例。 ecology：创建生态版实例。 表5 backup_strategy字段数据结构说明 名称 是否必选 参数类型 说明 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空且非负，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 取值示例： 08:00-09:00 23:00-00:00 keep_days 否 Integer 指定备份文件的可保存天数。 取值范围： 1~36500。该参数缺省时，默认填写为7天。 表6 volume字段数据结构说明 名称 是否必选 参数类型 说明 type 是 String 磁盘类型。 仅支持ULTRAHIGH和ESSD，区分大小写，分别表示SSD和极速云盘。 size 是 Integer 磁盘大小。例如：该参数填写为“40”，表示为创建的实例分配40GB的磁盘空间。 E CS 部署方案：取值范围：（分片数*40GB）~（分片数*24TB），且大小只能为分片数*4GB的整数倍。 表7 chargeInfo字段数据结构说明 名称 是否必选 参数类型 说明 charge_mode 是 String 计费模式。 postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。 period_type 否 String 订购周期类型。“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，为手动支付，默认该方式。

响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体，为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_code": "AS.0001", "error_msg": "The format of message is error" } 其中，“error_code”表示错误码，“error_msg”表示错误描述信息。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } }

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK 认证方式的接口请求或者多project场景采用AK/SK认证的接口请求则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如 IAM 服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

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

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用创建的用户进行日常管理工作。 用户 用户是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型

GaussDB通用型、独享型和鲲鹏独享型性能规格之间的区别是什么 GaussDB的实例规格CPU架构分为X86架构和ARM架构，不同架构支持的规格类型如下。不同规格类型之间的区别请参见表1。 X86架构：独享型（1:4）、独享型（1:8）、通用型（1:4） ARM架构：鲲鹏独享型（1:4）、鲲鹏独享型（1:8） 表1 通用型、独享型和鲲鹏独享型性能规格差异 性能规格 支持的实例类型 说明 通用型 基础版 底层使用ECS通用计算实例，这种实例侧重于资源共享，可以提供更高的性价比，但在主机重负载的情况下可能会出现资源争抢，从而导致计算性能波动，不适合部署大型业务，因此企业版也就不再提供通用型规格。 独享型 基础版 企业版 底层使用ECS通用计算增强型实例（X86架构CPU），实例之间无资源争抢，性能稳定。 鲲鹏独享型 基础版 企业版 底层使用搭载鲲鹏CPU的通用计算增强型实例，实例之间无资源争抢，性能稳定。主要面向信息技术应用创新 (XC) 类场景。 父主题： 产品咨询

GaussDB分布式独立部署与分布式混合部署有什么区别 分布式独立部署 适用于大数据量，期望可以通过横向扩展提高实例数据容量和并发能力，并且分布式混合部署无法满足性能诉求的场景。 所有组件均部署在独立的ECS上，资源无争抢，性能更好。以默认配置（3CN，3副本，3分片）为例，有3个CN、9个DN、3个CMS、3个GTM，需要18台ECS。 分布式混合部署 适用于较大数据量，未来数据量可能会大幅增长，对性能要求不高且希望使用 分布式数据库 的场景。 所有组件部署在一台ECS上。例如，分布式混合部署的一主两备形态，仅需3台ECS即可下发。由于各组件共享同一台ECS的性能，在复杂业务场景下可能会出现性能争抢的情况，因此，相较于同规格的分布式独立部署，混合部署的整体性能会稍弱一些。 父主题： 产品咨询

导入Windows操作系统 使用Win + R组合键打开运行框，输入“MMC”，回车。 在MMC控制台菜单栏中单击“文件”，选择“添加/删除管理单元”。 在“添加或删除管理单元”对话框，选择“可用管理单元”区域的“证书”。单击“添加”添加证书。 在“证书管理单元”对话框，选择“计算机账户”，单击“下一步”。 在“选择计算机”对话框，单击“完成”。 在“添加或删除管理单元”对话框，单击“确定”。 在MMC控制台，双击“证书”。 右键单击“受信任的根证书颁发机构”，选择“所有任务”，单击“导入”。 单击“下一步”。 单击“浏览”，将文件类型更改为“所有文件 (*.*)”。 找到下载的根证书ca.pem文件，单击“打开”，然后在向导中单击“下一步”。 您必须在浏览窗口中将文件类型更改为“所有文件 (*.*)”才能执行此操作，因为“.pem”不是标准证书扩展名。 单击“下一步”。 单击“完成”。 单击“确定”，完成根证书导入。

如何防止任意源连接 GaussDB数据库 数据库开放EIP后，如果公网上的恶意人员获取到您的EIP DNS和数据库端口，那么便可尝试破解您的数据库并进行进一步破坏。因此，强烈建议您保护好EIP DNS、数据库端口、数据库账号和密码等信息，并通过云数据库GaussDB实例的安全组限定源IP，保障只允许可信源连接数据库。 为避免恶意人员轻易破解您的数据库密码，请按照云数据库GaussDB实例的密码策略设置足够复杂度密码，并定期修改。 父主题： 网络安全

GaussDB密码过期策略 GaussDB支持通过设置全局变量“password_effect_time”来控制用户密码的默认过期时间。 您可以在云数据库GaussDB界面，通过设置参数“password_effect_time”的值，修改密码过期策略。具体请参见编辑参数模板。 参数“password_effect_time”的值为N，表示密码N天后过期，单位为天。默认值为0，表示创建的用户密码永不过期。 父主题： 数据库参数修改

GaussDB实例在扩容和规格变更期间是否一直可用 目前，GaussDB支持磁盘扩容和CPU/内存规格变更。 在磁盘扩容期间，云数据库GaussDB实例一直可用，业务不受影响，但不允许删除和重启实例。 在CPU/内存规格变更期间，有1到2次网络秒级闪断。规格变更过程中可能会发生主备倒换，倒换时业务可能会短暂中断。 规格变更完成后，在V2.0-3.100版本之前的实例将会重启数据库集群，重启过程业务不可用。V2.0-3.100版本及以上的实例不需要重启数据库集群，将会大幅度降低闪断影响。请选择业务低峰期，避免业务异常中断。重启后实例会自动释放内存中的缓存，请在业务低峰期进行重启，避免对高峰期业务造成影响。 父主题： 扩容及规格变更

GaussDB实例的哪些监控指标需要重点关注 对于GaussDB实例，需要关注的监控指标有：CPU利用率、内存利用率、磁盘空间利用率。 可以根据实际应用场景配置告警提示，当收到告警，可采取相应措施消除告警。 配置示例： 如果在某段时间内（如5min），CPU使用率的平均值出现多次（如4次）不低于某特定值（如90%）的情况，则发出相应Cloud Eye告警。 如果在某段时间内（如5min），内存使用率的平均值出现多次（如3次）不低于某特定值（如90%）的情况，则发出相应Cloud Eye告警。 如果在某段时间内（如5min），磁盘使用率的最大值出现多次（如2次）不低于某特定值（如85%）的情况，则发出相应Cloud Eye告警。 Cloud Eye告警详细配置方法，请参见《 云监控 用户指南》中“创建告警规则”。 采取措施： 收到与CPU利用率、内存利用率有关的告警，通过实例规格变更分别增大CPU、内存。 请参见规格变更。 收到与磁盘空间利用率有关的告警，通过磁盘空间扩容增大磁盘空间。 请参见扩容磁盘。 父主题： 数据库监控

为什么GaussDB自动备份会失败 出现自动备份失败的原因及解决方案如下： 网络环境稳定性不足。 如网络延时、中断，系统会识别并延时半小时再次执行备份，您也可以及时进行一次手动备份。 系统多任务执行。 如任务等待、中止，系统会识别并延时半小时再次执行备份，您也可以及时进行一次手动备份。 实例状态异常。 如实例故障、状态变更中，系统会识别并在状态恢复正常后再次执行备份，您也可以及时进行一次手动备份。 参数修改异常。 如修改参数并关联实例后导致实例故障，您可以对比参数修改前后的值是否正确、修改的参数是否存在关联参数需要一并修改、或者尝试恢复默认参数重启实例。 导入数据异常。 如导入数据不当导致系统表记录丢失，您可以参考迁移方案总览重新导入数据。 如果以上操作仍无法解决问题，请您在管理控制台右上角，选择新建工单，联系客服人员处理。 父主题： 备份与恢复

如何将GaussDB数据库备份到弹性云服务器上 您可以通过导出SQL语句的方式将数据库备份到弹性云服务器上。弹性云服务器不限制存放哪些数据，但是数据必须符合国家法律法规。您可以在弹性云服务器上存放数据库备份，但不建议将弹性云服务器作为数据库备份空间使用。 强烈推荐使用云数据库GaussDB的自动备份和手动备份功能将备份数据存放到专业的 对象存储服务 上，以获得更高的数据可靠性和服务保障。 父主题： 备份与恢复

GaussDB的备份是如何收费的 云数据库GaussDB的备份文件都存储在对象存储服务上，不占用用户购买实例的存储空间，GaussDB提供了和实例磁盘大小相同的部分免费存储空间，用于存放您的备份数据，其总容量约为您购买存储容量的100%。备份存储用量超过数据库存储空间的100%，开始按照阶梯计费。具体收费请参见计费说明。 自动备份的生命周期和实例的生命周期相同。如果实例删除，那么自动备份也会同时被删除，如果您有手动备份，手动备份不会自动删除，具体请参见删除手动备份。 免费的存储空间是在收取了数据盘的存储空间费用后赠送的，数据盘存储空间冻结以后不再收费，因此不再享受备份赠送空间。 用户实例冻结后，将没有免费的存储空间，会导致实例原有自动备份收费。 如果选择解冻实例，将恢复免费的存储空间。 如果直接删除冻结的实例，原有的自动备份将会同时被删除，备份空间不会继续收费。 父主题： 备份与恢复

GaussDB数据库在备份时间段中是否可用 备份窗口是用户定义的时间段，在该时间段内云数据库GaussDB实例将进行备份。云数据库GaussDB服务借助这些定期数据备份，让您能够将云数据库GaussDB实例还原到保留期内的备份点。 在备份时段期间，业务不受影响，但不能在云数据库GaussDB服务的管理控制台做重启等操作。 全量备份时，会连接备份所属的实例，校验该实例的状态。如果校验存在以下两种情况，则校验不通过，会自动进行校验重试。如果重试结束后，仍然无法满足，则备份失败。 备份所属的实例正在执行DDL操作。 从备份所属的实例获取备份锁失败。 父主题： 备份与恢复

如何清理云数据库GaussDB的备份空间 清理自动备份（全量备份+增量备份） 自动备份文件不支持手动删除，可通过修改备份策略调整备份保留天数，超出备份保留天数的已有备份文件会被自动删除。 清理手动备份（全量备份） 手动备份文件支持手动删除，具体请参见删除手动备份。 清理完手动备份后，在“实例管理”页面，单击指定实例名称，进入“基本信息”页面。在“存储与备份”模块可查看备份空间使用情况。 父主题： 备份与恢复

注意事项 极致RTO只关注存在主备同步的备DN的RTO是否满足需求。极致RTO去掉了自带的流控，统一使用recovery_time_target参数来做流控控制。 极致RTO采用了多个page redo线程并行加速回放进度。当备DN回放追平主DN，空载的情况下，单个page redo线程的CPU消耗大约在15%左右（实际值与具体硬件和参数配置相关），备DN回放的总CPU消耗值 = 单个page redo线程的CPU消耗值 x page redo线程数。因为启动的更多的线程，CPU和内存的消耗都会比并行回放、串行回放要多。 极致RTO支持备机读，由于增加了对数据页面历史版本的读取，备DN上的查询性能会低于主DN上的查询性能，低于并行回放备机读的查询性能，但是查询阻塞回放的情况有所缓解。 DDL日志的回放速度远远慢于页面修改日志的回放，频繁DDL可能导致主备时延增大。 当节点的I/O和CPU使用过高时（建议不超过70%），回放和备机读性能会有明显下降。

解决方案 随着业务数据的增加，原来申请的数据库磁盘容量可能会不足，建议用户进行磁盘扩容，确保磁盘空间足够。 如果原有规格的磁盘已是最大，请先升级规格。 针对数据空间过大，可以删除无用的历史表数据。 如果实例变为只读状态，您需要先在管理控制台右上角，选择新建工单，提交申请，联系客服解除只读状态；如果实例非只读状态，则可以直接执行删除操作。 可在业务低峰期对碎片率高的表执行optimize优化，以便释放空间： 清理整张表使用DROP或TRUNCATE操作；删除部分数据，使用DELETE操作。 如果是日志文件占用过多，可以通过清理日志，来释放磁盘空间。 针对大量排序查询导致的临时文件过大，建议优化SQL查询。

GaussDB跨地域内网能访问吗 跨地域内网默认不能访问，不同区域的云服务之间内网互不相通。您可以通过公网访问，或者通过云连接/VPN打通网络实现内网访问。 弹性公网IP：不能通过内网IP地址访问GaussDB实例时，可以使用公网访问。具体请参见通过gsql连接实例。 云连接：对于不同区域的VPC，不区分是否同一账号，都可以互连，跨区域连接实现全球云上网络。具体请参见跨区域VPC互连。 虚拟专用网络 VPN：基于Internet使用加密隧道将不同区域的VPC连接起来。具备成本低、配置简单、即开即用等优点。但它的网络质量依赖Internet。具体请参见通过VPN连接VPC。 父主题： 数据库连接

问题分析 主要从以下几个方面考虑： 排除数据库实例异常 例如：数据库系统故障，实例状态异常，实例或表被锁定。 （常见）使用正确的客户端连接方式 内网连接需要GaussDB与ECS实例必须在同一区域、VPC。 公网连接需要购买或使用已有EIP，并对GaussDB实例绑定该EIP 。 排除连接命令错误 例如：连接地址错误、端口参数配置错误、用户名和密码错误。 （常见）排除网络不通 内网访问 确认ECS与GaussDB是否在同一个区域，VPC。 检查安全组规则。 安全组外访问安全组内的GaussDB实例时，需要为安全组添加相应的入方向规则。 在ECS上测试是否可以正常连接到GaussDB实例地址的端口。 公网访问 检查安全组规则。 安全组外访问安全组内的GaussDB实例时，需要为安全组添加相应的入方向规则。 检查网络ACL规则。 相同区域主机进行ping测试。 （常见）排除实例的磁盘满的情况 当实例处于“磁盘空间满”状态时，影响数据的正常读写操作。 连接失败的常见报错 包含连接失败的常见报错，以及相应的解决方法。

GaussDB与PostgreSQL的关系 最早GaussDB内核引擎基于PostgreSQL9.2开源版本不断演进，根据PG-XC架构衍生了多CN架构，主要开发了分布式执行框架（stream算子）、向量化引擎等领域中较重要的特性。目前GaussDB除了保留PostgreSQL的标准接口和公共函数外，在自研生态、架构和关键技术上也有了新的发展，开源了集中式部署的能力，重构了存储引擎和优化器。GaussDB与PostgreSQL有如下不同： PostgreSQL是进程模型，而GaussDB是线程池模型。 PostgreSQL只支持行存，GaussDB有行存，列存，还有Ustore。 PostgreSQL仅有集中式，GaussDB一套内核既支持集中式，又支持分布式。 GaussDB有很多独特的特性，比如GTM-Lite、Numa-Aware、两地三中心、同城双集群、动态脱敏、全密态、防篡改。 父主题： 产品咨询

GaussDB购买磁盘加密后，备份文件会加密吗 GaussDB购买磁盘加密后，在实例创建成功后不可修改磁盘加密状态，且无法更改密钥。选择“磁盘加密”，存放在对象存储服务上的备份数据不会被加密，如需开通备份数据加密，请在管理控制台右上角，选择新建工单，提交申请。 设置了磁盘加密或备份数据加密后，提醒您保存好密钥，一旦密钥被禁用、删除或冻结，会导致数据库不可用，并且可能无法恢复数据，具体场景如下： 针对磁盘加密，备份数据不加密的场景：可以通过备份恢复到新实例的方式恢复数据。 针对磁盘加密，并且备份数据加密的场景：无法恢复数据。 父主题： 产品咨询