华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Integer HTAP实例个数。 instances Array of instances objects HTAP实例信息。 max_htap_instance_num_of_taurus Integer 最大HTAP实例个数。 表4 instances 参数 参数类型 描述 id String HTAP实例ID，严格匹配UUID规则。 name String HTAP实例名。 engine_name String HTAP数据库引擎名。 engine_version String HTAP数据库引擎版本。 project_id String 租户在某一region下的project ID instance_state instance_state object HTAP实例状态信息。 create_at Long HTAP实例创建时间。 is_frozen Boolean HTAP实例是否冻结。 ha_mode String HTAP实例部署模式。 pay_model String 计费模式。当前仅支持按需计费。 0：按需计费 1：包周期 order_id String 包周期计费订单ID。 alter_order_id String 包周期计费备用订单ID。 data_vip String 读写内网地址。 readable_node_infos Array of ReadableNodeInfos objects 可读节点信息 proxy_ips Array of strings 代理IP。 data_vip_v6 String 读写内网地址IPV6。 port Integer 数据库访问端口。 available_zones Array of available_zones objects 可用区信息。 current_actions Array of QueryAction objects 实例动作。 volume_type String 存储类型。 server_type String 服务器类型。 enterprise_project_id String 企业项目ID。如果账户开通企业项目服务则该参数必选，未开启该参数不可选。 dedicated_resource_id String 专属资源池ID，只有开通专属资源池后才支持此参数。 network network object 网络信息。 ch_master_node_id String ClickHouse主节点ID。 node_num Integer 节点个数。 表5 instance_state 参数 参数类型 描述 instance_status String HTAP实例状态。 create_fail_error_code String HTAP实例创建失败错误码。 fail_message String HTAP实例创建失败错误信息。 wait_restart_for_params Boolean 是否需要重启更新参数。 表6 ReadableNodeInfos 参数 参数类型 描述 data_ip String 可读节点IP。 node_id String 可读节点ID。 node_name String 可读节点名称。 表7 available_zones 参数 参数类型 描述 code String 可用区码。 description String 可用区描述。 az_type String 可用区类型。 表8 QueryAction 参数 参数类型 描述 id String 实例或节点动作ID。 action String 实例或节点动作名称。 object_id String 实例或节点动作对象ID。 type String 实例或节点动作类型。 job_id String 实例或节点动作任务ID。 status String 实例或节点动作状态。 created_at Long 实例或节点动作创建时间。 updated_at Long 实例或节点动作更新时间。 表9 network 参数 参数类型 描述 vpc_id String 虚拟私有云ID。 sub_net_id String 子网ID。 security_group_id String 安全组ID。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表11 响应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 请求语言类型。默认en-us。 取值范围： en-us zh-cn

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 configurations ConfigurationSummary2 object 参数模板信息。 表6 ConfigurationSummary2 参数 参数类型 描述 id String 参数组ID。 name String 参数组名称。 description String 参数组描述。 datastore DatastoreResult object 数据库对象。 created String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量。 updated String 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量。 表7 DatastoreResult 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql。 version String 数据库版本。数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "configurations" : { "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", "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" } }

请求示例 创建参数模板，账户允许最大同时连接数为10。 POST https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/configurations { "name" : "myparameter", "description" : "parameter1", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "parameter_values" : { "max_user_connections" : "10" } }

