华为云用户手册

响应示例 状态码： 200 Success. { "slow_log_list" : [ { "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "count" : 1, "time" : "1.04899 s", "lock_time" : "0.00003 s", "rows_sent" : 0, "rows_examined" : 0, "database" : "gaussdb-mysql", "users" : "root", "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);", "type" : "INSERT", "start_time" : "2121-03-25T10:55:16.000Z", "client_ip" : "192.*.*.1" } ], "long_query_time" : 10, "total_record" : 15}

URI GET /v3/{project_id}/instances/{instance_id}/clickhouse/slowlog-sensitive 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String ClickHouse实例ID，严格匹配UUID规则。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 open_slow_log_switch String 慢日志脱敏开关。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 Success. { "instances" : [ { "id" : "914481def3574d5189baee926a26512din17", "name" : "htap-5d98", "project_id" : "23a50154cf494ec9ad6883979a12db0a", "public_ip" : "", "data_vip" : "192.168.8.4", "can_enable_public_access" : false, "current_backup_node_id" : null, "cluster_mode" : "Single", "status" : "normal", "is_frozen" : 0, "frozen_time" : null, "db_user" : "root", "bak_period" : null, "bak_keep_day" : null, "bak_expected_start_time" : null, "data_store_version_id" : "717b683b-9d89-3e3b-9100-7893bee47d95", "data_store_version" : "3.1.11.0", "data_store_type" : "star-rocks", "create_at" : 1716344516418, "update_at" : 1716347522157, "delete_at" : null, "db_port" : "3306", "param_group" : null, "actions" : [ ], "create_fail_error_code" : "500000", "groups" : [ { "id" : "8d9d63263ece41619ba819f8d85c5cafgr17", "name" : "htap-5d98_fe_shard01", "nodes" : [ { "id" : "7739bfbc4e244a8bac0662d63683c808no17", "name" : "htap-5d98_fe_shard01_node01", "type" : "fe-leader", "status" : "normal", "period" : "null", "volume" : { "type" : "SSD", "size" : "50000000000" }, "cpu" : "4", "mem" : "16", "datastore" : { "id" : "717b683b-9d89-3e3b-9100-7893bee47d95", "type" : "star-rocks", "version" : "3.1.11.0" }, "actions" : [ ], "priority" : 1, "frozen_flag" : 0, "db_port" : 3306, "pay_model" : "0", "order_id" : null, "traffic_ip" : "192.168.8.4", "traffic_ipv6" : "", "az_code" : "cn-southwest-244d", "az_description" : "az4", "az_type" : "Center", "region_code" : "cn-southwest-244", "create_at" : 1716344516418, "update_at" : 1716361751849, "flavor_id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a", "flavor_ref" : "gaussdb.sr-fe.xlarge.x86.4", "iass_flavor_ref" : "c6.xlarge.4", "max_connections" : "0", "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59", "subnet_id" : "09249318-4a97-4e48-b314-ffaab86d4295", "need_restart" : false, "sg_id" : "", "param_group" : null } ], "group_type_name" : "starrocks", "group_node_type" : "fe" }, { "id" : "fc416acdc4c1439e85100e9a7c161932gr17", "name" : "htap-5d98_be_shard01", "nodes" : [ { "id" : "ccab0ba176e642c69d598f2f3c0f06efno17", "name" : "htap-5d98_be_shard01_node01", "type" : "be", "status" : "normal", "period" : "null", "volume" : { "type" : "SSD", "size" : "50000000000" }, "cpu" : "4", "mem" : "16", "datastore" : { "id" : "717b683b-9d89-3e3b-9100-7893bee47d95", "type" : "star-rocks", "version" : "3.1.11.0" }, "actions" : [ ], "priority" : 1, "frozen_flag" : 0, "db_port" : 3306, "pay_model" : "0", "order_id" : null, "traffic_ip" : "192.168.8.194", "traffic_ipv6" : "", "az_code" : "cn-southwest-244d", "az_description" : "az4", "az_type" : "Center", "region_code" : "cn-southwest-244", "create_at" : 1716344516418, "update_at" : 1716358866767, "flavor_id" : "de565db8-0a96-37ea-9388-61167624712c", "flavor_ref" : "gaussdb.sr-be.xlarge.x86.4", "iass_flavor_ref" : "c6.xlarge.4", "max_connections" : "0", "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59", "subnet_id" : "09249318-4a97-4e48-b314-ffaab86d4295", "need_restart" : false, "sg_id" : "", "param_group" : null } ], "group_type_name" : "starrocks", "group_node_type" : "be" } ], "ops_window" : { "period" : null, "start_time" : "18:00", "end_time" : "22:00" }, "tags_info" : { "tags" : [ ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "value" : "0" } ] }, "time_zone" : "UTC+08:00", "backup_used_space" : null, "az_mode" : "single", "enterprise_project_id" : "0", "port_info" : { "mysql_port" : 3306 }, "fe_node_volume_code" : "gaussdb.sr.evs.ultrahighio", "be_node_volume_code" : "gaussdb.sr.evs.ultrahighio", "fe_node_volume_size" : "50000000000", "be_node_volume_size" : "50000000000", "support_data_replication" : true, "new_version_available" : false, "ssl_option" : false, "dedicated_resource_id" : null, "pay_model" : "0" } ]}

URI GET /v3/{project_id}/instances/{instance_id}/starrocks/{starrocks_instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String TaurusDB实例ID，严格匹配UUID规则。 starrocks_instance_id 是 String StarRocks实例ID，严格匹配UUID规则。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn

URI GET /v3/{project_id}/instances/{instance_id}/auto-scaling/policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 instance_id 是 String 参数解释： 实例ID，此参数是实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 默认取值： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制： 不涉及。 取值范围： 不涉及。 默认值： 不涉及。 Content-Type 是 String 参数解释： 内容类型。 约束限制： 不涉及。 取值范围： application/json。 默认值： 不涉及。 X-Language 否 String 参数解释： 请求语言类型。 约束限制： 不涉及。 取值范围： en-us zh-cn 默认值： en-us。

响应示例 状态码： 200 Success. 自动变配开启时查询自动变配。 { "id" : "26d8e193-1ea0-4adb-89d0-d1343399d0e7", "instance_id" : "41ff7519e22d44eea6066615fa5b17c7in07", "instance_name" : "gauss-test-1", "status" : "ON", "monitor_cycle" : 300, "silence_cycle" : 300, "enlarge_threshold" : 50, "max_flavor" : "gaussdb.mysql.large.x86.4", "reduce_enabled" : false, "min_flavor" : "gaussdb.mysql.medium.x86.4", "silence_start_at" : "2023-08-31T08:59:09+0000", "scaling_strategy" : { "flavor_switch" : "ON", "read_only_switch" : "ON" }, "max_read_only_count" : 2, "min_read_only_count" : 1, "read_only_weight" : 10} 自动变配关闭时查询自动变配。 { "id" : null, "instance_id" : "41ff7519e22d44eea6066615fa5b17c7in07", "instance_name" : "gauss-test-1", "status" : "OFF", "monitor_cycle" : null, "silence_cycle" : null, "enlarge_threshold" : null, "max_flavor" : null, "reduce_enabled" : null, "min_flavor" : null, "silence_start_at" : "", "scaling_strategy" : { "flavor_switch" : "", "read_only_switch" : "" }, "max_read_only_count" : null, "min_read_only_count" : null, "read_only_weight" : null}

URI POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/pause 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String StarRocks实例ID，严格匹配UUID规则。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 是 String 请求语言类型。默认en-us。 取值范围： - en-us - zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 task_name 是 String 同步任务名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。

响应参数 状态码： 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 表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 } ], "total_count" : 1}

