华为云用户手册

响应示例 状态码： 200 Success. { "instances" : [ { "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" ], "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" : "az1xahz", "region_code" : "cn-xianhz-1", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_ref" : "gaussdb.mysql.xlarge.arm.2.ha", "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" : "az1xahz", "region_code" : "cn-xianhz-1", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_ref" : "gaussdb.mysql.xlarge.arm.2.ha", "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 表4 响应Body参数 参数 参数类型 描述 instances Array of MysqlInstanceInfoDetail objects 实例详情。 表5 MysqlInstanceInfoDetail 参数 参数类型 描述 id String 实例ID。 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。 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 Proxy信息。 表6 MysqlInstanceChargeInfo 参数 参数类型 描述 charge_mode String 计费模式。 order_id String 订单号。 表7 MysqlDatastoreWithKernelVersion 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql version String 数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 kernel_version String 数据库内核版本 表8 MysqlBackupStrategy 参数 参数类型 描述 start_time String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 keep_days String 自动备份保留天数，取值范围：1-732 表9 MysqlInstanceNodeInfo 参数 参数类型 描述 id String 实例ID。 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 主备倒换优先级。 表10 MysqlInstanceNodeVolumeInfo 参数 参数类型 描述 type String 磁盘类型。 used String 已使用磁盘大小，单位GB。 size Long 包周期购买的存储空间大小，单位GB。 表11 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）。 表12 MysqlProxyInfo 参数 参数类型 描述 pool_id String Proxy实例ID。 name String Proxy实例名称。 address String Proxy读写分离地址。 状态码： 400 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/instances/details 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 instance_ids 是 String 实例ID。最多同时输入20个实例ID，用英文逗号分隔。

响应示例 状态码： 200 Success. { "error_log_list" : [ { "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "time" : "2021-03-06T12:07:05", "level" : "ERROR, content:[MY013508] [Repl] do failed: 1", "total_record" : 15 } ]}

URI GET /mysql/v3/{project_id}/instances/{instance_id}/errorlog 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID 表2 Query参数 参数 是否必选 参数类型 描述 start_date 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_date 是 String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100 level 否 String 日志级别 node_id 否 String 节点ID

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error_log_list Array of MysqlErrorLogList objects 错误日志具体信息。 total_record Integer 总记录数。 表5 MysqlErrorLogList 参数 参数类型 描述 node_id String 节点ID。 time String 日期时间UTC时间。 level String 日志级别。 content String 错误日志内容。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 charsets Array of strings 数据库字符集列表 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 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 X-Language 否 String 语言 表3 请求Body参数 参数 是否必选 参数类型 描述 size 是 Integer 扩容后的容量，每次扩容最小容量为10GB，实例所选容量大小必须为10的整数倍 is_auto_pay 否 String 表示是否自动从客户的账户中支付。 true，为自动支付，默认该方式。 false，为手动支付。 枚举值： true false

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

请求示例 创建实例 POST https://{endpoint}/mysql/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" : "taurus.large.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" : "Hu2wei@13", "backup_strategy" : { "start_time" : "08:00-09:00" }, "availability_zone_mode" : "single", "slave_count" : 1, "enterprise_project_id" : 0}

响应示例 状态码： 201 Success. { "instance" : { "id" : "5eebbb4c0f9f4a99b42ed1b6334569aain07", "name" : "gaussdb-mysql-instance1", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "postPaid" }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "mode" : "Cluster", "flavor_ref" : "taurus.large.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", "slave_count" : 1 }, "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"}

响应参数 状态码： 201 表9 响应Body参数 参数 参数类型 描述 instance MysqlInstanceResponse object 实例信息 job_id String 实例创建的任务id。 仅创建按需实例时会返回该参数。 order_id String 订单号，创建包年包月时返回该参数。 表10 MysqlInstanceResponse 参数 参数类型 描述 id String 实例ID。 name String 实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。 取值范围：4~64个字符之间，必须以字母开头，不区分大小写，可以包含字母、数字、中划线或者下划线, 不能包含其它的特殊字符。 status String 实例状态。 datastore MysqlDatastore 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 计费类型信息，支持包年包月和按需，默认为按需。 表11 MysqlDatastore 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql version String 数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 表12 MysqlBackupStrategy 参数 参数类型 描述 start_time String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 keep_days String 自动备份保留天数，取值范围：1-732 表13 MysqlChargeInfo 参数 参数类型 描述 charge_mode String 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 枚举值： prePaid postPaid period_type String 订购周期类型。 取值范围： month：包月。 year：包年。 说明：“charge_mode”为“prePaid”时生效，且为必选值。 枚举值： month year period_num Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3。 is_auto_renew String 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true，为自动续订。 false，为不自动续订，默认该方式。 枚举值： true false is_auto_pay String 创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true，为自动支付，默认该方式。 false，为手动支付。 枚举值： true false 状态码： 400 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 charge_info 否 MysqlChargeInfo object 计费类型信息，支持包年包月和按需，默认为按需。 说明：DeC专属云账号不支持创建包周期。 region 是 String 区域ID。 name 是 String 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。 取值范围：4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 datastore 是 MysqlDatastore object 数据库信息。 mode 是 String 实例类型，目前仅支持Cluster。 flavor_ref 是 String 规格码。 vpc_id 是 String 虚拟私有云ID。 subnet_id 是 String 子网的网络ID。 security_group_id 否 String 安全组ID。如果实例所选用的子网开启网络ACL进行访问控制，则该参数非必选。如果未开启ACL进行访问控制，则该参数必选。 configuration_id 否 String 参数模板ID。 password 是 String 数据库密码。 取值范围：至少包含以下字符的三种：大小写字母、数字和特殊符号~!@#$%^*-_=+?,()&，长度8~32个字符。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您输入弱密码，系统会自动判定密码非法。 backup_strategy 否 MysqlBackupStrategy object 自动备份策略 time_zone 否 String 时区。 availability_zone_mode 是 String 可用区类型,单可用区Single或多可用区multi。 master_availability_zone 否 String 主可用区。 slave_count 是 Integer 备节点个数。单次接口调用最多支持创建9个备节点。 volume 否 MysqlVolume object volume信息。创建包周期实例可选。 tags 否 Array of MysqlTags objects 标签列表，根据标签键值对创建实例。 {key}表示标签键，不可以为空或重复。 {value}表示标签值，可以为空。 如果创建实例时同时使用多个标签键值对，中间使用逗号分隔开，最多包含10组。 enterprise_project_id 否 String 企业项目ID。如果账户开通企业项目服务则该参数必选，未开启该参数不可选。 dedicated_resource_id 否 String 专属资源池ID，只有开通专属资源池后才可以下发此参数。 表4 MysqlChargeInfo 参数 是否必选 参数类型 描述 charge_mode 是 String 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 枚举值： prePaid postPaid period_type 否 String 订购周期类型。 取值范围： month：包月。 year：包年。 说明：“charge_mode”为“prePaid”时生效，且为必选值。 枚举值： month year period_num 否 Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3。 is_auto_renew 否 String 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true，为自动续订。 false，为不自动续订，默认该方式。 枚举值： true false is_auto_pay 否 String 创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true，为自动支付，默认该方式。 false，为手动支付。 枚举值： true false 表5 MysqlDatastore 参数 是否必选 参数类型 描述 type 是 String 数据库引擎，现在只支持gaussdb-mysql version 是 String 数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 表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 磁盘大小。默认值为40，单位GB。 取值范围：40~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）。

请求示例 扩容数据库代理节点。 POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge{ "node_num" : 2, "proxy_id" : "151c14381ac14ecfb9703a745b992677po01"}

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 node_num 是 Integer proxy节点扩容操作需要扩容的节点数。 扩容的节点数的取值范围：1~30之间的整数。 限制条件：该实例的proxy节点的总数量小于等于32。 proxy_id 否 String 数据库代理ID。 如果实例只开启了一个代理，可不传该参数；如果实例开启了多个代理，则必须指定一个数据库代理，扩容新的代理节点。

URI DELETE /mysql/v3/{project_id}/instances/{instance_id}/nodes/{node_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 node_id 是 String 节点ID，严格匹配UUID规则。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 sql_filter_rules 是 Array of DeleteNodeSqlFilterRuleInfo objects 节点级别的SQL限流规则。 表4 DeleteNodeSqlFilterRuleInfo 参数 是否必选 参数类型 描述 node_id 是 String 节点ID rules 是 Array of DeleteNodeSqlFilterRule objects SQL限流规则。 表5 DeleteNodeSqlFilterRule 参数 是否必选 参数类型 描述 sql_type 是 String Sql限流类型。 取值范围： SELECT UPDATE DELETE patterns 是 Array of strings SQL限流具体规则。

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 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。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 proxy_ids 否 Array of strings 数据库代理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 错误消息。

状态码 状态码列表： 表1 状态码说明 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 200 OK 请求成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录