请求示例 创建计费模式为按需计费，自动备份开始时间是08:00-09:00的实例。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances { "name" : "gaussdb-mysql-instance1", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "postPaid" }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "mode" : "Cluster", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "password" : "***", "backup_strategy" : { "start_time" : "08:00-09:00" }, "availability_zone_mode" : "single", "slave_count" : 1, "enterprise_project_id" : 0 } 将备份文件恢复到按需计费的新实例。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances { "name" : "gaussdb-mysql-instance2", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "postPaid" }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "mode" : "Cluster", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "password" : "***", "backup_strategy" : { "start_time" : "08:00-09:00" }, "availability_zone_mode" : "single", "slave_count" : 1, "enterprise_project_id" : 0, "restore_point" : { "source_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07", "backup_id" : "7ffbf305376b4cbea0ae491257b6aaf9br07", "type" : "backup" } } 按时间点恢复到按需计费的新实例。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances { "name" : "gaussdb-mysql-instance3", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "postPaid" }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "mode" : "Cluster", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "password" : "***", "backup_strategy" : { "start_time" : "08:00-09:00" }, "availability_zone_mode" : "single", "slave_count" : 1, "enterprise_project_id" : 0, "restore_point" : { "source_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07", "restore_time" : 1673852043000, "type" : "timestamp" } } 创建周期为一个月的包年/包月实例。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances { "name" : "gaussdb-mysql-instance4", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "prePaid", "period_type" : "month", "period_num" : 1, "is_auto_renew" : false, "is_auto_pay" : true }, "volume" : { "size" : 10 }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "mode" : "Cluster", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "password" : "***", "backup_strategy" : { "start_time" : "08:00-09:00" }, "availability_zone_mode" : "single", "slave_count" : 1, "enterprise_project_id" : 0, "restore_point" : { "source_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07", "restore_time" : 1673852043000, "type" : "timestamp" } }

响应示例 状态码： 201 Success. 创建按需实例。 { "instance" : { "id" : "5eebbb4c0f9f4a99b42ed1b6334569aain07", "name" : "gaussdb-mysql-instance1", "status" : "BUILD", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "postPaid" }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0", "kernel_version" : "2.0.28.18" }, "mode" : "Cluster", "port" : 3306, "enterprise_project_id" : 0, "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "backup_strategy" : { "start_time" : "08:00-09:00", "keep_days" : 7 }, "availability_zone_mode" : "single" }, "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" } 创建周期为一个月的包年/包月实例。 { "instance" : { "id" : "945419c2208e4a5d828b8dddc00223e1in07", "name" : "gaussdb-mysql-instance4", "status" : "BUILD", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "prePaid", "period_type" : "month", "period_num" : 1, "is_auto_renew" : false, "is_auto_pay" : true }, "volume" : { "size" : 10 }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0", "kernel_version" : "2.0.28.18" }, "mode" : "Cluster", "port" : 3306, "enterprise_project_id" : 0, "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "backup_strategy" : { "start_time" : "08:00-09:00", "keep_days" : 7 }, "availability_zone_mode" : "single" }, "order_id" : " CS 2308241236EEXVF" }

