华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 size 是 Integer 扩容后的容量，每次扩容最小容量为10GB，实例所选容量大小必须为10的整数倍 is_auto_pay 否 String 表示是否自动从客户的账户中支付。 true，为自动支付，默认该方式。 false，为手动支付。 枚举值： true false

响应示例 状态码： 200 Success. { "databases" : [ { "name" : "test", "charset" : "utf8mb4", "comment" : "database_comment", "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "readonly" : false } ] } ], "total_count" : 1}

URI GET /v3/{project_id}/instances/{instance_id}/databases 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 instance_id 是 String 参数解释： 实例ID，此参数是实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 必须为整数，不能为负数。 取值范围： ≥0 默认取值： 0 limit 否 Integer 参数解释： 查询记录数。 约束限制： 必须为整数，不能为负数。 取值范围： 1-100 默认取值： 100 name 否 String 参数解释： 数据库名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 charset 否 String 参数解释： 数据库使用的字符集。 获取方法参见查询数据库可用字符集。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 databases Array of ListGaussMysqlDatabaseInfo objects 参数解释： 数据库信息列表。 total_count Integer 参数解释： 数据库总数。 取值范围： ≥0 表5 ListGaussMysqlDatabaseInfo 参数 参数类型 描述 name String 参数解释： 数据库名称。 取值范围： 不涉及 charset String 参数解释： 数据库使用的字符集。 取值范围： 不涉及 comment String 参数解释： 数据库备注。 取值范围： 不涉及。 users Array of GaussMySqlDatabaseInfo objects 参数解释：已授权数据库用户列表。 表6 GaussMySqlDatabaseInfo 参数 参数类型 描述 name String 参数解释： 数据库用户名。 取值范围： 不涉及。 host String 参数解释： 主机地址。 取值范围： 不涉及。 readonly Boolean 参数解释： 是否为只读权限。 取值范围： true：表示只读。 false：表示可读写。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

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

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

响应示例 状态码： 200 Success. { "db_parameters" : [ { "param_name" : "default_isolation_level", "data_type" : "String", "default_value" : "QUERY_SNAPSHOT", "value_range" : "READ_COMMITTED|READ_UNCOMMITTED|QUERY_RAW|QUERY_SNAPSHOT", "description" : "默认隔离级别，仅对MaterializeMySQL 引擎有效,可以是“read_uncommitted”，这意味着没有 MVCC 支持，“read_committed”，它保留查询（包括子查询）中的事务完整性，或“query_snapshot”，它保留事务完整性并以牺牲数据新鲜度为代价删除重复和删除的行。" }, { "param_name" : "enable_snapshots", "data_type" : "String", "default_value" : "true", "value_range" : "true|false", "description" : "创建快照以支持mvcc_isolation_level='query_snapshot'" }, { "param_name" : "enable_chunk_level", "data_type" : "String", "default_value" : "true", "value_range" : "true|false", "description" : "支持chunk级别的并行复制，复制会更快" }, { "param_name" : "max_sync_threads", "data_type" : "Integer", "default_value" : "1", "value_range" : "1-2", "description" : "全量复制最大线程数" }, { "param_name" : "treat_numeric_string_as_integer", "data_type" : "String", "default_value" : "false", "value_range" : "true|false", "description" : "允许在全量同步期间块级任务生成中将数字字符串视为整数" }, { "param_name" : "min_binlog_expire_logs_seconds", "data_type" : "Integer", "default_value" : "86400", "value_range" : "0-2592000", "description" : "允许binlog保存的最小时长，如果binlog保存的时间小于该阈值，同步会报失败。0表示不做限制。" }, { "param_name" : "max_rows_in_buffer", "data_type" : "Integer", "default_value" : "2000000", "value_range" : "1-10000000", "description" : "内存中允许缓存数据的最大行数（对于单表和无法查询的缓存数据而言）。当行数超过时，数据将被物化" }, { "param_name" : "max_rows_in_buffers", "data_type" : "Integer", "default_value" : "6000000", "value_range" : "1-10000000", "description" : "内存中允许缓存的最大行数（用于数据库和无法查询的缓存数据而言）。当行数超过时，数据将被物化" }, { "param_name" : "max_bytes_in_buffer", "data_type" : "Integer", "default_value" : "200000000", "value_range" : "1-1000000000", "description" : "数据在内存中允许缓存的最大字节数（对于单表和无法查询的缓存数据）。当字节数超过时，数据将被物化" }, { "param_name" : "max_bytes_in_buffers", "data_type" : "Integer", "default_value" : "600000000", "value_range" : "1-1000000000", "description" : "数据在内存中允许缓存的最大字节数（对于数据库和无法查询的缓存数据）。当字节数超过时，数据将被物化" }, { "param_name" : "max_flush_data_time", "data_type" : "Integer", "default_value" : "5000", "value_range" : "1-10000", "description" : "允许数据缓存在内存中的最大时长(毫秒)" } ]}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 db_parameters Array of ChDatabaseParameterInfo objects 库参数信息。 表4 ChDatabaseParameterInfo 参数 参数类型 描述 param_name String 参数名称。 data_type String 参数类型。 default_value String 参数默认值。 value_range String 参数取值范围。 description String 参数描述。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 files Array of FileInfo objects 获取到的全量SQL文件信息。 表5 FileInfo 参数 参数类型 描述 name String 文件名。 size Long 文件大小，单位：KB。 updated_time String SQL文件最后一次修改时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指时区偏移量，例如偏移1个小时显示为+0100。 download_link String 文件下载链接。 link_expired_time String 下载链接过期时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指时区偏移量，例如偏移1个小时显示为+0100。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "files" : [ { "name" : "20230706023359_669a94abef9f4979b2dfba92f48f4042in07_b051c8f7b98f4deeaf88ba97c8daba9dno07_SQLAudit_903bdbb6-1ba5-11ee-8b97-fa163ef0f8c2", "size" : 928, "updated_time" : "2023-07-06T02:43:57+0800", "download_link" : "https://obs.obs.domainname.com/bucketname/userid_instanceid/20230706/SQLAudit/xxxxxx", "link_expired_time" : "2023-07-13T012:30:36+0800" } ]}

请求示例 获取全量SQL的临时下载链接。 GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/669a94abef9f4979b2dfba92f48f4042in07/auditlog/download-link?node_id=2e723b45786148fc94c8737f5980786cno07&last_file_name=20230724160316_99b1d48896bb44178b715d64b68603f9in07_6a21d5df9bb24f5db83121c5fec0b1d2no07_SQLAudit_8b4b53d2-29f8-11ee-92aa-fa163ef00f0d&limit=10&start_time=2023-07-24T09:27:00+0800&end_time=2023-07-25T15:00:14+0800

URI GET /v3/{project_id}/instance/{instance_id}/auditlog/download-link 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间，不得早于实例创建时间。格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time 是 String 结束时间，不得晚于当前时间。格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 node_id 否 String 节点ID。 若输入，则只获取该节点的全量SQL下载链接。 若不输入，则获取该实例所有节点的全量SQL下载链接。 last_file_name 否 String 上次查询的最后一个文件的文件名。 若输入，则从该文件名以后按字典顺序开始查询。 若不输入，则从第一个文件开始查询。 limit 否 Integer 一次查询返回的文件数量。 默认值为10，取值范围：1~50之间的整数值。

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

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

URI GET /v3/{project_id}/configurations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 必须为整数，不能为负数。 取值范围： ≥0 默认取值： 0 limit 否 Integer 参数解释： 查询记录数。 约束限制： 必须为整数，不能为负数。 取值范围： 1-100 默认取值： 100

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 configurations Array of ConfigurationSummary objects 参数解释： 参数模板信息。 total_count Integer 参数解释： 参数模板的总数。 取值范围： ≥0 表5 ConfigurationSummary 参数 参数类型 描述 id String 参数解释： 参数组ID。 取值范围： 只能由英文字母、数字组成，前面为UUID，后缀为pr07，长度为36个字符。 name String 参数解释： 参数组名称。 取值范围： 不涉及。 datastore_version_name String 参数解释： 数据库版本。 取值范围： 8.0 datastore_name String 参数解释： 数据库名称。 取值范围： GaussDB (for MySQL) created String 参数解释： 参数组创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 取值范围： 不涉及。 updated String 参数解释： 参数组更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 取值范围： 不涉及。 user_defined Boolean 参数解释： 是否是用户自定义参数模板 取值范围： false：表示为系统默认参数模板。 true：表示为用户自定义参数模板。 description String 参数解释： 参数组描述。 取值范围： 不涉及。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "total_count" : 101, "configurations" : [ { "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", "name" : "configuration_test", "description" : "configuration_test", "datastore_version_name" : "8.0", "datastore_name" : "GaussDB(for MySQL)", "created" : "2019-05-15T11:53:34+0000", "updated" : "2019-05-15T11:53:34+0000", "user_defined" : true }, { "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07", "name" : "Default-GaussDBforMySQL", "description" : "Default parameter template for GaussDBforMySQL", "datastore_version_name" : "8.0", "datastore_name" : "GaussDB(for MySQL)", "created" : "2019-05-27T03:38:51+0000", "updated" : "2019-05-27T03:38:51+0000", "user_defined" : false } ]}

URI GET /v3/{project_id}/instances/{instance_id}/errorlog 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID 表2 Query参数 参数 是否必选 参数类型 描述 start_date 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_date 是 String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 level 否 String 日志级别。 取值范围： ALL INFO LOG WARNING ERROR FATAL PANIC NOTE node_id 是 String 节点ID

响应示例 状态码： 200 Success. { "error_log_list" : [ { "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "time" : "2022-07-17T07:34:33", "level" : "ERROR", "content" : "[MY013508] [Repl] do failed: 1" } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error_log_list Array of MysqlErrorLogList objects 错误日志具体信息。 total_record Integer 总记录数。 表5 MysqlErrorLogList 参数 参数类型 描述 node_id String 节点ID。 time String 日期时间UTC时间。 level String 日志级别。 content String 错误日志内容。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/errorlog?offset=0&limit=1&level=ALL&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 users Array of ListGaussMySqlDatabaseUser objects 数据库用户列表。 total_count Integer 实例的数据库用户总数 表5 ListGaussMySqlDatabaseUser 参数 参数类型 描述 name String 数据库用户名。 host String 主机地址。 comment String 数据库用户备注。 databases Array of ListGaussMySqlDatabase objects 数据库列表。 表6 ListGaussMySqlDatabase 参数 参数类型 描述 name String 数据库名称。 readonly Boolean 是否为只读权限： true：表示只读。 false：表示可读写。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "comment" : "database_user_comment", "databases" : [ { "name" : "test", "readonly" : false } ] } ], "total_count" : 1}

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

响应示例 状态码： 200 Success. { "resources" : [ { "id" : "1d07f7ba-f140-46a7-b002-58ba22ee6ff3", "resource_name" : "testdcc", "engine_name" : "gaussdb-mysql", "architecture" : "ARM", "status" : "NORMAL", "capacity" : { "ram" : 256, "volume" : 10000000, "vcpus" : 64 }, "availability_zone" : [ "az1xahz" ] } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 resources Array of DedicatedResource objects 专属资源池信息。 total_count Integer 专属资源池数量。 表5 DedicatedResource 参数 参数类型 描述 id String 专属资源池ID。 resource_name String 专属资源池名称。 engine_name String 数据库引擎名称。 architecture String CPU架构 status String 专属资源池状态。 取值范围： NORMAL：正常。 BUILDING：构建中。 EXTENDING：扩容中。 DELETED：已删除。 capacity DedicatedResourceCapacity object 专属资源池容量信息。 availability_zone Array of strings 专属资源池可用区信息。 表6 DedicatedResourceCapacity 参数 参数类型 描述 ram Integer 内存大小，单位GB。 volume Long 磁盘容量，单位GB。 vcpus Integer CPU核数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 size 是 Integer 扩容后的容量。包年/包月实例初始最小磁盘规格为10G，实例所选容量大小必须为10的整数倍，且大于实际使用容量，最大为128000GB。 取值范围： 扩容时必须大于等于20G。 缩容时必须大于等于10G。 is_auto_pay 否 String 表示是否自动从客户的账户中支付。 true：为自动支付，默认该方式。 false：为手动支付。