4.3 备份管理
5.1.6 DN 分片扩容
– 包租期用户响应消息样例：
{ "payInfo": {
"payModel": null,
"orderId": "CS2105061116HNTVI", "period": null,
"periodType": 5, "isAutoRenew": 0, "isAutoPay": 1 },
"job_id": null }
● 异常响应
请参见异常请求结果。
状态码
请参见状态码。
错误码
请参见错误码。
5.1.6 DN 分片扩容
功能介绍
数据库DN分片扩容。
● 调用接口前，您需要了解API 认证鉴权。
● 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。
说明
DN分片扩容期间会有闪断，请谨慎操作。
接口约束
● DN分片扩容单次步长限制1~9。
● DN分片扩容后最大到256。
URI
● URI格式
POST https://{Endpoint}/opengauss/v3/{project_id}/instances/{instance_id}/
action
● URI样例
https://gaussdb.cn-north-1.myhuaweicloud.com/opengauss/
v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/
action
– 参数说明
表5-37 参数说明
名称 是否必选 参数类型 说明
expand_cl
uster 是 Object 请参见表5-38
表5-38 expand_cluster 字段数据结构说明
名称 是否必选 参数类型 说明
shard 是 Object 请参见表5-39
isAutoPay 否 int 包周期用户需要填写该字段。
● 0：表示不自动支付扩容订 单费用
● 1：表示自动支付扩容订单 费用
不填写则保持默认。默认值：0
表5-39 count 字段数据结构说明
名称 是否必选 参数类型 说明
count 是 Integer 新增的DN分片扩容数大小
● 请求样例
{ "expand_cluster": { "shard":{
"count":"1"
},
"isAutoPay":0 }
}
响应消息
● 正常响应要素说明
表5-40 要素说明
名称 参数类型 说明
job_id String 任务ID
● 正常响应样例
– 非包租期用户响应消息样例：
{ "job_id": "2b414788a6004883a02390e2eb0ea227"
}
– 包租期用户响应消息样例：
{ "payInfo": {
"payModel": null,
"orderId": "CS2105061116HNTVI", "period": null,
"periodType": 5, "isAutoRenew": 0, "isAutoPay": 1 },
"job_id": null }
● 异常响应
请参见异常请求结果。
状态码
请参见状态码。
错误码
请参见错误码。
5.1.7 重置数据库密码
功能介绍
重置数据库密码。
● 调用接口前，您需要了解API 认证鉴权。
● 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。
URI
● URI格式
POST https://{Endpoint}/opengauss/v3/{project_id}/instances/{instance_id}/
password
● URI样例
https://gaussdb.cn-north-1.myhuaweicloud.com/opengauss/
v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/
password
– 参数说明
表5-41 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID，严格匹配UUID规则。
请求消息
● 参数说明
表5-42 参数说明
名称 是否必选 参数类型 说明
password 是 String 数据库root用户密码。
● 8~32个字符。
● 至少包含以下字符中的 三种：
大写字母、小写字母、
数字和特殊字符~!@#
%^*-_=+?,
● 弱密码校验。
● 请求样例
{ "password": "Test_345612"
}
响应消息
● 正常响应要素说明 无。
● 正常响应样例 {}
● 异常响应
请参见异常请求结果。
状态码
请参见状态码。
错误码
请参见错误码。
5.1.8 修改实例名称
功能介绍
修改实例名称。
● 调用接口前，您需要了解API 认证鉴权。
● 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。
URI
● URI格式
PUT https://{Endpoint}/opengauss/v3/{project_id}/instances/{instance_id}/
name
● URI样例
https://gaussdb.cn-north-1.myhuaweicloud.com/opengauss/
v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/
name
– 参数说明
表5-43 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID，严格匹配UUID规则。
请求消息
● 参数说明
表5-44 参数说明
名称 是否必选 参数类型 说明
name 是 String 实例名称。用于表示实例的
名称，同一租户下，同类型 的实例名可重名。
取值范围：4~64个字符之 间，必须以字母开头，区分 大小写，可以包含字母、数 字、中划线或者下划线，不 能包含其他的特殊字符。
● 请求样例
{ "name": "instance-name"
}
响应消息
● 正常响应要素说明
表5-45 要素说明
名称 参数类型 说明
job_id String 修改实例名称的任务
ID。
● 正常响应样例
{ "job_id": "2b414788a6004883a02390e2eb0ea227"
}
● 异常响应
请参见异常请求结果。
状态码
请参见状态码。
错误码
请参见错误码。
5.2 参数配置
5.2.1 修改指定实例的参数
功能介绍
修改指定实例的参数模板参数。
● 调用接口前，您需要了解API 认证鉴权。
● 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。
接口约束
● 修改的参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见
《GaussDB(for openGauss)用户指南》中“编辑参数模板”的内容。
URI
● URI格式
PUT https://{Endpoint}/opengauss/v3/{project_id}/instances/{instance_id}/
configurations
● URI样例
https://gaussdb.cn-north-1.myhuaweicloud.com/opengauss/
v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/
configurations
● 参数说明
表5-46 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID。
请求消息
● 参数说明
表5-47 参数说明
名称 是否必选 参数类型 说明
values 是 Map<String,St
ring> 参数值对象，用户基于默认 参数模板自定义的参数值。
详情请参见表5-48。
表5-48 values 字段数据结构说明
名称 是否必选 参数类型 说明
key 是 String 参数名称，以参数名称作为
key，例如：对于
"failed_login_attempts":"4
"，key就是
"failed_login_attempts"。
value 是 String 参数值，以参数对应的值作
为value，例如：对于
"failed_login_attempts":"4
",value就是"4"。
● 请求样例 { "values": { "xxx": "10", "yyy": "OFF"
} }
响应消息
● 正常响应要素说明
表5-49 要素说明
名称 参数类型 说明
restart_required Boolean 实例是否需要重启。
● “true”需要重启。
● “false”不需要重 启。
● 正常响应样例
{ "restart_required": false }
● 异常响应
请参见异常请求结果。
状态码
请参见状态码。
错误码
请参见错误码。
5.3 备份管理
5.3.1 设置自动备份策略
功能介绍
设置自动备份策略。
● 调用接口前，您需要了解API 认证鉴权。
● 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。
URI
● URI格式
PUT https://{Endpoint}/opengauss/v3/{project_id}/instances/{instance_id}/
backups/policy
● URI样例
https://gaussdb.cn-north-1.myhuaweicloud.com/opengauss/
v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/
backups/policy
– 参数说明
表5-50 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID，严格匹配UUID规则。
请求消息
● 参数说明
表5-51 参数说明
名称 是否必选 参数类型 说明
backup_policy 是 Object 备份策略信息。
详情参见表5-52。
表5-52 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_perio
d 是 String 差异备份间隔时间配置。每
次自动差异备份的间隔时 间。
取值范围：15、30、60、
180、360、720、1440。
单位：分钟。
取值示例：30
● 请求样例
{ "backup_policy": { "keep_days": 7,
"start_time": "19:00-20:00", "period": "1,2,3,4,5", "differential_period": "30"
} }
响应消息
● 正常响应要素说明 无
● 正常响应样例 空
● 异常响应
请参见异常请求结果。
状态码
请参见状态码。
错误码
请参见错误码。