华为云用户手册

URI POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/upgrade-version 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 proxy_id 是 String 数据库代理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参数 参数 是否必选 参数类型 描述 source_version 是 String 升级前源内核版本号 target_version 是 String 目标升级内核版本号

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 开启/关闭SQL限流任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 开启SQL限流。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch{ "switch_status" : "ON"} 关闭SQL限流。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch{ "switch_status" : "OFF"}

请求参数 表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：表示关闭。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 datastores Array of MysqlEngineVersionInfo objects 数据库版本信息列表 表4 MysqlEngineVersionInfo 参数 参数类型 描述 id String 数据库版本ID，该字段不会有重复。 name String 数据库版本号，只返回两位数的大版本号。 kernel_version String 数据库内核版本号，返回完整的四位版本号。 version String 兼容的开源数据库版本号，返回三位开源版本号。 状态码： 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参数 参数 是否必选 参数类型 描述 resize_flavor 是 MysqlResizeFlavor object 规格变更信息。 is_auto_pay 否 String 变更包年/包月实例规格时可指定，表示是否自动从客户的账户中支付。 true：为自动支付，默认该方式。 false：为手动支付。 表4 MysqlResizeFlavor 参数 是否必选 参数类型 描述 spec_code 是 String 规格码。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 job_id String 规格变更的任务ID，仅变更按需实例时会返回该参数。 order_id String 订单ID，仅变更包年/包月实例时会返回该参数。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 变更实例的内存规格为4U32GB。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action{ "resize_flavor" : { "spec_code" : "gaussdb.mysql.xlarge.arm.4" }}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_ids Array of strings 任务ID，表示成功取消定时调度任务的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参数 参数 是否必选 参数类型 描述 job_ids 是 Array of strings 任务ID。

概述 云数据库 TaurusDB是华为自研的最新一代企业级高扩展海量存储云原生数据库，完全兼容MySQL。基于华为最新一代DFV存储，采用计算存储分离架构，128TB的海量存储，数据0丢失，既拥有商业数据库的高可用和性能，又具备开源低成本效益。 DFV（Data Function Virtualization）是一个与数据库垂直整合的高性能，高可靠的分布式存储系统。存储集群采取池化部署，可以有效提升存储使用效率。 您可以使用本文档提供API对数据库实例进行相关操作。支持的全部操作请参见API概览。 父主题： 使用前必读

请求示例 修改备份策略 PUT https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/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 instance_name String 实例名称 状态码： 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。 通过调用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 备份文件的保留天数。 period 是 String 备份周期配置。自动备份将在每星期指定的天进行。取值范围：格式为逗号隔开的数字，数字代表星期。取值示例：1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。 retention_num_backup_level1 否 Integer 1级备份保留数量，默认值为0。当一级备份开关开启时，该参数值有效。取值：0或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参数 参数 是否必选 参数类型 描述 monitor_switch 是 Boolean 实例秒级监控开关。 true：开启。 false：关闭。 period 否 Integer 采集周期，仅在monitor_switch为true时生效。默认为5s。monitor_switch为false时，不传该参数。取值： 1：采集周期为1s。 5：采集周期为5s。

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

请求示例 修改实例秒级监控开关及频率，开启秒级监控，采集周期为1s。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy{ "monitor_switch" : true, "period" : 1} 修改实例秒级监控开关，关闭秒级监控。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy{ "monitor_switch" : false}

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 flavor_ref 是 String 代理规格码。 获取方法请参见查询数据库代理规格信息 node_num 是 Integer 代理实例节点数，取值整数2-32。

响应参数 状态码： 202 表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}/starrocks/databases/replication 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String StarRocks实例ID，严格匹配UUID规则。

响应参数 状态码： 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参数 参数 是否必选 参数类型 描述 task_name 否 String 数据同步任务名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。

请求参数 表3 请求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

响应示例 状态码： 200 Success. { "storage_type" : [ { "name" : "ULTRAHIGH", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "normal" }, "min_volume_size" : 50 }, { "name" : "ESSD", "az_status" : { "cn-southwest-244d" : "unsupported", "cn-southwest-244c" : "unsupported", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "normal" }, "min_volume_size" : 40 } ]} 状态码： 400 Client error. { "error_msg" : "The DB engine or version is not supported.", "error_code" : "DBS.280238"}

URI GET /v3/{project_id}/htap/storage-type/{database} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 database 是 String HTAP数据库名。 取值范围： star-rocks click-house 表2 Query参数 参数 是否必选 参数类型 描述 version_name 是 String 数据库大版本号

响应示例 状态码： 200 Success. { "flavors" : [ { "type" : "x86", "vcpus" : "4", "ram" : "16", "id" : "de565db8-0a96-37ea-9388-61167624712c", "spec_code" : "gaussdb.sr-be.xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "4", "ram" : "16", "id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a", "spec_code" : "gaussdb.sr-fe.xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "8", "ram" : "32", "id" : "c50e8e15-f2fc-3b40-aca6-c98f07ce2ce0", "spec_code" : "gaussdb.sr-be.2xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "8", "ram" : "32", "id" : "24059750-4280-3ee5-a44b-488b924633b4", "spec_code" : "gaussdb.sr-fe.2xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "16", "ram" : "64", "id" : "a48c63dc-5563-3813-9e13-39d3301e56f4", "spec_code" : "gaussdb.sr-be.4xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "16", "ram" : "64", "id" : "0ef44c01-f7a1-30f5-9f05-9e47094e8c1f", "spec_code" : "gaussdb.sr-fe.4xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "32", "ram" : "128", "id" : "2bf6aa50-50da-3f27-91af-a8c873070537", "spec_code" : "gaussdb.sr-fe.8xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "normal" } }, { "type" : "x86", "vcpus" : "32", "ram" : "128", "id" : "9f52a065-aa93-371a-9975-959fedf6e24f", "spec_code" : "gaussdb.sr-be.8xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "normal" } }, { "type" : "x86", "vcpus" : "64", "ram" : "256", "id" : "709822e4-567f-3e85-b4af-cb099206c8e2", "spec_code" : "gaussdb.sr-fe.16xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "64", "ram" : "256", "id" : "4e56e208-0226-34bb-b84d-035ab0497824", "spec_code" : "gaussdb.sr-be.16xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } } ]} 状态码： 400 Client error. { "error_msg" : "Invalid specification code.", "error_code" : "DBS.280434"}

请求参数 表3 请求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}/htap/flavors/{engine_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 engine_name 是 String HTAP引擎名。 取值范围： star-rocks click-house 表2 Query参数 参数 是否必选 参数类型 描述 availability_zone_mode 否 String 可用区模式，当前仅支持single。 spec_code 否 String 规格码，提供后仅查询指定规格码规格信息。 version_name 否 String 数据库版本号，不填默认3.1.6.0。