响应参数 状态码： 201 表11 响应Body参数 参数 参数类型 描述 instance MysqlInstanceResponse object 实例信息 job_id String 实例创建的任务ID。 仅创建按需实例时会返回该参数。 order_id String 订单号，创建包年包月时返回该参数。 表12 MysqlInstanceResponse 参数 参数类型 描述 id String 实例ID，严格匹配UUID规则。 name String 实例名称。用于表示实例的名称。 status String 实例状态。 datastore MysqlDatastoreInRes object 数据库信息。 mode String 实例类型，仅支持Cluster。 configuration_id String 参数组ID。 port String 数据库端口信息。 backup_strategy MysqlBackupStrategy object 自动备份策略。 enterprise_project_id String 企业项目ID。 region String 区域ID，与请求参数相同。 availability_zone_mode String 可用区模式，与请求参数相同。 master_availability_zone String 主可用区ID。 vpc_id String 虚拟私有云ID，与请求参数相同。 security_group_id String 安全组ID，与请求参数相同。 subnet_id String 子网ID，与请求参数相同。 flavor_ref String 规格码，与请求参数相同。 charge_info MysqlChargeInfo object 计费类型信息，支持包年包月和按需，默认为按需。 volume MysqlVolumeResp object volume信息。创建包年/包月实例有返回。 表13 MysqlDatastoreInRes 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql。 version String 数据库版本。 kernel_version String 内核数据库版本。 表14 MysqlBackupStrategy 参数 参数类型 描述 start_time String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 keep_days String 自动备份保留天数，取值范围：1-732。 表15 MysqlChargeInfo 参数 参数类型 描述 charge_mode String 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type String 订购周期类型。 取值范围： month：包月。 year：包年。 说明：“charge_mode”为“prePaid”时生效，且为必选值。 period_num Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： “period_type”为“month”时，取值为1~9。 “period_type”为“year”时，取值为1~3。 is_auto_renew String 创建包年/包月实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true：为自动续订。 false：为不自动续订，默认该方式。 is_auto_pay String 创建包年/包月实例时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true：为自动支付，默认该方式。 false：为手动支付。 表16 MysqlVolumeResp 参数 参数类型 描述 size Integer 磁盘大小。单位GB。 取值范围：10~128000，为10的整数倍。 状态码： 400 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表18 响应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参数 参数 是否必选 参数类型 描述 region 是 String 区域ID。 name 是 String 实例名称。用于表示实例的名称，同一租户下，同类型的实例名可重名。 取值范围：最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。 datastore 是 MysqlDatastoreInReq object 数据库信息。 mode 是 String 实例类型，目前仅支持Cluster。 flavor_ref 是 String 规格码。使用可参考查询数据库规格响应消息表5中的“spec_code”。 vpc_id 是 String 虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 subnet_id 是 String 子网的网络ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 password 是 String 数据库密码。 取值范围：至少包含以下字符的三种：大小写字母、数字和特殊符号|.~!@#$%^*-_=+?,()&，长度8~32个字符。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您输入弱密码，系统会自动判定密码非法。 availability_zone_mode 是 String 可用区类型。 取值范围： single：单可用区。 multi：多可用区。 slave_count 是 Integer 只读节点个数。单次接口调用最多支持创建9个只读节点。 charge_info 是 MysqlChargeInfo object 计费类型信息，支持包年包月和按需，默认为按需。 说明：DeC专属云账号不支持创建包年/包月实例。 security_group_id 否 String 安全组ID。如果实例所选用的子网开启网络ACL进行访问控制，则该参数非必选。如果未开启ACL进行访问控制，则该参数必选。获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。 configuration_id 否 String 参数模板ID。使用可参考查询参数模板中响应消息表5的“id”。 backup_strategy 是 MysqlBackupStrategy object 自动备份策略。 time_zone 否 String 时区。默认时区为UTC。 master_availability_zone 否 String 主可用区ID，创建单可用区实例选填，多可用区实例必填，请参考地区和终端节点。 volume 否 MysqlVolume object volume信息。创建包年/包月实例可选。创建按需实例时不可选。 tags 否 Array of MysqlTags objects 标签列表，根据标签键值对创建实例。 {key}表示标签键，不可以为空或重复。 {value}表示标签值，可以为空。 如果创建实例时同时使用多个标签键值对，中间使用逗号分隔开，最多包含10组。 lower_case_table_names 否 Integer 表名大小写是否敏感，默认值是1。 取值范围： 0：表名被存储成固定且表名称大小写敏感。 1：表名将被存储成小写且表名称大小写不敏感。 enterprise_project_id 否 String 企业项目ID。如果账户开通企业项目服务则该参数必选，未开启该参数不可选。 dedicated_resource_id 否 String 专属资源池ID，只有开通专属资源池后才支持此参数。 restore_point 否 MysqlRestorePoint object 备份恢复信息。 tde_info 否 MysqlTdeInfo object 透明 数据加密 配置信息，支持AES256、SM4加密算法。 透明加密功能目前处于公测阶段，如需使用，请提交工单联系客服人员申请权限。 表4 MysqlDatastoreInReq 参数 是否必选 参数类型 描述 type 是 String 数据库引擎，现在只支持gaussdb-mysql。 version 是 String 数据库版本。 两位数的大版本号，获取方法请参见查询数据库引擎的版本返回的name字段。 kernel_version 否 String 内核数据库版本。如果需要指定具体的内核版本，请联系客服人员添加白名单。 完整的四位内核数据库版本，获取方法请参见查询数据库引擎的版本返回的kernel_version字段。 表5 MysqlChargeInfo 参数 是否必选 参数类型 描述 charge_mode 是 String 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type 否 String 订购周期类型。 取值范围： month：包月。 year：包年。 说明：“charge_mode”为“prePaid”时生效，且为必选值。 period_num 否 Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： “period_type”为“month”时，取值为1~9。 “period_type”为“year”时，取值为1~3。 is_auto_renew 否 String 创建包年/包月实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true：为自动续订。 false：为不自动续订，默认该方式。 is_auto_pay 否 String 创建包年/包月实例时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true：为自动支付，默认该方式。 false：为手动支付。 表6 MysqlBackupStrategy 参数 是否必选 参数类型 描述 start_time 是 String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 keep_days 否 String 自动备份保留天数，取值范围：1-732。 表7 MysqlVolume 参数 是否必选 参数类型 描述 size 是 String 磁盘大小。默认值为10，单位GB。 取值范围：10~128000，必须为10的整数倍。 表8 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）。 表9 MysqlRestorePoint 参数 是否必选 参数类型 描述 source_instance_id 是 String 源实例ID。 restore_time 否 Long 需要恢复的时间点。（Point-In-Time Recovery, PITR）。 backup_id 否 String 备份文件ID。 type 否 String 备份类型。当参数为空时，backup_id不能为空，即默认按备份文件恢复。 当参数不为空时，取值范围： backup：表示按备份文件恢复。 timestamp：表示按时间点恢复。 表10 MysqlTdeInfo 参数 是否必选 参数类型 描述 enable_tde 是 Boolean 是否打开透明加密功能。 encryption_type 是 String 透明加密算法，支持AES256、SM4加密算法。

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 size Integer 扩容后容量。 order_id 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参数 参数 是否必选 参数类型 描述 size 是 Integer 扩容后的容量。包年/包月实例初始最小磁盘规格为10G，实例所选容量大小必须为10的整数倍，且大于实际使用容量，最大为128000GB。 取值范围： 扩容时必须大于等于20G。 缩容时必须大于等于10G。 is_auto_pay 否 String 表示是否自动从客户的账户中支付。 true：为自动支付，默认该方式。 false：为手动支付。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 quota_list Array of quota objects 资源列表对象。 total_count Integer 配额记录的条数。 表5 quota 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 enterprise_project_name String 企业项目名称。 instance_quota Integer 实例个数配额，-1表示无限制。 vcpus_quota Integer CPU核数配额，-1表示无限制。 ram_quota Integer 内存使用配额，单位为GB，-1表示无限制。 availability_instance_quota Integer 实例剩余配额，-1表示无限制。 availability_vcpus_quota Integer CPU核数剩余配额，-1表示无限制。 availability_ram_quota Integer 内存剩余配额，-1表示无限制。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "quota_list" : [ { "enterprise_project_id" : "0", "enterprise_project_name" : "default", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40, "availability_instance_quota" : 1, "availability_vcpus_quota" : 4, "availability_ram_quota" : 8 } ], "total_count" : 1 }

