云数据库 RDS-恢复到新实例:响应消息

时间:2025-02-13 17:17:57

响应消息

  • 正常响应要素说明
    表12 要素说明

    名称

    参数类型

    说明

    instance

    Object

    实例信息。

    详情请参见表13

    job_id

    String

    实例创建的任务id。仅按需实例时返回该参数。

    order_id

    String

    订单号,仅RDS for SQL Server创建包年包月时返回该参数。

    表13 instance说明

    名称

    参数类型

    说明

    id

    String

    实例ID。

    name

    String

    实例名称。

    用于表示实例的名称,同一租户下,同类型的实例名可重名,其中,RDS for SQL Server实例名唯一。

    status

    String

    实例状态。如BUILD,表示创建中。

    datastore

    Object

    数据库信息。

    详情请参见表14

    ha

    Object

    HA配置参数,仅当您选择创建HA实例时该参数才可见。

    详情请参见表15

    configuration_id

    String

    参数模板id,仅当您创建实例指定用户自定义参数组时才可见。

    port

    String

    数据库端口信息。

    • RDS for MySQL数据库端口设置范围为1024~65535(其中12017和33071被RDS系统占用不可设置)。
    • RDS for PostgreSQL数据库端口修改范围为2100~9500。
    • 对于RDS for SQL Server 2022 EE、2022 SE、2022 Web版、2019 EE、2019 SE、2019 Web版、2017 EE、2017 SE、2017 Web版:端口设置范围为1433和2100~9500(其中5050、5353、5355、5985和5986不可设置)。

      除此之外的其他版本:端口设置范围为1433和2100~9500(其中5355、5985和5986不可设置)。

    当不传该参数时,默认端口如下:

    • RDS for MySQL默认3306。
    • RDS for PostgreSQL默认5432。
    • RDS for SQL Server默认1433。

    backup_strategy

    Object

    自动备份策略。

    详情请参见表16

    enterprise_project_tag

    String

    项目标签。

    flavor_ref

    String

    规格ID。

    使用可参考查询数据库规格响应消息表3中的“spec_code”

    volume

    Object

    volume信息。

    详情请参见表17

    region

    String

    区域ID。

    availability_zone

    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接口查询,具体操作可参考查询安全组列表

    collation

    String

    RDS for SQL Server设定的字符集信息。

    charge_info

    Object

    计费方式信息,支持包年/包月和按需。

    详情请参见表10

    表14 datastore字段数据结构说明

    名称

    是否必选

    参数类型

    说明

    type

    String

    数据库引擎。支持的引擎如下,不区分大小写:

    • MySQL
    • PostgreSQL
    • SQLServer

    version

    String

    数据库版本。

    数据库支持的详细版本信息,可调用查询数据库引擎的版本接口获取。

    complete_version

    String

    数据库完整版本号。仅在数据库引擎是”PostgreSQL”时返回。

    表15 ha字段数据结构说明

    名称

    是否必选

    参数类型

    说明

    mode

    String

    实例主备模式,取值:Ha。

    replication_mode

    String

    备机同步参数。

    取值:非空。

    • MySQL为“async”或“semisync”。
    • PostgreSQL为“async”或“sync”。
    • Microsoft SQL Server为“sync”。
    说明:
    • “async”为异步模式。
    • “semisync”为半同步模式。
    • “sync”为同步模式。
    表16 backupStrategy字段数据结构说明

    名称

    是否必选

    参数类型

    说明

    start_time

    String

    备份时间段。自动备份将在该时间段内触发。

    取值范围:非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。

    • HH取值必须比hh大1。
    • mm和MM取值必须相同,且取值必须为00、15、30或45。

    取值示例:

    • 08:15-09:15
    • 23:00-00:00

    keep_days

    Integer

    指定已生成备份文件的可保存天数。

    取值范围:0~732。该参数缺省,或取0值,表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请,自动备份最长可以保留2562天。

    表17 volume字段数据结构说明

    名称

    是否必选

    参数类型

    说明

    type

    String

    磁盘类型。

    取值范围如下,区分大小写:

    • ULTRAHIGH,表示超高IO型磁盘。
    • LOCALSSD,表示本地SSD盘。
    • CLOUDSSD,表示SSD云盘。
    • ESSD,表示极速型SSD。

    size

    Integer

    磁盘大小。

    取值范围:40GB~4000GB。必须为10的整数倍。

  • 正常响应样例

    MySQL

    {
    	"instance": {
    		"id": "f5ffdd8b1c98434385eb001904209eacin01",
    		"name": "demoname",
    		"status": "BUILD",
    		"datastore": {
    			"type": "MySQL",
    			"version": "5.7.31"
    		},
    		"port": "3306",
    		"volume": {
    			"type": "ULTRAHIGH",
    			"size": "40"
    		},
    		"region": "aaa",
    		"backup_strategy": {
    			"start_time": "02:00-03:00",
    			"keep_days": "7"
    		},
    		"flavor_ref": "rds.mysql.s1.large",
    		"availability_zone": "bbb",
    		"vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f",
    		"subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7",
    		"security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0"
    	},
    	"job_id": "bf003379-afea-4aa5-aa83-4543542070bc"
    }

    PostgreSQL

    {
    	"instance": {
    		"id": "f5ffdd8b1c98434385eb001904209eacin01",
    		"name": "demoname",
    		"status": "BUILD",
    		"datastore": {
    			"type": "PostgreSQL",
    			"version": "9.6.13"
    		},
    		"port": "5432",
    		"volume": {
    			"type": "ULTRAHIGH",
    			"size": "40"
    		},
    		"region": "aaa",
    		"backup_strategy": {
    			"start_time": "02:00-03:00",
    			"keep_days": "7"
    		},
    		"flavor_ref": "rds.pg.s1.large",
    		"availability_zone": "bbb",
    		"vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f",
    		"subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7",
    		"security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0"
    	},
    	"job_id": "bf003379-afea-4aa5-aa83-4543542070bc"
    }

    SQL Server

    {
    	"instance": {
    		"id": "f5ffdd8b1c98434385eb001904209eacin01",
    		"name": "demoname",
    		"status": "BUILD",
    		"datastore": {
    			"type": "sqlserver",
    			"version": "2014_SE"
    		},
    		"port": "2100",
    		"volume": {
    			"type": "ULTRAHIGH",
    			"size": "40"
    		},
    		"region": "aaa",
    		"backup_strategy": {
    			"start_time": "02:00-03:00",
    			"keep_days": "7"
    		},
    		"flavor_ref": "rds.mssql.2014.se.s3.large.2",
    		"availability_zone": "bbb",
    		"vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f",
    		"subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7",
    		"security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0",
                    "charge_info": {           
                           "charge_mode": "prePaid",            
                           "period_num": 1        
                     },        
                    "collation": "Cyrillic_General_CI_AS"
    	},
    	"order_id": " CS 20122919584LQ7K"
    }

    Serverless型MySQL

    {
        "instance": {
            "id": "dbb35f31f4144086bf522ff8a124530din01",
            "name": "serverless",
            "status": "BUILD",
            "datastore": {
                "type": "MySQL",
                "version": "5.7.41"
            },
            "ha": {
                "mode": "Ha",
                "replication_mode": "semisync"
            },
            "port": "3307",
            "volume": {
                "type": "CLOUDSSD",
                "size": 100
            },
            "region": "aaa",
            "backup_strategy": {
                "start_time": "08:15-09:15",
                "keep_days": 12
            },
            "flavor_ref": "rds.mysql.serverless.ha",
            "availability_zone": "bbb,ccc",
            "vpc_id": "bd3e4c67-74da-459d-820f-9fecd4ea9ca4",
            "subnet_id": "53cdf568-6f56-4944-a996-4afcaffe994e",
            "security_group_id": "89f258c5-4b81-4ef0-be30-34f2ee07dd1c"
        },
        "job_id": "908c05f7-958a-4411-b590-890eed175345"
    }
  • 异常响应

    请参见异常请求结果

support.huaweicloud.com/api-rds/rds_09_0008.html