华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 slow_log_list Array of MysqlSlowLogList objects 错误日志具体信息。 long_query_time String 慢日志阈值。 total_record Integer 总记录数。 表5 MysqlSlowLogList 参数 参数类型 描述 node_id String 节点ID。 count String 执行次数。 time String 执行时间。 lock_time String 等待锁时间。 rows_sent String 结果行数量。 rows_examined String 扫描的行数量。 database String 所属数据库。 users String 账号。 query_sample String 执行语法。 type String 语句类型。 start_time String 发生时间,UTC时间 client_ip String IP地址。 状态码： 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参数 参数 是否必选 参数类型 描述 password 是 String 数据库密码。取值范围：至少包含以下字符的三种：大小写字母、数字和特殊符号~!@#$%^*-_=+?,()&，长度8~32个字符。建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您输入弱密码，系统会自动判定密码非法。

URI POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/restart 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 node_id 是 String 节点ID。

响应参数 状态码： 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 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 delay 否 Boolean 实例节点是否延迟重启。默认false，立即重启。 true: 延迟重启，实例节点将在运维时间窗内自动重启。 false: 立即重启。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 schedules Array of ScheduleTask objects 任务详情 total_count Integer 记录总数。 表5 ScheduleTask 参数 参数类型 描述 job_id String 任务ID。 instance_id String 实例ID。 instance_name String 实例名称。 instance_status String 实例状态。 取值： 值为“createfail”，表示实例创建失败。 值为“creating”，表示实例创建中。 值为“normal”，表示实例正常。 值为“abnormal”，表示实例异常。 值为“deleted”，表示实例已删除。 project_id String 租户在某一region下的project ID。 job_name String 任务名称。取值有： "Create GaussDB forMySQLInstance"表示创建实例。 "RestoreGaussDBforMySQLNewInstance"表示恢复新实例。 "AddGaussDBforMySQLNodes"表示添加节点。 "DeleteGaussDBforMySQLNode"表示删除节点。 "RebootGaussDBforMySQLInstance"表示重启实例。 "ModifyGaussDBforMySQLPort"表示修改实例端口。 "ModifyGaussDBforMySQLSecurityGroup"表示修改实例安全组。 "ResizeGaussDBforMySQLFlavor"表示实例规格变更。 "SwitchoverGaussDBforMySQLMasterNode"表示只读升主。 "GaussDBforMySQLBindEIP"表示绑定弹性公网IP。 "GaussDBforMySQLUnbindEIP"表示解绑弹性公网IP。 "RenameGaussDBforMySQLInstance"表示修改实例名称。 "DeleteGaussDBforMySQLInstance"表示删除实例集群。 "UpgradeGaussDBforMySQLDatabaseVersion"表示版本升级。 "EnlargeGaussDBforMySQLProxy"表示实例的数据库代理节点扩容。 "OpenGaussDBforMySQLProxy"表示开启实例的数据库代理。 "CloseGaussDBforMySQLProxy"表示关闭实例的数据库代理。 "GaussdbforMySQLModifyProxyIp"表示修改数据库代理ip。 "ScaleGaussDBforMySQLProxy"表示实例的数据库代理节点规格变更。 "GaussDBforMySQLModifyInstanceMetricExtend"表示实例秒级监控。 "GaussDBforMySQLModifyInstanceDataVip"表示修改实例数据Vip。 "GaussDBforMySQLSwitchSSL"表示切换实例SSL开关。 "GaussDBforMySQLModifyProxyConsist"表示修改代理一致性。 "GaussDBforMySQLModifyProxyWeight"表示修改代理权重。 create_time String 任务创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 说明：创建时返回值为空，数据库实例创建成功后该值不为空 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_status String 任务执行状态。 取值： 值为“Pending”，表示延时任务，未执行。 值为“Running”，表示任务正在执行。 值为“Completed”，表示任务执行成功。 值为“Failed”，表示任务执行失败。 datastore_type String 数据库类型。 target_config Object 实例配置相关信息，比如规格等。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "schedules" : [ { "job_id" : "56d3c1138dcf4f1da73b0170700c78d0", "instance_id" : "79bc540dd4d6432784894a981fdfacfcin07", "instance_name" : "gauss-f821", "instance_status" : "BUILD", "project_id" : "053f533ead80d5102f0cc012e8d468a4", "job_name" : "VERSION_UPGRADE", "create_time" : "2018-08-06T10:41:14+0000", "start_time" : "2018-08-06T10:41:14+0000", "end_time" : "2018-08-06T10:41:14+0000", "job_status" : "Completed", "datastore_type" : "gaussdb-mysql", "target_config" : { "flavor" : "gaussdb.mysql.xlarge.arm.4", "mem" : "16", "cpu" : "4" } } ], "total_count" : 1}

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 错误消息。

请求参数 表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 只读节点权重

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规则。

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

响应参数 状态码： 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 错误消息。

请求示例 按备份文件恢复到当前实例。 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"}

响应参数 状态码： 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 错误消息。

请求参数 表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"必选。

请求参数 表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 表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。(如果已经存在实例，应该大于已经占用的内存数)

响应参数 状态码： 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 错误消息。

请求示例 设置资源配额。 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 错误消息。

请求参数 表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。(如果已经存在实例，应该大于已经占用的内存数)

请求示例 设置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 } ] } ] } ]}

响应参数 状态码： 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 错误消息。

请求参数 表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 表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 错误消息。

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 表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 }}