响应参数 状态码： 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 实例个数配额，-1表示无限制。 vcpus_quota Integer CPU核数配额，-1表示无限制。 ram_quota Integer 内存使用配额，单位为GB，-1表示无限制。 availability_instance_quota Integer 实例剩余配额，-1表示无限制。 availability_vcpus_quota Integer CPU核数剩余配额，-1表示无限制。 availability_ram_quota Integer 内存剩余配额，-1表示无限制。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

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 企业项目名称。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 backup_policy 是 MysqlBackupPolicy object 数据库备份策略信息。 表4 MysqlBackupPolicy 参数 是否必选 参数类型 描述 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。HH取值必须比hh大1。mm和MM取值必须相同，且取值必须为00。 取值示例：21:00-22:00 keep_days 是 Integer 备份文件的保留天数。取值范围：1~732。您也可以联系客服申请开通最大保留天数为3660。 period 是 String 备份周期配置。自动备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字加1表示自动备份的星期。 取值示例：1,2,3,4,5,6,7则表示备份周期配置为星期二、星期三、星期四、星期五、星期六、星期日、星期一。 retention_num_backup_level1 否 Integer 一级备份保留数量，取值：0或1，默认值为0。当一级备份开关开启时，该参数必传。反之，不能传。

请求示例 修改实例的自动备份策略，每周的周二至周六的19:00-20:00进行备份，备份文件保留7天。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/21b6ea5a78244de98c1c2622e1dc593ain07/backups/policy/update{ "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,3,4,5" }}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 status String 状态信息。 instance_id String 实例ID，严格匹配UUID规则。 instance_name String 实例名称。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI PUT /v3/{project_id}/instances/{instance_id}/clickhouse/slowlog-sensitive 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String ClickHouse实例ID，严格匹配UUID规则。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 open_slow_log_switch 是 String 慢日志脱敏开关。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 open_slow_log_switch String 慢日志脱敏开关。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求示例 设置跨区域备份策略。 PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/backups/offsite-policy{ "backup_policy" : { "open_auto_backup" : true, "open_incremental_backup" : false, "destination_project_id" : "fd710c89089a448aa2e666ab15817090", "destination_region" : "cn-north-7", "keep_days" : 1 }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 backup_policy 是 UpdateBackupOffsitePolicyInfo object 备份策略信息。 表4 UpdateBackupOffsitePolicyInfo 参数 是否必选 参数类型 描述 open_auto_backup 是 Boolean 是否开启跨区域全量备份。 true：开启跨区域全量备份。 false：关闭跨区域全量备份。 open_incremental_backup 是 Boolean 是否开启跨区域增量备份。 true：开启跨区域增量备份，当open_auto_backup开启时才可以开启。 false：关闭跨区域增量备份。 destination_project_id 是 String 设置跨区域备份策略的目标project ID。 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 destination_region 是 String 设置跨区域备份策略的目标区域。 keep_days 是 Integer 指定已生成的备份文件可以保存的天数。 取值范围：1～1825。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 开启/关闭全量SQL操作结果。 状态码： 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。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 switch_status 是 String 全量SQL开关状态。 取值： ON：表示开启。 OFF：表示关闭。

请求示例 开启全量SQL。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/61a4ea66210545909d74a05c27a7179ein07/audit-log/switch{ "switch_status" : "ON"} 关闭全量SQL。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/61a4ea66210545909d74a05c27a7179ein07/audit-log/switch{ "switch_status" : "OFF"}

请求示例 查询实例列表 GET https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10

响应示例 状态码： 200 Success. { "instances" : [ { "id" : "d738399de028480fabb2b8120d4e01a4in07", "status" : "ACTIVE", "name" : "gaussdb-mysql-instance01", "private_ips": ["192.168.100.136"], "readonly_private_ips": ["192.168.100.78","192.168.100.147"], "proxy_ips": ["192.168.100.83"], "port": "3306", "type" : "Cluster", "private_ips" : [ "192.168.0.142" ], "db_user_name" : "root", "region" : "cn-north-4", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0", "kernel_version": "2.0.54.240600" }, "created" : "2018-08-20T02:33:49_0800", "updated" : "2018-08-20T02:33:49_0800", "volume" : { "type" : "POOL", "used_size" : 100 }, "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "flavor_ref" : "gaussdb.mysql.c3.small.4", "flavor_info" : { "vcpus" : 8, "ram" : 16 }, "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "charge_info" : { "charge_mode" : "postPaid" }, "enterprise_project_id" : 0, "time_zone" : "UTC", "tags" : [ ], "dedicated_resource_id" : "" } ], "total_count" : 1}