华为云用户手册

URI GET https://{Endpoint}/v3/{project_id}/configurations?offset={offset}&limit={limit} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

请求示例 按备份文件恢复到新实例，新实例规格为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 备机同步参数。 取值： GaussDB为“sync”。 说明： “sync”为同步模式。 枚举值： 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的磁盘空间。 ECS部署方案取值范围：（分片数*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 废弃字段，无需填写。

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不同，使用时请注意。

请求示例 修改企业项目配额，实例的配额设置为1000个，CPU配额100000核数，内存配额200000GB，存储空间配额1000000GB。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/enterprise-projects/quotas { "eps_quotas": [ { "enterprise_projects_id": "0", "instance_quota": 1000, "vcpus_quota": 100000, "ram_quota": 200000, "volume_quota": 1000000 } ] }

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 eps_quotas 是 Array of objects 需要修改的企业配额列表。 表3。 表3 EpsQuotasOption参数说明 名称 是否必选 参数类型 说明 enterprise_projects_id 是 String 企业项目ID。 instance_quota 否 Integer 实例的配额。取值范围：实际创建的实例个数 ~ 100,000。 vcpus_quota 否 Integer CPU的配额。取值范围：实际使用的CPU核数 ~ 2,147,483,646。 ram_quota 否 Integer 内存的配额。单位GB。取值范围：实际使用的内存 ~ 2,147,483,646。 volume_quota 否 Integer 存储空间的配额。单位：GB。取值范围：实际使用的存储空间 ~ 2,147,483,646。

URI GET https://{Endpoint}/v3.1/{project_id}/flavors?limit={limit}&offset={offset}&ha_mode={ha_mode}&version={version}&spec_code={spec_code} 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 version 否 String 数据库版本号。查询指定版本支持的规格。例如1.4。 spec_code 否 String 规格编码，查询指定规格编码的具体规格信息。 ha_mode 否 String 实例类型，查询指定实例类型支持的规格。 集中式：centralization_standard 分布式（独立部署）：enterprise limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为1，limit指定为10，则只展示第2~11条数据。

响应示例 查询数据库规格成功。 { "flavors": [ { "vcpus": "2", "ram": "16", "availability_zone": [ "az2xahz", "az1xahz", "az3xahz" ], "version": "1.4", "name": "GaussDB", "spec_code": "gaussdb.opengauss.ee.dn.m6.large.8.in", "az_status": { "az2xahz": "normal", "az1xahz": "normal", "az3xahz": "normal" }, "group_type": "normal2" } ], "total": 1 }

请求示例 查询主备版数据库规格 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/flavors?offset=0&limit=10&ha_mode=centralization_standard&version=3.208&spec_code=gaussdb.opengauss.ee.km1.2xlarge.arm8.ha 查询分布式数据库规格 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/flavors?offset=0&limit=10&ha_mode=enterprise&version=3.208&spec_code=gaussdb.opengauss.ee.dn.m6.2xlarge.8.in

响应参数 表2 参数说明 参数 参数类型 描述 backups Array of objects 备份信息。 详情请参见表3。 total_count Long 备份文件的总数。 表3 backups字段数据结构说明 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 description String 备份文件描述信息。 begin_time String 备份开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 备份结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 status String 备份状态 枚举值： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 size Double 备份大小(单位：MB)。 type String 备份类型 取值： auto：实例级自动全量备份。 manual：实例级手动全量备份。 datastore Object 数据库信息。 详情请参见表4 instance_id String 实例ID。 表4 datastore字段数据结构说明 参数 参数类型 描述 type String 数据库引擎，不区分大小写，取值如下： GaussDB。 version String 数据库版本。不填时，默认为当前最新版本。 数据库支持版本可根据查询数据库引擎的版本接口获取。

请求示例 查询所有备份列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/backups 根据指定条件查询实例列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=88be33e4c5a64ceba42b42da89310111in14&backup_id=88be1234c5a64ceba42b42da89310111br14&backup_type=auto&begin_time=2022-05-09T16:15:50+0800&end_time=2022-05-09T16:20:45+0800&limit=1&offset=1

响应示例 查询备份列表成功。 { "backups": [ { "id": "a696cd25e4fc453aa503650225cece8bbr14", "name": "GaussDB-hly-ha-20220509080110906", "description": null, "status": "FAILED", "size": 0.0, "type": "auto", "datastore": { "type": "GaussDB", "version": "1.4" }, "begin_time": "2022-05-09T16:01:10+0800", "end_time": "2022-05-09T16:04:31+0800", "instance_id": "164abc6d35114095bb849d007b19db3bin14" }, { "id": "5651c62a7f12461c98020dd3abfe24ccbr14", "name": "GaussDB-hly-master-20220509022658257", "description": null, "status": "FAILED", "size": 0.0, "type": "auto", "datastore": { "type": "GaussDB", "version": "1.4" }, "begin_time": "2022-05-09T10:26:58+0800", "end_time": "2022-05-09T10:30:17+0800", "instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14" } ], "total_count": 167 }

