华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 backup_policy BackupPolicy object 备份策略信息。 表4 BackupPolicy 参数 参数类型 描述 keep_days Integer 指定已生成的备份文件可以保存的天数。取值范围：1～732。 最小值：1 最大值：732 start_time String 备份时间段。自动备份将在该时间段内触发。 取值范围：格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 period String 备份周期配置。自动备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字代表星期。 retention_num_backup_level1 Integer 一级备份保留数量。当一级备份开关开启时，返回此参数。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 专属资源池ID。 name String 专属资源池名称。 engine_name String 引擎名称。 availability_zone_ids Array of strings 可用区。 architecture String 资源规格类型。 status String 专属资源池状态。 dedicated_compute_info DedicatedComputeInfo object 计算资源信息。 dedicated_storage_info DedicatedStorageInfo object 存储资源信息。 表4 DedicatedComputeInfo 参数 参数类型 描述 vcpus_total Integer 专属资源池中cpu总数。 vcpus_used Integer 专属资源池已使用的cpu数。 ram_total Integer 专属资源池计算内存大小, 单位GB。 ram_used Integer 专属资源池已使用的计算内存大小，单位GB。 spec_code String 专属资源池计算资源规格码。 host_num Integer 专属资源池计算主机数量。 表5 DedicatedStorageInfo 参数 参数类型 描述 spec_code String 专属资源池存储资源规格码。 host_num Integer 专属资源池存储主机数量。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "id" : "e097c33-d6b9-4ca5-83cb-6cc79dcf4f06", "name" : "test_dcc", "engine_name" : "taurus", "availability_zone_ids" : [ "az1xahz", "az2xahz" ], "architecture" : "ARM", "status" : "normal", "dedicated_compute_info" : { "vcpus_total" : 128, "vcpus_used" : 64, "ram_total" : 512, "ram_used" : 256, "spec_code" : "gaussdb.mysql.c6.host", "host_num" : 1 }, "dedicated_storage_info" : { "spec_code" : "gaussdb.mysql.dfvpool.30tb.host", "host_num" : 1 }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 datastores Array of MysqlEngineVersionInfo objects 数据库版本信息列表 表4 MysqlEngineVersionInfo 参数 参数类型 描述 id String 数据库版本ID，该字段不会有重复 name String 数据库版本号，只返回两位数的大版本号 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "configurations" : { "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", "name" : "myparameter", "description" : "parameter1", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "created" : "2022-05-15T11:53:34+0000", "updated" : "2022-05-15T11:53:34+0000" }, "parameter_values" : { "binlog_rows_query_log_events" : "OFF", "mount_vip_when_failover" : "ON", "log-bin" : "ON", "gtid_mode" : "ON", "enforce_gtid_consistency" : "ON", "innodb_online_alter_log_max_size" : "134217728", "binlog_gtid_simple_recovery" : "ON", "max_user_connections" : "10" }}

