华为云用户手册

URI GET /v3/{project_id}/scheduled-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为1，必须为数字，不能为负数。 limit 否 String 查询记录数。默认为10 status 否 String 任务执行状态。 取值： 值为“Running”，表示任务正在执行。 值为“Completed”，表示任务执行成功。 值为“Failed”，表示任务执行失败。 值为“Pending”，表示任务未执行。 start_time 否 String 起始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 说明：创建时返回值为空，数据库实例创建成功后该值不为空。 end_time 否 String 结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 说明：创建时返回值为空，数据库实例创建成功后该值不为空。 job_id 否 String 任务ID。 job_name 否 String 任务调度类型。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 master_weight 否 Integer 主节点权重 readonly_nodes 否 Array of ModifyProxyWeightReadonlyNode objects 只读节点权重配置信息 表4 ModifyProxyWeightReadonlyNode 参数 是否必选 参数类型 描述 id 否 String 只读节点ID weight 否 Integer 只读节点权重

请求示例 设置实例的主节点权重是100。 PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight{ "master_weight" : 100}

URI PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/weight 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 proxy_id 是 String 数据库代理ID，严格匹配UUID规则。

请求示例 按备份文件恢复到当前实例。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore{ "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07", "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07", "backup_id" : "7ffbf305376b4cbea0ae491257b6aaf9br07", "type" : "backup"} 按时间点恢复到当前实例。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore{ "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07", "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07", "restore_time" : 1673852043000, "type" : "timestamp"} 按备份文件恢复到已有实例。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore{ "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07", "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07", "backup_id" : "be4ddfd7e2b94640b5e2cb44efb30b22br07", "type" : "backup"} 按时间点恢复到已有实例。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore{ "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07", "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07", "restore_time" : 1673852043000, "type" : "timestamp"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 target_instance_id 是 String 目标实例ID。 source_instance_id 是 String 源实例ID。 backup_id 否 String 用于恢复的备份ID。当使用备份文件恢复时需要指定该参数。 restore_time 否 Long 恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。 type 是 String 表示恢复方式，枚举值： backup：表示使用备份文件恢复，按照此方式恢复时，当"type"字段为非必选时，"backup_id"必选。 timestamp：表示按时间点恢复，按照此方式恢复时，当"type"字段必选时，"restore_time"必选。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 工作流ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 quota_list Array of setQuota objects 资源列表对象。 表6 setQuota 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 instance_quota Integer 实例个数配额。取值范围0~1000。(如果已经存在实例，应该大于已经存在的实例个数) vcpus_quota Integer CPU核数配额。取值范围0~3600000。(如果已经存在实例，应该大于已经占用的cpu个数) ram_quota Integer 内存使用配额，单位为GB。取值范围0~19200000。(如果已经存在实例，应该大于已经占用的内存数)

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token X-Language 否 String 语言 表3 请求Body参数 参数 是否必选 参数类型 描述 quota_list 是 Array of setQuota objects 资源列表对象。 表4 setQuota 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 instance_quota 是 Integer 实例个数配额。取值范围0~1000。(如果已经存在实例，应该大于已经存在的实例个数) vcpus_quota 是 Integer CPU核数配额。取值范围0~3600000。(如果已经存在实例，应该大于已经占用的cpu个数) ram_quota 是 Integer 内存使用配额，单位为GB。取值范围0~19200000。(如果已经存在实例，应该大于已经占用的内存数)

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 switch_status String 全量SQL开关状态。 取值： ON，表示开启 OFF，表示关闭 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 quota_list 是 Array of setQuota objects 资源列表对象。 表4 setQuota 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 instance_quota 否 Integer 实例个数配额。取值范围0~100000。(如果已经存在实例，应该大于已经存在的实例个数) vcpus_quota 否 Integer CPU核数配额。取值范围0~2147483646。(如果已经存在实例，应该大于已经占用的cpu个数) ram_quota 否 Integer 内存使用配额，单位为GB。取值范围0~2147483646。(如果已经存在实例，应该大于已经占用的内存数)

请求示例 设置资源配额。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas{ "quota_list" : [ { "enterprise_project_id" : "0", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40 } ]}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 quota_list Array of setQuota objects 资源列表对象。 表6 setQuota 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 instance_quota Integer 实例个数配额。取值范围0~100000。(如果已经存在实例，应该大于已经存在的实例个数) vcpus_quota Integer CPU核数配额。取值范围0~2147483646。(如果已经存在实例，应该大于已经占用的cpu个数) ram_quota Integer 内存使用配额，单位为GB。取值范围0~2147483646。(如果已经存在实例，应该大于已经占用的内存数) 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 设置SQL限流规则，限流类型为SELECT、UPDATE、DELETE。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules{ "sql_filter_rules" : [ { "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07", "rules" : [ { "sql_type" : "SELECT", "patterns" : [ { "pattern" : "select~from~t1", "max_concurrency" : 0 }, { "pattern" : "select~from~t3~where~id", "max_concurrency" : 10 } ] }, { "sql_type" : "UPDATE", "patterns" : [ { "pattern" : "update~t3~where~id", "max_concurrency" : 10 } ] } ] }, { "node_id" : "b234a5645eb2c4ji3b9372342f5362397no07", "rules" : [ { "sql_type" : "SELECT", "patterns" : [ { "pattern" : "select~from~t3~where~id", "max_concurrency" : 10 } ] }, { "sql_type" : "DELETE", "patterns" : [ { "pattern" : "delete~t3~where~id", "max_concurrency" : 10 } ] } ] } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 sql_filter_rules 是 Array of NodeSqlFilterRuleInfo objects 节点级别的SQL限流规则。 表4 NodeSqlFilterRuleInfo 参数 是否必选 参数类型 描述 node_id 是 String 节点ID rules 是 Array of NodeSqlFilterRule objects SQL限流规则。集合的sql_type值不能重复。 表5 NodeSqlFilterRule 参数 是否必选 参数类型 描述 sql_type 是 String Sql限流类型。 取值范围： SELECT UPDATE DELETE patterns 是 Array of NodeSqlFilterRulePattern objects SQL限流具体规则。 表6 NodeSqlFilterRulePattern 参数 是否必选 参数类型 描述 pattern 是 String SQL限流规则，由一个或多个关键字（最多为128个关键字）组成，关键字之间通过"~"分隔符分开，如select~from~t1。规则中不能包含‘\’、中英文逗号、‘~~’，不能以‘~’结尾。 max_concurrency 是 Integer 最大并发数。取值范围：非负整数。

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 job_id String 设置SQL限流规则任务ID。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/instances/{instance_id}/restore-time 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 租户在某一project下的实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 date 否 String 所需查询的日志，为yyyy-mm-dd字符串格式，时区为UTC。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 restore_times Array of RestoreTimeInfo objects 可恢复时间段列表。 表5 RestoreTimeInfo 参数 参数类型 描述 start_time Long 可恢复时间段的起始时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time Long 可恢复时间段的结束时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应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 一级备份保留数量。当一级备份开关开启时，返回此参数。 状态码： 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" }}

响应示例 状态码： 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" } } ]}

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 规格编码。

请求示例 查询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