云服务器内容精选

  • 响应 要素说明 参数 参数类型 描述 replication replication_resp 复制返回参数 replication_resp字段数据结构说明 参数 参数类型 描述 project_id String 执行复制的项目ID provider_id String 备份提供商ID,当前取值固定值:fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。 checkpoint_item_id String 待复制的备份ID source_region String 复制的源区域 destination_region String 复制的目标区域 destination_project_id String 复制的目标项目ID replication_record_id String 复制记录ID 响应样例 { "replication" :{ "project_id": "4800fde9-66f8-4458-b805-4c01066b9568", "provider_id": "fc4d5750-22e7-4798-8a46-f48f62c4c1da", "checkpoint_item_id": "c4dfa74c-7e60-4361-86b9-9a3250115ed6", "source_region": "cn-north-1", "destination_region": "cn-east-2", "destination_project_id": "e0b97bac-532c-4c51-96fa-4b3a32253be4", "replication_record_id": "042cd047-a7c9-4905-a859-402950ac8440" } }
  • 请求 要素说明 参数 是否必选 参数类型 描述 replication 是 replication_param 复制参数 replication_param 字段数据结构说明 参数 是否必选 参数类型 描述 name 否 String 复制的名称 description 否 String 复制的描述 destination_region 是 String 复制的目标区域,可通过查询复制能力接口获取 destination_project_id 是 String 复制的目标项目ID enable_acceleration 否 Boolean 跨区域复制时,是否启用加速从而缩短复制的时间,如果不指定,默认不启用加速。 请求样例 POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoint_items/{checkpoint_item_id}/replicate{ "replication" : { "destination_region": "cn-east-2", "destination_project_id": "e0b97bac-532c-4c51-96fa-4b3a32253be4", "name": "rep_from_bd3c8a42-7dd4-4400-b091-2777c51a5c9a", "description": "do replication" }}
  • URI URI POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoint_items/{checkpoint_item_id}/replicate 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 provider_id 是 String 备份提供商ID,当前取值固定值:fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。 checkpoint_item_id 是 String 待复制的备份ID
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 backup_count Integer 备份总个数。请求失败时,字段为空。 backup_list Array of backup_list objects 当前Project ID下的所有图的备份列表。请求失败时,字段为空。 表5 backup_list 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 backup_method String 备份方法,取值为auto,manual或者import。 graph_id String 备份关联的图ID。 graph_name String 备份关联的图Name。 graph_status String 备份关联的图状态。 graph_size_type_index String 备份关联的图规格。 data_store_version String 备份关联的图版本。 arch String 备份关联的图CPU架构。 status String 备份状态。 backing_up:备份中 success:备份成功 failed:备份失败 start_timestamp Long 备份开始时间戳。 start_time String 备份开始时间。 end_timestamp Long 备份结束时间戳。 end_time String 备份结束时间。 size Long 备份文件大小,单位为MB。 duration Long 备份时间,单位为秒。 encrypted Boolean 是否加密。true表示加密,默认值为"false",不加密。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 error_msg String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。
  • 响应示例 状态码: 200 成功响应示例 { "backup_count" : 2, "backup_list" : [ { "id" : "ada3e720-ab87-48cb-bff7-3ec5ae1a9652", "name" : "ges060803_nodelete-20210608135513", "backup_method" : "manual", "graph_id" : "4c5f882d-a813-4d78-a8e3-6d3212ddd121", "graph_name" : "ges060803_nodelete", "graph_status" : "200", "graph_size_type_index" : "1", "data_store_version" : "2.2.21", "arch" : "x86_64", "status" : "success", "start_timestamp" : 1623160513000, "start_time" : "2021-06-08T13:55:13", "end_timestamp" : 1623160568000, "end_time" : "2021-06-08T13:56:08", "size" : 1, "duration" : 54, "encrypted" : false }, { "id" : "7ed3f51d-816d-4651-9129-fe21b64b5c91", "name" : "ges060803_nodelete_20210609203323_auto", "backup_method" : "auto", "graph_id" : "4c5f882d-a813-4d78-a8e3-6d3212ddd121", "graph_name" : "ges060803_nodelete", "graph_status" : "200", "graph_size_type_index" : "1", "data_store_version" : "2.2.21", "arch" : "x86_64", "status" : "success", "start_timestamp" : 1623242004000, "start_time" : "2021-06-09T12:33:24", "end_timestamp" : 1623242004000, "end_time" : "2021-06-09T12:33:24", "size" : 1, "duration" : 0, "encrypted" : false } ] } 状态码: 400 失败响应示例 { "error_code" : "GES.7000", "error_msg" : "The graph does not exist or has been deleted." }
  • URI GET /v2/{project_id}/graphs/{graph_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_id 是 String 图ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页资源数量的最大值,默认为10。 offset 否 Integer 本次请求的起始位置,默认为0。
  • 请求示例 设置 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 } }
  • 请求参数 表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 filesplit_size 否 Integer 全量、差量备份时产生的备份文件会根据该参数的值进行拆分,废弃,无需填写。 enable_standby_backup 否 Boolean 是否启用备机备份。(不支持单节点实例及3.100.0以下的实例)
  • URI PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 instance_id 是 实例ID。
  • URI GET /v3/{project_id}/instances/{instance_id}/incremental-backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID,严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 String 查询记录数。默认为10,可取范围:10、20、50。 begin_time 否 String 查询开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 “begin_time”有值时,“end_time”必选。 end_time 否 String 查询结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 “end_time”有值时,“begin_time”必选。
  • 响应示例 状态码: 200 Success. { "backups" : [ { "id" : "f0d2aea28d26t4848b8c84ed3fea1822fbr07", "name" : "GaussDBforMySQL--20230728181555006", "begin_time" : "2022-07-07T12:41:14+0800", "end_time" : "2022-07-08T12:45:14+0800", "size" : 0.109375, "instance_id" : "61a4ea66210545909d74a05c27a7179ein07" } ], "total_count" : 1 }
  • 请求示例 查询时间段内(2022-07-06~2022-07-16)的增量备份列表。 GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/incremental-backups?offset=0&limit=10&begin_time=2022-07-06T10:41:14+0800&end_time=2022-07-16T10:41:14+0800
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 backups Array of IncrementalBackups objects 备份信息。 total_count Long 备份文件的总数。 表5 IncrementalBackups 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 begin_time String 备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 end_time String 备份结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 size Number 备份大小,(单位:KB)。 instance_id String 实例ID。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求示例 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。