华为云用户手册

请求示例 开启数据库代理的会话一致性。 PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/d512257ecca04d96a0f3a9021018a385in07/proxy/7bf4a8bbb4f4fb58233a242ee13603bpo01/session-consistence{ "session_consistence" : "true", "consistence_mode" : "session"}

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

响应参数 状态码： 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/3ef58db3986540d19f95151309368d34in17/starrocks/configurations{ "parameter_values" : { "sync_tablet_meta" : "true" }, "node_type" : "be"}

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

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

请求示例 修改数据库代理参数。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/configurations{ "configurations" : [ { "name" : "multiStatementType", "value" : "Loose", "elem_type" : "system" } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 configurations 是 Array of UpdateProxyConfigurationItem objects 修改的配置信息。 表4 UpdateProxyConfigurationItem 参数 是否必选 参数类型 描述 name 是 String 参数名。 value 是 String 参数值。 elem_type 是 String 父标签类型。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instance_lts_configs Array of ChInstanceLtsConfigs objects 实例LTS配置信息。 total_count Integer 实例总数。 表5 ChInstanceLtsConfigs 参数 参数类型 描述 lts_configs Array of ChLtsConfigs objects 实例LTS配置信息。 instance instance object htap实例信息。 表6 ChLtsConfigs 参数 参数类型 描述 log_type String 日志类型。 lts_group_id String LTS日志组id。 lts_stream_id String LTS日志流id。 enabled Boolean LTS配置开关状态。 表7 instance 参数 参数类型 描述 id String ClickHouse实例ID。 name String 实例名。 mode String 实例主备状态。 engine_name String 引擎类型。 engine_version String 引擎版本。 status String 实例状态。 enterprise_project_id String 企业project id。 enterprise_project_name String 企业project名。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 Success. { "instance_lts_configs" : [ { "lts_configs" : [ { "log_type" : "slow_log", "lts_group_id" : "460d8437-9dcb-47d0-8c56-5758f2042272", "lts_stream_id" : "bad1ca5d-e347-437f-be89-f2e08ce117b8", "enabled" : false } ], "instance" : { "id" : "4c2614fe03ae4ec28184a277b8c00c03in07", "name" : "gauss-8c01", "mode" : "Cluster", "engine_name" : "clickhouse", "engine_version" : "2.0.48", "status" : "normal", "enterprise_project_id" : "0", "enterprise_project_name" : "string" } } ], "total_count" : 1}

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

URI GET /v3/{project_id}/flavors/{database_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 database_name 是 String 参数解释： 数据库引擎名称。 约束限制： 不涉及。 取值范围： gaussdb-mysql。 默认值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 availability_zone_mode 是 String 参数解释： 可用区模式。 约束限制： 不涉及。 取值范围： single：单可用区。 multi：多可用区。 默认值： 单可用区。 version_name 否 String 参数解释： 数据库版本号。 约束限制： 目前仅支持兼容MySQL 8.0。 取值范围： 8.0。 默认值： 8.0。 spec_code 否 String 参数解释： 资源规格编码。例如：gaussdb.mysql.xlarge.x86.4。 “gaussdb.mysql”代表产品。 “xlarge” 代表计算规格为4U。 “x86” 代表CPU架构为x86。 “4” 表示vCPU和内存为1:4。 更多规格说明请参考数据库实例规格。 约束限制： 不涉及。 取值范围： 不涉及。 默认值： 不涉及。

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

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 multi_tenant_switch Boolean 实例多租特性开关。 true:开启 false:关闭。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "configurations" : { "id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "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" : { "auto_increment_increment" : "1", "auto_increment_offset" : 1, "binlog_checksum" : "CRC32", "character_set_server" : "utf8", "connect_timeout" : 10, "default_authentication_plugin" : "mysql_native_password", "default_week_format" : 0, "div_precision_increment" : 4, "end_markers_in_json" : "OFF", "innodb_autoextend_increment" : 64, "innodb_autoinc_lock_mode" : 2, "innodb_concurrency_tickets" : 5000, "innodb_default_row_format" : "DYNAMIC", "innodb_flush_log_at_timeout" : 1, "innodb_flush_log_at_trx_commit" : 1, "innodb_flush_neighbors" : 0, "innodb_max_undo_log_size" : 1073741824, "innodb_optimize_fulltext_only" : "OFF", "innodb_purge_batch_size" : 300, "innodb_purge_threads" : 4, "innodb_sort_buffer_size" : 1048576, "innodb_spin_wait_delay" : 6, "innodb_status_output" : "OFF", "innodb_status_output_locks" : "OFF", "innodb_strict_mode" : "OFF", "innodb_sync_array_size" : 1, "innodb_sync_spin_loops" : 30, "innodb_thread_concurrency" : 0, "innodb_thread_sleep_delay" : 10000, "interactive_timeout" : 28800, "local_infile" : "OFF", "lock_wait_timeout" : 31536000, "log_queries_not_using_indexes" : "OFF", "log_throttle_queries_not_using_indexes" : 0, "long_query_time" : 10, "low_priority_updates" : "OFF", "max_connect_errors" : 100, "max_error_count" : 1024, "max_prepared_stmt_count" : 16382, "max_sp_recursion_depth" : 0, "max_user_connections" : 0, "max_write_lock_count" : 102400, "net_buffer_length" : 16384, "net_read_timeout" : 30, "net_retry_count" : 10, "net_write_timeout" : 60, "password_history" : 0, "password_require_current" : "OFF", "password_reuse_interval" : 0, "performance_schema" : "OFF", "profiling_history_size" : 15, "query_prealloc_size" : 8192, "read_buffer_size" : 131072, "read_rnd_buffer_size" : 262144, "show_old_temporals" : "OFF", "skip_name_resolve" : "ON", "slow_launch_time" : 2, "sql_mode" : null, "table_open_cache" : 8192, "table_open_cache_instances" : 16, "thread_cache_size" : 1024, "thread_stack" : 286720, "transaction_isolation" : "REPEATABLE-READ", "updatable_views_with_limit" : "YES", "wait_timeout" : 28800, "temptable_max_mmap" : 1073741824, "default_password_lifetime" : 0, "max_allowed_packet" : 1073741824, "binlog_expire_logs_seconds" : 3600, "max_binlog_cache_size" : 18446744073709547520, "binlog_cache_size" : 32768, "group_concat_max_len" : 1024, "max_binlog_size" : 67108864, "log_bin_trust_function_creators" : "ON", "explicit_defaults_for_timestamp" : "ON", "threadpool_stall_limit" : 50, "time_zone" : "SYSTEM", "rds_warn_max_binlog_cache_size" : 18446744073709547520, "default_collation_for_utf8mb4" : "utf8mb4_0900_ai_ci", "idle_transaction_timeout" : 0, "idle_readonly_transaction_timeout" : 0, "idle_write_transaction_timeout" : 0, "block_encryption_mode" : "aes-256-cbc", "innodb_lock_wait_timeout" : 50, "collation_server" : "utf8_general_ci", "innodb_read_ahead_threshold" : 56, "innodb_random_read_ahead" : "OFF", "eq_range_index_dive_limit" : 10, "sort_buffer_size" : 1048576, "join_buffer_size" : 524288, "range_optimizer_max_mem_size" : 16777216, "strict_status_check_RTO_time" : 30, "long_trx_decision_time" : 300, "mount_vip_when_failover" : "ON", "force_parallel_execute" : "OFF", "parallel_cost_threshold" : 1000, "parallel_default_dop" : 4, "parallel_max_threads" : 64, "parallel_memory_limit" : 104857600, "parallel_queue_timeout" : 0, "threadpool_oversubscribe" : 3, "binlog_gtid_simple_recovery" : "ON", "log_slave_updates" : "ON", "binlog_rows_query_log_events" : "OFF", "log-bin" : "ON", "gtid_mode" : "ON", "enforce_gtid_consistency" : "ON", "innodb_online_alter_log_max_size" : 134217728, "rds_sql_tracer_max_record_size" : 4096, "innodb_parallel_select_count" : "ON", "max_execution_time" : 0, "rds_sqlfilter_case_sensitive" : "OFF", "strict_status_check" : "ON", "rds_ddl_lock_wait_timeout" : 31536000 }}

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job GetJobInfoDetail object 任务信息。 表5 GetJobInfoDetail 参数 参数类型 描述 id String 参数解释： 任务ID。 取值范围： 与入参保持一致。 name String 参数解释： 任务名称。 取值范围： 不涉及。 status String 参数解释： 任务执行状态。 取值范围： Pending：表示延时任务，未执行。 Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 created String 参数解释： 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 取值范围： 不涉及。 ended String 参数解释： 结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 取值范围： 不涉及。 process String 参数解释： 任务执行进度。 取值范围： 执行中状态才返回执行进度，例如60%，否则返回""。 instance GetJobInstanceInfoDetail object 参数解释： 指定ID任务的实例信息。 entities Object 参数解释： 根据不同的任务，显示不同的内容。 fail_reason String 参数解释： 任务执行失败时的错误信息。 取值范围： 不涉及。 表6 GetJobInstanceInfoDetail 参数 参数类型 描述 id String 参数解释： 实例ID，此参数是实例的唯一标识。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 name String 参数解释： 实例名称。 取值范围： 最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "job" : { "id" : "f9959f52-aa4d-43f7-be74-44b6fc20b239", "name" : "Create GaussDB forMySQLInstance", "status" : "Completed", "created" : "2018-08-06T10:41:14+0800", "ended" : "2018-08-06T16:41:14+0000", "process" : "", "instance" : { "id" : "a48e43ff268f4c0e879652d65e63d0fbin07", "name" : "DO-NOT-TOUCH-mgr2-mysql-single" }, "entities" : { "instance" : { "endpoint" : "192.168.1.203:3306", "type" : "Cluster", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" } }, "resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ] } }}

URI GET /v3/{project_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 id 是 String 参数解释： 任务ID。 获取方法参见获取即时任务列表和获取定时任务列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认值： 不涉及。

URI GET /v3/{project_id}/project-quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 参数解释： 根据type过滤查询指定类型的配额。 约束限制: 不涉及。 取值范围： instance。 默认值： instance。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 quotas project-quotas object 参数解释： 租户实例配额信息。 表5 project-quotas 参数 参数类型 描述 resources Array of resource objects 参数解释： 资源列表对象。 表6 resource 参数 参数类型 描述 type String 参数解释： 指定类型的配额。 取值范围： instance。 used Integer 参数解释： 已创建的资源个数。 取值范围： ≥0。 quota Integer 参数解释： 资源最大的配额数。 取值范围： 实例个数配额，取值范围0~100000，-1表示无限制。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 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 Success. { "enable_ip_group" : false, "type" : "black", "ip_group" : [ { "id" : "a4217ac4-12cd-4fb3-acfc-db4a4a1896ea", "name" : "PROXY-8c72c1b6985f414da0cfbc76ad7effc1po01_elbIpGroup", "ip_list" : [ { "ip" : "192.127.0.1", "description" : "proxy ipgroup" }, { "ip" : "192.127.0.2", "description" : "proxy ipgroup" } ] } ]}

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 enable_ip_group Boolean 允许访问控制或者不允许 true | false。 type String 白名单或者黑名单 'white' | 'black' ip_group ProxyIpGroupDetail object 白名单或黑名单详细信息 表4 ProxyIpGroupDetail 参数 参数类型 描述 id String ipGroup的id name String ipGroup的名称 ip_list Array of IpGroupItem objects ipGroup内部的ip列表 表5 IpGroupItem 参数 参数类型 描述 ip String ip或者网段 description String ip的描述 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 授予数据库用户数据库读写权限。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/privilege{ "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "databases" : [ { "name" : "test", "readonly" : false } ] } ]} 授予数据库用户数据库只读权限。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/privilege{ "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "databases" : [ { "name" : "test", "readonly" : true } ] } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 users 是 Array of GrantDatabasePermission objects 数据库用户列表，列表最大长度为50。 表4 GrantDatabasePermission 参数 是否必选 参数类型 描述 name 是 String 数据库用户名。 host 是 String 主机地址。 databases 是 Array of DatabasePermission objects 数据库权限列表，列表最大长度为50。 表5 DatabasePermission 参数 是否必选 参数类型 描述 name 是 String 数据库名称。 readonly 是 Boolean 是否为只读权限： true：表示只读。 false：表示可读写。