华为云用户手册

请求参数 表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}/proxies 表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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 proxy_list Array of MysqlShowProxyResponseV3 objects 参数解释： 数据库代理信息列表。 表5 MysqlShowProxyResponseV3 参数 参数类型 描述 proxy MysqlProxyV3 object 参数解释： 数据库代理信息。 master_node MysqlProxyNodeV3 object 参数解释： 主节点信息。 readonly_nodes Array of MysqlProxyNodeV3 objects 参数解释： 只读节点信息。 表6 MysqlProxyV3 参数 参数类型 描述 pool_id String 参数解释： 数据库代理ID。 取值范围： 只能由英文字母、数字组成，后缀为po01，长度为36个字符。 status String 参数解释： 数据库代理开启状态。 取值范围： ACTIVE：表示数据库代理正常。 FAILED：表示数据库代理创建失败。 DELETED：表示数据库代理已删除。 ABNORMAL：表示数据库代理异常。 ENABLING PROXY：表示数据库代理正在开启。 DISABLING PROXY：表示数据库代理正在关闭。 ADDING PROXY NODE：表示数据库代理正在扩容。 DELETING READ REPLICAS FROM PROXY：表示数据库代理正在移除只读节点。 ADDING READ REPLICAS TO PROXY：表示数据库代理正在添加只读节点。 CHANGING WEIGHTS：表示数据库代理正在修改只读节点权重。 address String 参数解释： 数据库代理读写分离地址。 取值范围： 不涉及。 port Integer 参数解释： 数据库代理端口信息。 取值范围： 不涉及。 pool_status String 参数解释： 数据库代理状态。 取值范围： ACTIVE：表示数据库代理正常。 ABNORMAL：表示数据库代理异常。 FAILED：表示数据库代理创建失败。 DELETED：表示数据库代理已删除。 delay_threshold_in_seconds Integer 参数解释： 延时阈值，单位：秒。 取值范围： 不涉及。 elb_vip String 参数解释： Elb模式的虚拟IP信息。 取值范围： 不涉及。 eip String 参数解释： 弹性公网IP地址信息。 取值范围： 不涉及。 vcpus String 参数解释： 数据库代理规格的CPU数量。 取值范围： 不涉及。 ram String 参数解释： 数据库代理规格的内存数量。 取值范围： 不涉及。 node_num Integer 参数解释： 数据库代理节点个数。 取值范围： 不涉及。 mode String 参数解释： 数据库代理主备模式。 取值范围： Cluster。 nodes Array of MysqlProxyNodes objects 参数解释： 数据库代理节点信息。 flavor_ref String 参数解释： 数据库代理规格信息。 取值范围： 不涉及。 name String 参数解释： 数据库代理名称。 取值范围： 不涉及。 transaction_split String 参数解释： 数据库代理事务拆分开关状态。 取值范围： true：开启。 false：关闭。 connection_pool_type String 参数解释： 连接池类型。 取值范围: CLOSED: 关闭连接池。 SESSION: 开启会话级连接池。 switch_connection_pool_type_enabled Boolean 参数解释： 数据库代理版本是否支持会话级连接池。 取值范围: true: 支持。 false: 不支持。 route_mode Integer 参数解释： 数据库代理路由模式。 取值范围： 0：表示权重负载模式。 1：表示负载均衡模式（数据库主节点不接受读请求）。 2：表示负载均衡模式（数据库主节点接受读请求）。 balance_route_mode_enabled Boolean 参数解释： 数据库代理版本是否支持负载均衡模式。 取值范围： true 支持。 false 不支持。 consistence_mode String 参数解释： 一致性模式。默认值为空，此时以会话一致性参数session_consistence的值为准。 取值范围： session：会话一致性（当session_consistence为true时，只能取该值）。 global：全局一致性（当session_consistence为false时，可取该值）。 eventual：最终一致性（当session_consistence为false时，可取该值）。 subnet_id String 参数解释： 数据库代理所属的子网ID。 取值范围： 不涉及。 ssl_option String 参数解释： SSL 数据加密 开关设置。 取值范围： true：开启SSL数据加密。 false：关闭SSL数据加密。 new_node_auto_add_status String 参数解释： 新增节点是否自动加入该数据库代理。 取值范围： ON：自动加入。 OFF：不自动加入。 new_node_weight Integer 参数解释： 新增节点的读权重。 取值范围： 1-1000。 表7 MysqlProxyNodes 参数 参数类型 描述 id String 数据库代理节点ID。 status String 参数解释： 数据库代理节点状态。 取值范围： ACTIVE：表示节点正常。 ABNORMAL：表示节点异常。 FAILED：表示节点失败。 DELETED：表示节点已删除。 name String 参数解释： 数据库代理节点名称。 取值范围： 不涉及。 role String 参数解释： 数据库代理节点角色。 取值范围： master：主节点。 slave：只读节点。 az_code String 参数解释 可用区。 取值范围： 不涉及。 frozen_flag Integer 参数解释： 数据库代理节点是否被冻结。 取值范围： 0：未冻结。 1：冻结。 2：冻结删除。 表8 MysqlProxyNodeV3 参数 参数类型 描述 id String 参数解释： 数据库代理节点ID。 取值范围： 只能由英文字母、数字组成，后缀为no07，长度为36个字符。 instance_id String 参数解释： 实例ID，此参数是实例的唯一标识。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 status String 参数解释： 节点状态。 取值范围： ACTIVE：表示节点正常。 ABNORMAL：表示节点异常。 FAILED：表示节点失败。 DELETED：表示节点已删除。 name String 参数解释： 节点名称。 取值范围： 不涉及。 weight Integer 参数解释： 节点读写分离读权重。 取值范围： 1-1000。 availability_zone Array of MysqlProxyAvailable objects 参数解释： 可用区信息。 表9 MysqlProxyAvailable 参数 参数类型 描述 code String 参数解释： 可用区编码。 取值范围： 不涉及。 description String 参数解释： 可用区描述。 取值范围： 不涉及。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /mysql/v3/{project_id}/flavors/{database_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 database_name 是 String 数据库引擎名称。 表2 Query参数 参数 是否必选 参数类型 描述 version_name 否 String 数据库版本号，目前仅支持兼容MySQL 8.0。 availability_zone_mode 是 String 规格的可用区模式，现在仅支持"single"、"multi"，不区分大小写。 spec_code 否 String 规格编码。

响应示例 状态码： 200 Success. { "flavors" : [ { "type" : "x86", "vcpus" : "1", "ram" : "4", "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "spec_code" : "gaussdb.mysql.xlarge.x86.4", "instance_mode" : "Cluster", "version_name" : "8.0", "az_status" : { "cn-north-4a" : "normal", "cn-north-4b" : "normal" } } ]}

请求示例 GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800

响应示例 状态码： 200 Success. { "backups" : [ { "id" : "1fe4feaab48f11e6654hfa163eba87e4b66u", "name" : " GaussDB forMySQL-gauss-e747-20200705185048266", "begin_time" : "2018-08-06T12:41:14+0800", "end_time" : "2018-08-06T12:43:14+0800", "take_up_time" : 2, "status" : "COMPLETED", "type" : "auto", "size" : 2803, "datastore" : { "type" : "GaussDB(for MySQL）", "version" : "8.0" }, "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01", "backup_level" : "2" } ], "total_count" : 1}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backups Array of backups objects 备份信息。 total_count Number 备份文件的总数。 表5 backups 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 begin_time String 备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 备份结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 status Object 备份状态 枚举值： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 AVAILABLE：备份可用。 take_up_time Integer 备份花费时间(单位：minutes) type Object 备份类型 枚举值： auto：自动全量备份。 manual：手动全量备份。 size Number 备份大小，(单位：MB) datastore MysqlDatastore object 数据库信息。 instance_id String 实例ID。 backup_level Object 备份级别。当开启一级备份开关时，返回该参数。 枚举值： 0：备份正在创建中或者备份失败。 1：一级备份。 2：二级备份。 description String 备份文件描述信息 表6 MysqlDatastore 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql version String 数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /mysql/v3/{project_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 实例ID。 backup_id 否 String 备份ID。 backup_type 否 String 备份类型，取值： "auto"：自动全量备份 "manual"：手动全量备份 offset 否 String 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 String 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 begin_time 否 String 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time 否 String 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

响应示例 状态码： 200 Success. { "instance" : { "id" : "d738399de028480fabb2b8120d4e01a4in07", "name" : "gaussdb-mysql-instance01", "alias" : "", "status" : "ACTIVE", "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" : "ACTIVE", "port" : 3306, "private_read_ips" : [ "192.168.0.163" ], "volume" : { "type" : "POOL", "used" : 0.07 }, "az_code" : "cn-north-4b", "region_code" : "cn-north-4", "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" : "ACTIVE", "port" : 3306, "private_read_ips" : [ "192.168.0.162" ], "volume" : { "type" : "POOL", "used" : 0.07 }, "az_code" : "cn-north-4b", "region_code" : "cn-north-4", "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" : "cn-north-4b", "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 MysqlInstanceInfoDetail object 实例信息。 表4 MysqlInstanceInfoDetail 参数 参数类型 描述 id String 实例ID，严格匹配UUID规则。 name String 创建的实例名称。 project_id String 租户在某一Region下的project ID。 status String 实例状态。 取值： BUILD：表示实例正在创建。 ACTIVE：表示实例正常。 FAILED：表示实例创建失败。 FROZEN：表示实例冻结。 MODIFYING：表示实例正在扩容。 REBOOTING：表示实例正在重启。 RESTORING：表示实例正在恢复。 SWITCHOVER：表示实例正在主备切换。 MIGRATING：表示实例正在迁移。 BACKING UP：表示实例正在进行备份。 MODIFYING DATABASE PORT：表示实例正在修改数据库端口。 STORAGE FULL：表示实例磁盘空间满。 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 数据库代理信息。 表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读写分离地址。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result 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参数 参数 是否必选 参数类型 描述 user_name 是 String 数据库账号名。 password 是 String 数据库账号密码。 8-32个字符 至少包含以下字符中的三种：大写字母、小写字母、数字和特殊字符~！@#%^*-_=+?, 不能与用户名或倒序的用户名相同

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

请求示例 修改数据库账户密码。 PUT https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/users/password{ "user_name" : "user_test0", "password" : "Clickhouse_1234"}

请求示例 修改数据同步白名单。 PUT https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/databases/replication/config{ "source_instance_id" : "5a377c0073cd4264be308fd968e60312in07", "source_node_id" : "", "database" : "db1", "value" : "{\"white_list\":\"t1,t2,t3\"}"}

URI PUT /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 请求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，严格匹配UUID规则。 source_node_id 否 String 源实例节点ID。 database 是 String 数据库名。 value 是 String 配置值。仅支持修改同步范围，不支持修改白名单或黑名单类型。 例如：创建了白名单数据同步，调用本接口修改时， 支持 "value"："{"white_list":"test1,test2,test3"}" 不支持 "value"："{"black_list":"test1,test2,test3"}"

响应参数 状态码： 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 表3 响应Body参数 参数 参数类型 描述 recycle_policy RecyclePolicy object 回收站策略。 表4 RecyclePolicy 参数 参数类型 描述 retention_period_in_days String 保留天数，1-7天。 状态码： 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值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 语言。

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 proxy_flavor_groups Array of MysqlProxyFlavorGroups objects 规格组信息。 表4 MysqlProxyFlavorGroups 参数 参数类型 描述 group_type String 规格组类型，如x86、arm。 proxy_flavors Array of MysqlProxyComputeFlavor objects 规格信息。 表5 MysqlProxyComputeFlavor 参数 参数类型 描述 vcpus String CPU大小。例如：1表示1U。 ram String 内存大小，单位为GB。 db_type String 数据库类型。 id String 数据库代理规格ID。 spec_code String 数据库代理规格码。 az_status Object 其中key是可用区编号，value是规格所在AZ的状态。 状态码： 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参数 参数 是否必选 参数类型 描述 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规则。

响应参数 状态码： 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}

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 表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 错误消息。