URI GET https://{Endpoint}/v3.1/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 否 String 实例ID，严格匹配UUID规则。日志备份列表查询时实例ID必选。 backup_id 否 String 备份ID，严格匹配UUID规则。 backup_type 否 String 备份类型，取值范围： auto：实例级自动全量备份。 manual：实例级手动全量备份。 Log_Xbsa: XBSA日志备份。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 最小值：0 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 最小值：1 最大值：100 begin_time 否 String 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。与end_time必须同时使用。 end_time 否 String 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。与begin_time必须同时使用。

请求参数 表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" }

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

请求消息头 附加请求头字段，如指定的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在同一个区域也相同，所以简洁起见将这两部分省略。

响应参数 表3 响应Body参数 参数 参数类型 描述 backup Object 备份信息。 详情请参见表4。 job_id String 任务ID。 表4 backup字段数据结构说明 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 description String 备份描述。 begin_time String 备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 status String 备份状态，取值： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 type String 备份类型，“manual”表示手动全量备份。 instance_id String 实例ID。

响应示例 { "backup": { "id": "e76112bfb2074871bf54cb8df5af7f64br14", "name": "backupwqwq32", "description": "mannual backup", "status": "BUILDING", "type": "manual", "begin_time": "2022-05-09T18:02:31+0800", "instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14" }, "job_id": "e4733090-b2c8-4ea7-a33a-f55f65723fb3" }

请求示例 创建GaussDB手动全量备份。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/backups { "instance_id" : "7e01ac5ac5274957ba506f3851d11d51in14", "name" : "backupwqwq3", "description" : "manual backup" }

响应示例 { "list" : [ { "id" : "64d7bad3-6665-4590-baa2-eb5394e49625", "instance_id" : "9b2f4cc6cd584c67bc179a2bfbb37f90in14", "node_id" : "9d8c79cc41074452977a564b335220f5no14", "workflow_id" : "7d77153c12dde-4f3c-a333-7d30503267f2", "file_name" : "c7025305deb34ae9af1be94f698e7949_slowlog_download__9d8c79cc41074452977a564b335220f5no1420230823024331782", "file_size" : "719.0", "file_link" : "***", "bucket_name" : null, "created_at" : 1692758611782, "updated_at" : 1692758611782, "version" : null, "status" : "success", "message" : null }, { "id" : "4712c3b1-d26a-49d4-9652-211d6ac106c5", "instance_id" : "9b2f4cc6cd584c67bc179a2bfbb37f90in14", "node_id" : "9d03b0a73ebd415eb2f692862f326cb7no14", "workflow_id" : "7d77153c12dde-4805-bd0b-d70c803a873a", "file_name" : "c7025305deb34ae9af1be94f698e7949_slowlog_download__9d03b0a73ebd415eb2f692862f326cb7no1420230823024331727", "file_size" : "719.0", "file_link" : "***", "bucket_name" : null, "created_at" : 1692758611727, "updated_at" : 1692758611727, "version" : null, "status" : "success", "message" : null } ] }

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/slow-log/download 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。

响应参数 表2 响应Body参数 参数 参数类型 描述 list Array of SlowLogDownloadInfo objects 慢日志下载信息列表。详情请参见 表3 。 表3 SlowLogDownloadInfo字段数据结构说明 参数 参数类型 描述 id String 慢日志ID。 instance_id String 实例ID。 node_id String 节点ID。 workflow_id String 工作流ID。 file_name String 文件名。 file_size String 文件大小, 单位：Byte。 file_link String 文件下载链接。 bucket_name String 桶名称。 created_at Long 创建时间。 updated_at Long 更新时间。 version String 版本。 status String 状态。 message String 消息。

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库用户名称。 数据库用户名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，不能和系统用户名称相同。 系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”, “root”。 password 是 String 数据库用户密码。 取值范围：非空，密码长度在8到32个字符之间，至少包含大写字母、小写字母、数字、特殊字符~!@#%^*-_=+?,三种字符的组合，不能和数据库账号“name”或“name”的逆序相同。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 is_login_only 否 boolean 数据库账户是否只支持登录。 取值范围： false或者不填：创建的数据库账号包含登录数据库、创建数据库、创建用户权限。 true：创建的数据库用户只包含登录数据库权限。