URI GET /v3/{project_id}/flavors/{database_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 database_name 是 String 数据库引擎名称。 表2 Query参数 参数 是否必选 参数类型 描述 version_name 否 String 数据库版本号，目前仅支持兼容MySQL 8.0。 availability_zone_mode 是 String 规格的可用区模式，现在仅支持"single"、"multi"，不区分大小写。 spec_code 否 String 规格编码。

响应示例 状态码： 200 Success. { "flavors" : [ { "vcpus" : "4", "ram" : "16", "type" : "x86", "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "spec_code" : "gaussdb.mysql.xlarge.x86.4", "instance_mode" : "Cluster", "version_name" : "8.0", "az_status" : { "az1" : "normal", "az2" : "normal" } } ]}

请求示例 查询 GaussDB (for MySQL)数据库实例指定规格的详细信息。 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.x86.4&availability_zone_mode=single

响应示例 状态码： 200 Success. { "backups" : [ { "id" : "1fe4feaab48f11e6654hfa163eba87e4b66u", "name" : "GaussDBforMySQL-gauss-e747-20200705185048266", "begin_time" : "2018-08-06T12:41:14+0800", "end_time" : "2018-08-06T12:45:14+0800", "take_up_time" : 2, "status" : "COMPLETED", "type" : "auto", "size" : 2803, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01", "backup_level" : "2" } ], "total_count" : 1}

请求示例 查询时间段内（2020-07-06~2020-07-16）的自动备份列表。 GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800

URI GET /v3/{project_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 实例ID。 backup_id 否 String 备份ID。 backup_type 否 String 备份类型，取值： "auto"：自动全量备份。 "manual"：手动全量备份。 offset 否 String 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 String 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 begin_time 否 String 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time 否 String 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backups Array of backups objects 备份信息。 total_count Long 备份文件的总数。 表5 backups 参数 参数类型 描述 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。 status String 备份状态，取值： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 AVAILABLE：备份可用。 枚举值： BUILDING COMPLETED FAILED AVAILABLE take_up_time Integer 备份花费时间(单位：minutes) type String 备份类型，取值： auto：自动全量备份。 manual：手动全量备份。 枚举值： auto manual size Long 备份大小，(单位：MB) datastore MysqlDatastore object 数据库信息。 instance_id String 实例ID。 backup_level String 备份级别。当开启一级备份开关时，返回该参数。 取值： 0：备份正在创建中或者备份失败。 1：一级备份。 2：二级备份。 枚举值： 0 1 2 description String 备份文件描述信息 表6 MysqlDatastore 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql version String 数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 quotas project-quotas object 租户实例配额信息。 表5 project-quotas 参数 参数类型 描述 resources Array of resource objects 资源列表对象。 表6 resource 参数 参数类型 描述 type String 指定类型的配额。 instance: 表示实例的配额 枚举值： instance used Integer 已创建的资源个数。 quota Integer 资源最大的配额数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/project-quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 功能说明：根据type过滤查询指定类型的配额。 取值范围：instance 枚举值： instance

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 proxy_flavor_groups Array of MysqlProxyFlavorGroups objects 规格组信息。 表4 MysqlProxyFlavorGroups 参数 参数类型 描述 group_type String 规格组类型，如x86、arm。 proxy_flavors Array of MysqlProxyComputeFlavor objects 规格信息。 表5 MysqlProxyComputeFlavor 参数 参数类型 描述 vcpus String CPU大小。例如：1表示1U。 ram String 内存大小，单位为GB。 db_type String 数据库类型。 id String Proxy规格ID。 spec_code String Proxy规格码。 az_status Object 其中key是可用区编号，value是规格所在az的状态。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "proxy_flavor_groups" : { "group_type" : "X86", "proxy_flavors" : { "id" : "19be4c5d-d363-3342-bdbc-0dd9dbf7fafe", "spec_code" : "gaussdb.proxy.large.x86.2", "vcpus" : 2, "ram" : 4, "db_type" : "Proxy", "az_status" : { "az1" : "normal" } } }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 monitor_switch Boolean 实例秒级监控开关。 true，表示开启。 false，表示关闭。 period Integer 采集周期，仅在monitor_switch为true时返回。 1：采集周期为1s。 5：采集周期为5s。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "quota_list" : [ { "enterprise_project_id" : "0", "enterprise_project_name" : "default", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40, "availability_instance_quota" : 1, "availability_vcpus_quota" : 4, "availability_ram_quota" : 8 } ]}

URI GET /v3/{project_id}/quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 取值范围：0 - 10000 limit 否 String 查询记录数。默认为10，不能为负数，最小值为1，最大值为100。 enterprise_project_name 否 String 企业项目名称。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 quota_list Array of quota objects 资源列表对象。 total_count Integer 配额记录的条数。 表5 quota 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 enterprise_project_name String 企业项目名称。 instance_quota Integer 实例个数配额。 vcpus_quota Integer CPU核数配额。 ram_quota Integer 内存使用配额，单位为GB。 availability_instance_quota Integer 实例剩余配额。 availability_vcpus_quota Integer CPU核数剩余配额。 availability_ram_quota Integer 内存剩余配额。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "proxy_list" : [ { "proxy" : { "pool_id" : "2e7cf21d14794bafab623a334efd9ad8po01", "status" : "ACTIVE", "address" : "192.168.125.69", "port" : 3306, "pool_status" : "ACTIVE", "delay_threshold_in_seconds" : 30, "elb_vip" : "192.168.125.60", "eip" : "192.168.125.50", "vcpus" : 4, "ram" : 8, "node_num" : 2, "mode" : "Cluster", "nodes" : [ { "id" : "db53a238a02240c49365e72e284a4890pn01", "name" : "PROXY-2e7cf21d14794bafab623a334efd9ad8po01_0", "role" : "master", "az_code" : "az1xahz", "status" : "ACTIVE", "frozen_flag" : 0 } ], "name" : "proxy-name", "connection_pool_type" : "SESSION", "switch_connection_pool_type_enabled" : true }, "master_node" : { "id" : "c01a5645eb2c4fb6a9373542f5366e50no07", "instance_id" : "7a871d6d494e4327ad2e326afb591108in07", "status" : "ACTIVE", "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01", "weight" : 0, "availability_zone" : [ { "code" : "az1", "description" : "可用区1" } ] }, "readonly_nodes" : { "id" : "d23535333138462880bfa1838fdfced2no07", "instance_id" : "7a871d6d494e4327ad2e326afb591108in07", "status" : "ACTIVE", "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node02", "weight" : 100, "availability_zone" : [ { "code" : "az1", "description" : "可用区1" } ] } } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 proxy_list Array of MysqlShowProxyResponseV3 objects Proxy实例信息列表。 表5 MysqlShowProxyResponseV3 参数 参数类型 描述 proxy MysqlProxyV3 object Proxy实例信息。 master_node MysqlProxyNodeV3 object 主节点信息。 readonly_nodes Array of MysqlProxyNodeV3 objects 只读节点信息。 表6 MysqlProxyV3 参数 参数类型 描述 pool_id String Proxy实例ID。 status String Proxy实例开启状态。 取值: “ACTIVE”，表示数据库代理正常； “FAILED”，表示数据库代理创建失败； “DELETED”，表示数据库代理已删除； “ABNORMAL”，表示数据库代理异常； “ENABLING PROXY”，表示数据库代理正在开启； “DISABLING PROXY”，表示数据库代理正在关闭； “ADDING PROXY NODE”，表示数据库代理正在扩容； “DELETING READ REPLICAS FROM PROXY”，表示数据库代理正在移除只读节点； “ADDING READ REPLICAS TO PROXY”，表示数据库代理正在添加只读节点； “CHANGING WEIGHTS”，表示数据库代理正在修改只读节点权重。 address String Proxy读写分离地址。 port Integer Proxy端口信息。 pool_status String Proxy实例状态。 取值范围： ACTIVE，表示数据库代理正常 ABNORMAL，表示数据库代理异常 FAILED，表示数据库代理创建失败 DELETED，表示数据库代理已删除 delay_threshold_in_seconds Integer 延时阈值，单位：秒。 elb_vip String Elb模式的虚拟ip信息。 eip String 弹性公网IP信息。 vcpus String Proxy实例规格的CPU数量。 ram String Proxy实例规格的内存数量。 node_num Integer Proxy节点个数。 mode String Proxy主备模式，取值范围：Cluster。 nodes Array of MysqlProxyNodes objects Proxy节点信息。 flavor_ref String Proxy规格信息。 name String Proxy实例名称。 transaction_split String Proxy事务拆分开关状态【ON/OFF】。 connection_pool_type String 连接池类型。 取值范围: CLOSED: 关闭连接池。 SESSION: 开启会话级连接池。 switch_connection_pool_type_enabled Boolean 数据库代理版本是否支持会话级连接池。 取值范围: true: 支持。 false: 不支持。 表7 MysqlProxyNodes 参数 参数类型 描述 id String Proxy节点ID。 status String Proxy节点状态。 取值范围： ACTIVE，表示节点正常 ABNORMAL，表示节点异常 FAILED，表示节点失败 DELETED，表示节点已删除 name String Proxy节点名称。 role String Proxy节点角色：master和slave。 az_code String 可用区。 frozen_flag Integer Proxy节点是否被冻结。 取值范围： 0-未冻结 1-冻结 2-冻结删除 表8 MysqlProxyNodeV3 参数 参数类型 描述 id String 节点ID。 instance_id String 实例ID。 status String 节点状态。 name String 节点名称。 weight Integer 节点读写分离读权重。 availability_zone Array of MysqlProxyAvailable objects 可用区信息。 表9 MysqlProxyAvailable 参数 参数类型 描述 code String 可用区编码。 description String 可用区描述。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/instances/{instance_id}/proxies 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为10，不能为负数，最小值为1，最大值为100。

响应示例 状态码： 200 Success. { "instance" : { "id" : "d738399de028480fabb2b8120d4e01a4in07", "name" : "gaussdb-mysql-instance01", "alias" : "", "status" : "ACTIVE", "project_id" : "3cedfc54-b105-4652-a4e0-847b11576628", "enterprise_project_id" : 0, "type" : "Cluster", "charge_info" : { "charge_mode" : "postPaid", "order_id" : "" }, "node_count" : 2, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0", "kernel_version" : "2.0.29.1" }, "created" : "2022-07-14T16:26:58+0800", "updated" : "2022-07-18T14:20:33+0800", "public_ips" : "10.154.219.187", "private_write_ips" : [ "192.168.0.142" ], "db_user_name" : "root", "port" : 3306, "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "nodes" : [ { "id" : "799a0f2fa49a4151bf9f7063c1fbba36no07", "name" : "gauss-d616-lb07_node01", "type" : "master", "status" : "ACTIVE", "port" : 3306, "private_read_ips" : [ "192.168.0.163" ], "volume" : { "type" : "POOL", "used" : 0.07 }, "az_code" : "az1xahz", "region_code" : "cn-xianhz-1", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_ref" : "gaussdb.mysql.xlarge.arm.2.ha", "max_connections" : 1500, "vcpus" : 1, "ram" : 4, "need_restart" : false, "priority" : 1, "created" : "2022-07-14T16:26:58+0800", "updated" : "2022-07-18T09:24:18+0800" }, { "id" : "799a0f2fa49a4151bf9f7063c1fbba35no07", "name" : "gauss-d616-lb07_node02", "type" : "slave", "status" : "ACTIVE", "port" : 3306, "private_read_ips" : [ "192.168.0.162" ], "volume" : { "type" : "POOL", "used" : 0.07 }, "az_code" : "az1xahz", "region_code" : "cn-xianhz-1", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_ref" : "gaussdb.mysql.xlarge.arm.2.ha", "max_connections" : 1500, "vcpus" : 1, "ram" : 4, "need_restart" : false, "priority" : 1, "created" : "2022-07-14T16:26:58+0800", "updated" : "2022-07-18T09:36:18+0800" } ], "time_zone" : "UTC+08:00", "backup_used_space" : 0.24, "az_mode" : "single", "master_az_code" : "az1", "maintenance_window" : "18:00-22:00", "tags" : [ ], "configuration_id" : "53570e0de54e40c5a15f331aa5sd2176pr07", "dedicated_resource_id" : "", "proxies" : [ { "pool_id" : "dab1cfc5150c4d1ca0e8c6596bfc0d8cpo01", "address" : "192.168.10.76", "name" : "proxy-name" } ] }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instance MysqlInstanceInfoDetail object 实例信息。 表4 MysqlInstanceInfoDetail 参数 参数类型 描述 id String 实例ID。 name String 创建的实例名称。 project_id String 租户在某一region下的project ID。 status String 实例状态。 取值： 值为“BUILD”，表示实例正在创建。 值为“ACTIVE”，表示实例正常。 值为“FAILED”，表示实例创建失败。 值为“FROZEN”，表示实例冻结。 值为“MODIFYING”，表示实例正在扩容。 值为“REBOOTING”，表示实例正在重启。 值为“RESTORING”，表示实例正在恢复。 值为“SWITCHOVER”，表示实例正在主备切换。 值为“MIGRATING”，表示实例正在迁移。 值为“BACKING UP”，表示实例正在进行备份。 值为“MODIFYING DATABASE PORT”，表示实例正在修改数据库端口。 值为“STORAGE FULL”，表示实例磁盘空间满。 port String 数据库端口号。 alias String 实例备注 type String 实例类型，取值为“Cluster”。 charge_info MysqlInstanceChargeInfo object 计费类型信息，支持包年包月和按需，默认为按需。 node_count Integer 节点个数。 datastore MysqlDatastoreWithKernelVersion object 数据库信息。 backup_used_space Double 备份空间使用大小，单位为GB。 created String 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 说明：创建时返回值为空，数据库实例创建成功后该值不为空。 updated String 更新时间，格式与"created"字段对应格式完全相同。说明：创建时返回值为空，数据库实例创建成功后该值不为空。 private_write_ips Array of strings 实例的写内网IP。 public_ips String 实例的公网IP。 db_user_name String 默认用户名。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 安全组ID。 configuration_id String 实例创建的模板ID，或者应用到实例的最新参数组模板ID。 backup_strategy MysqlBackupStrategy object 自动备份策略 nodes Array of MysqlInstanceNodeInfo objects 节点信息。 enterprise_project_id String 企业项目ID。 time_zone String 时区。 az_mode String 可用区模式，单可用区single或多可用区multi。 master_az_code String 主可用区。 maintenance_window String 可维护时间窗，为UTC时间。 tags Array of MysqlTags objects 实例标签。 dedicated_resource_id String 专属资源池ID，只有数据库实例属于专属资源池才会返回该参数。 proxies Array of MysqlProxyInfo objects Proxy信息。 表5 MysqlInstanceChargeInfo 参数 参数类型 描述 charge_mode String 计费模式。 order_id String 订单号。 表6 MysqlDatastoreWithKernelVersion 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql version String 数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 kernel_version String 数据库内核版本 表7 MysqlBackupStrategy 参数 参数类型 描述 start_time String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 keep_days String 自动备份保留天数，取值范围：1-732 表8 MysqlInstanceNodeInfo 参数 参数类型 描述 id String 实例ID。 name String 节点名称。 type String 节点类型，master或slave。 status String 节点状态。 port Integer 数据库端口号。 private_read_ips Array of strings 节点的读内网地址。 volume MysqlInstanceNodeVolumeInfo object 存储盘信息。 az_code String 可用区。 region_code String 实例所在的区域。 created String 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。说明：创建时返回值为空，数据库实例创建成功后该值不为空。 updated String 更新时间，格式与"created"字段对应格式完全相同。说明：创建时返回值为空，数据库实例创建成功后该值不为空。 flavor_id String 规格ID。 flavor_ref String 规格码。 max_connections String 允许的最大连接数。 vcpus String CPU核数。 ram String 内存大小，单位为GB。 need_restart Boolean 是否需要重启使修改的参数生效。 priority Integer 主备倒换优先级。 表9 MysqlInstanceNodeVolumeInfo 参数 参数类型 描述 type String 磁盘类型。 used String 已使用磁盘大小，单位GB。 size Long 包周期购买的存储空间大小，单位GB。 表10 MysqlTags 参数 参数类型 描述 key String 标签键。最大长度36个unicode字符。key不能为空或者空字符串，不能为空格。 字符集：A-Z，a-z ，0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value String 标签值。最大长度43个unicode字符。可以为空字符串。 字符集：A-Z，a-z ，0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 表11 MysqlProxyInfo 参数 参数类型 描述 pool_id String Proxy实例ID。 name String Proxy实例名称。 address String Proxy读写分离地址。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 backup_policy BackupPolicy object 备份策略信息。 表4 BackupPolicy 参数 参数类型 描述 keep_days Integer 指定已生成的备份文件可以保存的天数。取值范围：1～732。 最小值：1 最大值：732 start_time String 备份时间段。自动备份将在该时间段内触发。 取值范围：格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 period String 备份周期配置。自动备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字代表星期。 retention_num_backup_level1 Integer 1级备份保留数量。当一级备份开关开启时，返回此参数。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backups Array of backups objects 备份信息。 total_count Number 备份文件的总数。 表5 backups 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 begin_time String 备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 备份结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 status Object 备份状态 枚举值： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 AVAILABLE：备份可用。 take_up_time Integer 备份花费时间(单位：minutes) type Object 备份类型 枚举值： auto：自动全量备份。 manual：手动全量备份。 size Number 备份大小，(单位：MB) datastore MysqlDatastore object 数据库信息。 instance_id String 实例ID。 backup_level Object 备份级别。当开启一级备份开关时，返回该参数。 枚举值： 0：备份正在创建中或者备份失败。 1：一级备份。 2：二级备份。 description String 备份文件描述信息 表6 MysqlDatastore 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql version String 数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "backups" : [ { "id" : "1fe4feaab48f11e6654hfa163eba87e4b66u", "name" : "GaussDBforMySQL-gauss-e747-20200705185048266", "begin_time" : "2018-08-06T12:41:14+0800", "end_time" : "2018-08-06T12:45:14+0800", "take_up_time" : 2, "status" : "COMPLETED", "type" : "auto", "size" : 2803, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01", "backup_level" : "2" } ], "total_count" : 1}

URI GET /mysql/v3/{project_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 实例ID。 backup_id 否 String 备份ID。 backup_type 否 String 备份类型，取值： "auto"：自动全量备份 "manual"：手动全量备份 offset 否 String 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 String 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 begin_time 否 String 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time 否 String 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。