请求示例 批量创建LTS日志配置 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/logs/lts-configs { "log_configs" : [ { "instance_id" : "61a4ea66210545909d74a05c27a7179ein07", "log_type" : "error_log", "lts_group_id" : "c3dd5233-24a1-443c-6b40-310b3ad85382", "lts_stream_id" : "9b476e31-b745-4e76-8d78-2081168651f7" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 log_configs 是 Array of InstanceSaveLtsConfig objects 日志配置列表。 表4 InstanceSaveLtsConfig 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 log_type 是 String 日志类型。 lts_group_id 是 String 日志组ID。 lts_stream_id 是 String 日志流ID。

请求参数 表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_id 是 String 任务ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result Boolean 结果。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 修改实例的安全组。 PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/security-group { "security_group_id" : "054f55b5-946e-4761-a1e3-3be6892827c1" }

请求参数 表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 错误消息。

请求示例 批量删除LTS日志配置。 DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/logs/lts-configs/clickhouse?instance_id=86fd60a5256a4592b957e8e6bb2d1b59in07 { "log_configs" : [ { "instance_id" : "614ff06f72ee46b7949423572dd51e8bin16", "log_type" : "slow_log" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 log_configs 是 Array of log_configs objects LTS配置。 表4 log_configs 参数 是否必选 参数类型 描述 instance_id 是 String ClickHouse实例ID，严格匹配UUID规则。 log_type 是 String 日志类型。当前仅支持slow_log。

响应示例 状态码： 200 Success. { "slow_log_list" : [ { "node_id" : "941d21130b3c4899ad1a752a0945befdno07", "time" : "0.000143s", "rows_sent" : "10", "rows_examined" : "50", "database" : "user_center", "users" : "admin", "query_sample" : "sleep (N);", "type" : "1700755200000", "client_ip" : "10.1.1.60", "start_time" : "2023-08-28T08:22:13.591394+08:00", "line_num" : "1669344916000" } ] }

请求示例 获取内核慢日志信息。 POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/86fd60a5256a4592b957e8e6bb2d1b59in07/clickhouse/slow-logs { "node_id" : "aeb9e81135b34197bab8636fc8a1c569no16", "start_time" : "2023-12-12T00:14:27+0100", "end_time" : "2023-12-12T02:14:27+0100", "limit" : "10", "line_num" : "1669344916000", "operate_type" : "All", "database" : "DBS_NODE" }

请求参数 表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_id 是 String 实例节点ID。 start_time 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 limit 是 Integer 查询记录数。 line_num 否 String 日志单行序列号，第一次查询时不需要此参数，后续分页查询时需要使用，可从上次查询的返回信息中获取。 operate_type 否 String 慢日志操作类型。 database 否 String 数据库名。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 slow_log_list Array of slow_log_list objects 慢日志列表。 表5 slow_log_list 参数 参数类型 描述 node_id String ClickHouse实例节点ID。 time String 数据库语句执行时间。 lock_time String 数据库语句等待锁时间。 rows_sent Integer 数据库语句执行结果行数。 rows_examined Integer 数据库语句扫描行数。 database String 所属数据库名。 users String 执行语句账号。 query_sample String 数据库执行语句。 type String 数据库语句类型。 client_ip String IP地址。 start_time String 数据库语句发生时间。 line_num String 日志单行序列号，第一次查询时不需要此参数，后续分页查询时需要使用，可从上次查询的返回信息中获取。 count String 慢日志数量。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

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

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 job_id String 设置SQL限流规则任务ID。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 设置SQL限流规则，限流类型为SELECT、UPDATE、DELETE。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules { "sql_filter_rules" : [ { "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07", "rules" : [ { "sql_type" : "SELECT", "patterns" : [ { "pattern" : "select~from~t1", "max_concurrency" : 0 }, { "pattern" : "select~from~t3~where~id", "max_concurrency" : 10 } ] }, { "sql_type" : "UPDATE", "patterns" : [ { "pattern" : "update~t3~where~id", "max_concurrency" : 10 } ] } ] }, { "node_id" : "b234a5645eb2c4ji3b9372342f5362397no07", "rules" : [ { "sql_type" : "SELECT", "patterns" : [ { "pattern" : "select~from~t3~where~id", "max_concurrency" : 10 } ] }, { "sql_type" : "DELETE", "patterns" : [ { "pattern" : "delete~t3~where~id", "max_concurrency" : 10 } ] } ] } ] }