华为云用户手册

响应示例 状态码： 200 Success. { "proxy_flavor_groups" : [ { "group_type" : "X86", "proxy_flavors" : [ { "id" : "19be4c5d-d363-3342-bdbc-0dd9dbf7fafe", "spec_code" : "gaussdb.proxy.large.x86.2", "vcpus" : 2, "ram" : 4, "db_type" : "Proxy", "az_status" : { "az1" : "normal" } } ] } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 node_num 是 Integer 数据库代理节点缩容操作需要减少的节点数。 缩容的节点数的取值范围：1~14之间的整数。 限制条件：该实例的数据库代理节点的总数量小于等于16，大于等于2。

响应参数 状态码： 201 表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 PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/reduce 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 proxy_id 是 String 数据库代理ID，严格匹配UUID规则。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 user_details Array of user_details objects 数据库账户信息。 total_count Integer 数据库账户数量。 表5 user_details 参数 参数类型 描述 user_name String 数据库账户名。 data_bases Array of strings 已授权数据库。 dml Integer DML授权。 0：读写权限 1：只读权限 2：只读和设置权限 3：读写和设置权限 ddl Integer DDL授权。 0：无DDL权限 1：有DDL权限 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 Success. { "user_details" : [ { "user_name" : "root", "data_bases" : [ "*" ], "dml" : 2, "ddl" : 0 }, { "user_name" : "user_test", "data_bases" : [ "*" ], "dml" : 2, "ddl" : 0 } ], "total_count" : 2}

请求参数 表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 表3 请求Body参数 参数 是否必选 参数类型 描述 status 是 String 自动变配开关状态。 取值： ON：开启。 OFF：关闭。 scaling_strategy 是 ScalingStrategyReqInfo object 自动变配策略。 monitor_cycle 否 Integer 监测周期（单位：秒）。 在整个观测窗口期内，若CPU平均使用率大于等于设定值，则在观测窗口结束后，进行扩容。 取值范围：300、600、900、1800。 status为ON时必填。 silence_cycle 否 Integer 静默周期（单位：秒）。 两次自动扩容或自动回缩的最小间隔时间。 取值范围：300、600、1800、3600、7200、10800、86400、604800。 status为ON时必填。 enlarge_threshold 否 Integer CPU平均使用率（百分比数值）。 取值范围：50-100。 status为ON时必填。 max_flavor 否 String 扩容规格上限。开启扩缩规格时必填。 reduce_enabled 否 Boolean 是否开启自动回缩。开启自动变配时必填。 true：是。 false：否。 max_read_only_count 否 Integer 只读节点数量上限。开启增删只读节点时必填。 read_only_weight 否 Integer 只读节点读写分离权重。开启增删只读节点时必填。 表4 ScalingStrategyReqInfo 参数 是否必选 参数类型 描述 flavor_switch 是 String 扩缩规格开关。 ON：开启。 OFF：关闭。 read_only_switch 是 String 增删只读节点开关。自动增删只读节点功能需要先开启数据库代理，且只能有一个代理。 ON：开启。 OFF：关闭。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称。 switch_status AutoScalingSwitchStatus object 开关状态。 表6 AutoScalingSwitchStatus 参数 参数类型 描述 scaling_switch String 自动变配开关状态。 取值： ON：开启。 OFF：关闭。 flavor_switch String 扩缩规格开关状态。 取值： ON：开启。 OFF：关闭。 read_only_switch String 增删只读节点开关状态。 取值： ON：开启。 OFF：关闭。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 设置自动变配。 PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/auto-scaling/policy{ "enlarge_threshold" : 50, "max_flavor" : "gaussdb.mysql.large.x86.4", "max_read_only_count" : 2, "monitor_cycle" : 300, "read_only_weight" : 10, "reduce_enabled" : false, "scaling_strategy" : { "flavor_switch" : "ON", "read_only_switch" : "ON" }, "silence_cycle" : 300, "status" : "ON"}

响应示例 状态码： 200 Success. { "instance_id" : "61a4ea66210545909d74a05c27a7179ein07", "instance_name" : "gauss-test-1", "switch_status" : { "scaling_switch" : "ON", "flavor_switch" : "ON", "read_only_switch" : "ON" }}

请求示例 修改数据库备注。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases/comment{ "databases" : [ { "name" : "gaussdb_mysql_user1", "comment" : "first_database" } ]}

响应参数 状态码： 202 表5 响应Body参数 参数 参数类型 描述 job_id String 修改数据库备注的任务ID。 状态码： 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参数 参数 是否必选 参数类型 描述 alias 是 String 实例备注。 长度可在0~64个字符之间，由字母、数字、汉字、英文句号、下划线、中划线组成。

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

响应参数 状态码： 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参数 参数 是否必选 参数类型 描述 port 是 Integer 端口号。 TaurusDB端口号范围：大于等于1024，小于等于65535，不包含端口5342-5345、12017、20000、20201、20202、33062、33071。

响应参数 状态码： 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 表5 响应Body参数 参数 参数类型 描述 quota_list Array of setQuota objects 资源列表对象。 表6 setQuota 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 instance_quota Integer 实例个数配额。取值范围0~100000。(如果已经存在实例，应该大于已经存在的实例个数) vcpus_quota Integer CPU核数配额。取值范围0~2147483646。(如果已经存在实例，应该大于已经占用的cpu个数) ram_quota Integer 内存使用配额，单位为GB。取值范围0~2147483646。(如果已经存在实例，应该大于已经占用的内存数) 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 修改指定企业项目的资源配额。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas{ "quota_list" : [ { "enterprise_project_id" : "0", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40 } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 quota_list 是 Array of setQuota objects 资源列表对象。 表4 setQuota 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 instance_quota 否 Integer 实例个数配额。取值范围0~100000。(如果已经存在实例，应该大于已经存在的实例个数) vcpus_quota 否 Integer CPU核数配额。取值范围0~2147483646。(如果已经存在实例，应该大于已经占用的cpu个数) ram_quota 否 Integer 内存使用配额，单位为GB。取值范围0~2147483646。(如果已经存在实例，应该大于已经占用的内存数)

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

终端节点 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同。TaurusDB服务提供的终端节点信息如表1所示。 表1 TaurusDB终端节点信息 产品名称 区 域名 称 区域 终端节点（Endpoint） 协议类型 云数据库 TaurusDB 华北-北京四 cn-north-4 gaussdb.cn-north-4.myhuaweicloud.com HTTPS 云数据库 TaurusDB 华北-乌兰察布一 cn-north-9 gaussdb.cn-north-9.myhuaweicloud.com HTTPS 云数据库 TaurusDB 华东-上海一 cn-east-3 gaussdb.cn-east-3.myhuaweicloud.com HTTPS 云数据库 TaurusDB 华南-广州 cn-south-1 gaussdb.cn-south-1.myhuaweicloud.com HTTPS 云数据库 TaurusDB 华南-广州-友好用户环境 cn-south-4 gaussdb.cn-south-4.myhuaweicloud.com HTTPS 云数据库 TaurusDB 土耳其-伊斯坦布尔 tr-west-1 gaussdbformysql.tr-west-1.myhuaweicloud.com HTTPS 云数据库 TaurusDB 西南-贵阳一 cn-southwest-2 gaussdb.cn-southwest-2.myhuaweicloud.com HTTPS 云数据库 TaurusDB 亚太-新加坡 ap-southeast-3 gaussdb.ap-southeast-3.myhuaweicloud.com HTTPS 云数据库 TaurusDB 亚太-曼谷 ap-southeast-2 gaussdbformysql.ap-southeast-2.myhuaweicloud.com HTTPS 云数据库 TaurusDB 亚太-雅加达 ap-southeast-4 gaussdb.ap-southeast-4.myhuaweicloud.com HTTPS 云数据库 TaurusDB 华北-北京二 cn-north-2 gaussdb.cn-north-2.myhuaweicloud.com HTTPS 云数据库 TaurusDB 中国-香港 ap-southeast-1 gaussdbformysql.ap-southeast-1.myhuaweicloud.com HTTPS 云数据库 TaurusDB 拉美-圣保罗一 sa-brazil-1 gaussdb.sa-brazil-1.myhuaweicloud.com HTTPS 云数据库 TaurusDB 俄罗斯-莫斯科二 ru-northwest-2 gaussdb.ru-northwest-2.myhuaweicloud.com HTTPS 云数据库 TaurusDB 非洲-约翰内斯堡 af-south-1 gaussdb-mysql.af-south-1.myhuaweicloud.com HTTPS 云数据库 TaurusDB 乌兰察布-汽车一 cn-north-11 gaussdbformysql.cn-north-11.myhuaweicloud.com HTTPS 云数据库 TaurusDB 中东-利雅得 me-east-1 gaussdb-mysql.me-east-1.myhuaweicloud.com HTTPS 云数据库 TaurusDB 华北-乌兰察布二零一 cn-north-5 gaussdbformysql.cn-north-5.myhuaweicloud.com HTTPS 父主题： 使用前必读

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 update_result Array of ProxyUpgradeVersionDetail objects 数据库代理升级信息列表。 表5 ProxyUpgradeVersionDetail 参数 参数类型 描述 instance_id String 实例id. workflow_id String 工作流Id。 state String 返回状态。 error_message String 错误消息。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 升级数据库代理实例内核版本。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/517ea793ab91438cbfcd9c4b1c958b1ein07/proxy/0f46fc46396e4fb19a0cb52f578e9511po01/upgrade-version{ "source_version" : "2.23.12.000", "target_version" : "2.24.03.000"}

响应示例 状态码： 200 Success. { "update_result" : [ { "workflow_id" : "375ac6a4-2788-4e45-83bf-8a9d2324317f", "state" : "ACCEPT", "error_message" : null }, { "workflow_id" : "375ac6a4-2788-4e45-83be-8a9d2324327f", "state" : "REJECT", "error_message" : "Upgrade failed due to insufficient subnet ip" } ]}

请求参数 表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 目标升级内核版本号

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规则。

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

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