华为云用户手册

请求示例 创建ClickHouse数据同步。 POST https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication { "source_instance_id" : "source_instance_id", "source_node_id" : "source_node_id", "source_database" : "source_database" }

响应参数 状态码： 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。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 source_instance_id 是 String 源实例ID。 source_node_id 否 String 源节点ID。TaurusDB只读节点ID。如为空，则取TaurusDB主节点ID。 source_database 是 String 源数据库。

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

响应示例 状态码： 200 Success. { "total_count" : 10, "instances" : [ { "instance_id" : "75e1935142974ca685357dc784626f22in07", "instance_name" : "gauss-ff14-hll" }, { "instance_id" : "cf72c31a689c40b7883c355a0bb5cc1din07", "instance_name" : "tst-bbbnew" }, { "instance_id" : "4a99fbae95df43648281cdd9e269c1c7in07", "instance_name" : "gauss-62d8" }, { "instance_id" : "fb6244dc9b1443b7ad0aae81283d5d28in07", "instance_name" : "gauss-test-1" }, { "instance_id" : "2260da7e105e485ebc9c060c1663d89ain07", "instance_name" : "gauss-f4c6-cx" }, { "instance_id" : "1cf7357f931448f89229de664c114d05in07", "instance_name" : "gauss-wry-0710-3" }, { "instance_id" : "5280b1a667d142378fe28816afb2e4b8in07", "instance_name" : "taurus_WAkJSzVy" }, { "instance_id" : "56c6924923804259a1b15b846c6b4bf1in07", "instance_name" : "tck-update3" }, { "instance_id" : "72a8f4287e04427985087795825fcddain07", "instance_name" : "critBack" }, { "instance_id" : "c5df1dec75ed48ab85fe52c72ba784bbin07", "instance_name" : "gauss-f873-cx" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instances Array of ApplicableInstances objects 可以应用的实例列表。 total_count Integer 可应用的实例列表数量。 表5 ApplicableInstances 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/configurations/{configuration_id}/applicable-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 configuration_id 是 String 参数模板ID。 通过调用查询参数模板接口获取。 请求响应成功后在响应消息体中包含的“id”的值即为configuration_id值。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 backup_id String 备份ID。 backup_name String 备份名称。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 schedules Array of ScheduleTask objects 任务详情 total_count Integer 记录总数。 表5 ScheduleTask 参数 参数类型 描述 job_id String 任务ID。 instance_id String 实例ID，严格匹配UUID规则。 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：表示修改数据库读写分离地址。 ScaleGaussDBforMySQLProxy：表示实例的数据库代理节点规格变更。 GaussDBforMySQLModifyInstanceMetricExtend：表示实例秒级监控。 GaussDBforMySQLModifyInstanceDataVip：表示修改实例数据浮动IP。 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 任务调度类型。

监控指标 表1 监控指标说明 指标 指标名称 含义 取值范围 备注 gaussdb_mysql001_cpu_util CPU使用率 该指标用于统计测量对象的CPU利用率。 0～100% 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql002_mem_util 内存使用率 该指标用于统计测量对象的内存利用率。 0～100% 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql004_bytes_in 网络输入吞吐量 该指标用于统计平均每秒从测量对象的所有网络适配器输入的流量。 ≥0 Bytes/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql005_bytes_out 网络输出吞吐量 该指标用于统计平均每秒从测量对象的所有网络适配器输出的流量。 ≥0 Bytes/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql006_conn_count 数据库总连接数 该指标用于统计连接到MySQL服务器的总连接数。 ≥0 Connections 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql007_conn_active_count 当前活跃连接数 该指标用于统计当前活跃的连接数。 ≥0 Connections 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql008_qps QPS 该指标用于统计SQL语句查询次数，包含DDL，DML，SHOW语句，SET语句和存储过程。 ≥0 Times/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql009_tps TPS 该指标用于统计平均每秒事务执行次数，包含提交的和回退的。 ≥0 Times/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql010_innodb_buf_usage 缓冲池利用率 该指标用于统计使用的页与InnoDB缓存中数据页总数比例。 0～100% 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql011_innodb_buf_hit 缓冲池命中率 该指标用于统计该段时间读命中与读请求数比例。 0～100% 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql012_innodb_buf_dirty 缓冲池脏块率 该指标用于统计InnoDB缓存中脏数据与数据比例。 0～100% 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql013_innodb_reads InnoDB读取吞吐量 该指标用于统计Innodb平均每秒读字节数。 ≥0 Bytes/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql014_innodb_writes InnoDB写入吞吐量 该指标用于统计Innodb平均每秒写字节数。 ≥0 Bytes/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql017_innodb_log_write_req_count InnoDB日志写请求频率 该指标用于统计平均每秒的日志写请求数。 ≥0 Requests/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql020_temp_tbl_count 临时表数量 该指标用于统计MySQL执行语句时在硬盘上自动创建的临时表的数量。 ≥0 Tables 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql028_comdml_del_count Delete语句执行频率 该指标用于统计平均每秒Delete语句执行次数。 ≥0 Statements/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql029_comdml_ins_count Insert语句执行频率 该指标用于统计平均每秒Insert语句执行次数。 ≥0 Statements/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql030_comdml_ins_sel_count Insert_Select语句执行频率 该指标用于统计平均每秒Insert_Select语句执行次数。 ≥0 Statements/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql031_comdml_rep_count Replace语句执行频率 该指标用于统计平均每秒Replace语句执行次数。 ≥0 Statements/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql032_comdml_rep_sel_count Replace_Selection语句执行频率 该指标用于统计平均每秒Replace_Selection语句执行次数。 ≥0 Statements/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql033_comdml_sel_count Select语句执行频率 该指标用于统计平均每秒Select语句执行次数。 ≥0 Statements/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql034_comdml_upd_count Update语句执行频率 该指标用于统计平均每秒Update语句执行次数。 ≥0 Statements/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql035_innodb_del_row_count 行删除速率 该指标用于统计平均每秒从InnoDB表删除的行数。 ≥0 Rows/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql036_innodb_ins_row_count 行插入速率 该指标用于统计平均每秒向InnoDB表插入的行数。 ≥0 Rows/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql037_innodb_read_row_count 行读取速率 该指标用于统计平均每秒从InnoDB表读取的行数。 ≥0 Rows/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql038_innodb_upd_row_count 行更新速率 该指标用于统计平均每秒向InnoDB表更新的行数。 ≥0 Rows/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql048_disk_used_size 磁盘使用量 该指标用于统计测量对象的磁盘使用大小。 0GB～128TB 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql072_conn_usage 连接数使用率 该指标用于统计当前已用的MySQL连接数占最大连接数的百分比。 0~100% 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql074_slow_queries 慢日志个数统计 该指标展示每分钟MySQL产生慢日志的数量。 ≥0 Queries/min 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql077_replication_delay 数据同步延迟 该指标用于采集集群实例的数据同步延迟时间。 ≥0 s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql104_dfv_write_delay 存储写时延 该指标用于统计某段时间写入数据到存储层的平均时延。 ≥0 ms 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql105_dfv_read_delay 存储读时延 该指标用于统计某段时间从存储层读取数据的平均时延。 ≥0 ms 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql106_innodb_row_lock_current_waits InnoDB行锁数量 该指标用于采集InnoDB表上的操作当前正在等待的行锁数量。 ≥0 Locks 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql107_comdml_ins_and_ins_sel_count Insert和Insert_Select语句执行频率 该指标用于统计平均每秒Insert和Insert_Select语句的执行次数。 ≥0 Statements/s 测量对象：弹性云服务器 监控实例类型：TaurusDB实例 gaussdb_mysql108_com_commit_count Commit语句执行频率 该指标用于统计平均每秒Commit语句的执行次数。 ≥0 Statements/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql109_com_rollback_count Rollback语句执行频率 该指标用于统计平均每秒Rollback语句的执行次数。 ≥0 Statements/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql110_innodb_bufpool_reads InnoDB存储层读请求频率 该指标用于统计平均每秒InnoDB从存储层读取数据的请求次数。 ≥0 Times/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql111_innodb_bufpool_read_requests InnoDB读请求频率 该指标用于统计平均每秒InnoDB读取数据的请求次数。 ≥0 Requests/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql114_innodb_bufpool_read_ahead innodb顺序预读页数 该指标用于统计innodb顺序预读页数。 ≥0 Pages 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql115_innodb_bufpool_read_ahead_evicted innodb顺序预读，但未访问过的页数 该指标用于统计innodb顺序预读，但未访问过的页数。 ≥0 Pages 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql116_innodb_bufpool_read_ahead_rnd innodb随机预读页数 该指标用于统计innodb随机预读页数。 ≥0 Read-aheads 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql117_innodb_pages_read innodb读取物理page的数量 该指标用于统计innodb读取物理page的数量。 ≥0 Pages 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql118_innodb_pages_written innodb写入物理page的数量 该指标用于统计innodb写入物理page的数量。 ≥0 Pages 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql019_innodb_log_writess innodb log buffer写入log file的总次数 该指标用于统计对InnoDB redo log文件的物理写入次数。 ≥0 Writes 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql342_iostat_iops_write IO写IOPS 该指标用于采集磁盘每秒写次数。 ≥0 Operations/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql344_iostat_iops_read IO读IOPS 该指标用于采集磁盘每秒读次数。 ≥0 Operations/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql346_iostat_throughput_write IO写带宽 该指标用于采集磁盘每秒写带宽。 ≥0 Bytes/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql348_iostat_throughput_read IO读带宽 该指标用于采集磁盘每秒读带宽。 ≥0 Bytes/s 测量对象：数据库 监控实例类型：TaurusDB实例 gaussdb_mysql119_disk_used_ratio 磁盘使用率 该指标用于统计磁盘的使用率。 0~100% 测量对象：数据库 监控实例类型：TaurusDB实例 1分钟 gaussdb_mysql371_taurus_binlog_total_file_counts Binlog文件个数 该指标用于统计TaurusDB Binlog文件数量。 ≥0 测量对象：数据库 监控实例类型：TaurusDB实例 5分钟 gaussdb_mysql378_create_temp_tbl_per_min 临时表每分钟创建数 该指标用于统计TaurusDB执行语句时在硬盘上每分钟自动创建的临时表的数量。 ≥0 Tables/min 测量对象：数据库 监控实例类型：TaurusDB实例 1分钟

响应示例 状态码： 200 Success. { "total_count" : 6, "instance_infos" : [ { "instance_id" : "6206d5be05914703938ff9dfe5c07d34in07", "master_node_id" : "7fe925aa8bab4cc9bac3990a94386c29no07" }, { "instance_id" : "cbdb32e08f0440158c4f2998dbf69b14in07", "master_node_id" : "3e90e7b99b964dca9704b3af903fcb41no07" }, { "instance_id" : "325af119c2ca4e77b1deb4810a9b921bin07", "master_node_id" : "f4dfb362039a45818e59416abc9a5ca6no07" }, { "instance_id" : "9e8b52a5b6e84f4a9e4db01235b1c770in07", "master_node_id" : "408666cd6f104133ad0685b722f88cffno07" }, { "instance_id" : "5814254f12f74d16bd0a93885b00867fin07", "master_node_id" : "637d96ffbf6745ff835445fe87d08fc5no07" }, { "instance_id" : "d0da4882ebdf44bd9d3f1edf9b0bd4a2in07", "master_node_id" : "7a670f4ecdf14db5a4b5df737b0911a5no07" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 当前指标的异常实例总数。 instance_infos Array of InstanceInfoForDiagnosis objects 异常实例信息。 表5 InstanceInfoForDiagnosis 参数 参数类型 描述 instance_id String 实例ID。 master_node_id String 主节点ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

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

响应示例 状态码： 200 Success. { "total_count" : 1, "replications" : [ { "source_database" : "source_database", "target_database" : "target_database", "task_name" : "task_name", "status" : "Yes", "stage" : "Incremental", "percentage" : 100, "catchup_stage" : null, "catchup_percentage" : 0 } ], "ext_text" : null } 状态码： 400 Client error. { "error_code" : "DBS.200022", "error_msg" : "实例不存在" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count String 查询数据同步任务数。 replications Array of StarRocksReplicationInfo objects 数据同步任务信息。 ext_text String 扩展字段。 表5 StarRocksReplicationInfo 参数 参数类型 描述 source_database String TaurusDB数据库。字符串长度限制3-1024位。 target_database String 目标数据库。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 task_name String 同步任务名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 status String 当前状态。Yes：正常，No：异常。 stage String 同步阶段。wait：等待同步，incremental：增量同步，full：全量同步，cancelled：删除，paused：暂停同步。 percentage String 进度百分比。 catchup_stage String 追赶阶段。wait：等待同步，incremental：增量同步，full：全量同步，cancelled：删除，paused：暂停同步。 catchup_percentage String 追赶进度百分比。 状态码： 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}/starrocks/databases/replication 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String StarRocks实例ID，严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 查询记录数。每页查询数据同步任务的数量。 offset 否 String 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 order_id String 订单号，仅包年/包月返回该参数。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

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

响应示例 状态码： 200 Success. { "instance" : { "id" : "d738399de028480fabb2b8120d4e01a4in07", "name" : "gaussdb-mysql-instance01", "alias" : "", "status" : "normal", "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" ], "private_dns_names" : [ "d738399de028480fabb2b8120d4e01a4in07.internal.cn-xianhz-1.gaussdbformysql.myhuaweicloud.com" ], "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" : "normal", "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.4", "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" : "normal", "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.4", "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 MysqlInstanceInfoDetailUnifyStatus object 实例信息。 表4 MysqlInstanceInfoDetailUnifyStatus 参数 参数类型 描述 id String 实例ID，严格匹配UUID规则。 name String 创建的实例名称。 project_id String 租户在某一Region下的project ID。 status String 实例状态。 取值： 值为“creating”，表示实例正在创建。 值为“normal”，表示实例正常。 值为“abnormal”，表示实例异常。 值为“createfail”，表示实例创建失败。 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地址。 private_dns_names Array of strings 实例内网 域名 列表。实例创建成功后，需要手动申请内网域名，否则查询内网域名为空。 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 代理信息。 tde_info MysqlTdeInfo object 透明 数据加密 配置信息，支持AES256、SM4加密算法。 透明加密功能目前处于公测阶段，如需使用，请提交工单联系客服人员申请权限。 表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，严格匹配UUID规则。 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 数据库代理ID。 name String 数据库代理名称。 address String Proxy读写分离地址。 表12 MysqlTdeInfo 参数 参数类型 描述 enable_tde Boolean 是否打开透明加密功能。 encryption_type String 透明加密算法，支持AES256、SM4加密算法。 状态码： 400 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg 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。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 instance_ids 是 Array of strings 实例ID列表。列表长度限制在10以内。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 修改指定实例参数的任务ID。 restart_required Boolean 是否需要重启。 true：是。 false：否。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 修改指定实例的参数。 PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/3ef58db3986540d19f95151309368d34in07/configurations { "parameter_values" : { "max_user_connections" : "100" } }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 ssl_option 是 Boolean SSL数据加密开关设置。 取值范围： true: 开启SSL数据加密。 false: 关闭SSL数据加密。

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

URI DELETE /v3/{project_id}/instances/{instance_id}/clickhouse/databases/replication/config 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String ClickHouse实例ID，严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 database 是 String 数据库名。