华为云用户手册

响应参数 状态码： 202 表3 响应Body参数 参数 参数类型 描述 proxy_flavor_groups Array of MysqlProxyFlavorGroups objects 规格组信息。 表4 MysqlProxyFlavorGroups 参数 参数类型 描述 group_type String 规格组类型,如x86，arm。 proxy_flavors Array of MysqlProxyComputeFlavor objects 规格信息。 表5 MysqlProxyComputeFlavor 参数 参数类型 描述 id String Proxy规格id。 spec_code String Proxy规格码。 vcpus String CPU大小。例如：1表示1U。 ram String 内存大小，单位为GB。 db_type String 数据库类型。 az_status Object 其中key是可用区编号，value是规格所在az的状态。 region_status String Region状态。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 202 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" }, "region_status" : "normal" } }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 switch_status String sql限流开关状态。 取值： ON：已开启 OFF：已关闭 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg 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 实例个数配额。 vcpus_quota Integer CPU核数配额。 ram_quota Integer 内存使用配额，单位为GB。 availability_instance_quota Integer 实例剩余配额。 availability_vcpus_quota Integer CPU核数剩余配额。 availability_ram_quota Integer 内存剩余配额。 状态码： 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 } ]}

URI GET /mysql/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 企业项目名称。

响应示例 状态码： 202 Success. { "proxy" : { "pool_id" : "2e7cf21d14794bafab623a334efd9ad8po01", "status" : "open", "address" : "192.168.125.69", "port" : 3306, "pool_status" : "ACTIVE", "delay_threshold_in_seconds" : 30, "elb_vip" : "192.168.125.60", "eip" : "192.168.125.50", "vcpus" : 4, "ram" : 8, "node_num" : 2, "mode" : "Cluster", "nodes" : { "id" : "db53a238a02240c49365e72e284a4890pn01", "name" : "PROXY-2e7cf21d14794bafab623a334efd9ad8po01_0", "role" : "master", "az_code" : "az1xahz", "status" : "ACTIVE", "frozen_flag" : 0 } }, "master_node" : { "id" : "2a111d6d494e4327ad2e326afb591108in07", "instance_id" : "7a871d6d494e4327ad2e326afb591108in07", "status" : "ACTIVE", "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01", "weight" : 0, "available_zones" : { "code" : "az1xahz", "description" : "可用区1" } }, "readonly_nodes" : { "id" : "d23535333138462880bfa1838fdfced2no07", "instance_id" : "7a871d6d494e4327ad2e326afb591108in07", "status" : "ACTIVE", "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node02", "weight" : 100, "available_zones" : { "code" : "az1xahz", "description" : "可用区1" } }}

响应参数 状态码： 202 表3 响应Body参数 参数 参数类型 描述 proxy MysqlProxy object Proxy实例信息。 master_node MysqlProxyNode object 主节点信息。 readonly_nodes Array of MysqlProxyNode objects 只读节点信息。 表4 MysqlProxy 参数 参数类型 描述 pool_id String Proxy实例id。 status String Proxy实例开启状态。 取值范围：closed、open、frozen、opening、closing、enlarging、freezing和unfreezin。 address String Proxy读写分离地址。 port Integer Proxy端口信息。 pool_status String Proxy实例状态。 取值范围：abnormal、normal、creating和deleted。 delay_threshold_in_seconds Integer 延时阈值，单位：秒。 elb_vip String Elb模式的虚拟ip信息。 eip String 弹性公网IP信息。 vcpus String Proxy实例规格的CPU数量。 ram String Proxy实例规格的内存数量。 node_num Integer Proxy节点个数。 mode String Proxy主备模式，取值范围：Cluster。 nodes Array of MysqlProxyNodes objects Proxy节点信息。 flavor_ref String Proxy规格信息。 表5 MysqlProxyNodes 参数 参数类型 描述 id String Proxy节点id。 status String Proxy节点状态。 取值范围：normal、abnormal、creating和deleted。 name String Proxy节点名称。 role String Proxy节点角色：master和slave。 az_code String 可用区。 frozen_flag Integer Proxy节点是否被冻结：0-未冻结；1-冻结；2-冻结删除。 表6 MysqlProxyNode 参数 参数类型 描述 id String 节点id。 instance_id String 实例id。 status String 节点状态。 name String 节点名称。 weight Integer 节点读写分离权重。 available_zones Array of MysqlProxyAvailable objects 可用区信息。 表7 MysqlProxyAvailable 参数 参数类型 描述 code String 可用区编码。 description String 可用区描述。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表9 响应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 错误消息。

请求示例 查询实例列表 GET https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10

响应示例 状态码： 200 Success. { "total_count" : 1, "instances" : [ { "id" : "d738399de028480fabb2b8120d4e01a4in07", "name" : "gaussdb-mysql-instance01", "status" : "ACTIVE", "port" : 3306, "type" : "Cluster", "private_ips" : [ "192.168.0.142" ], "db_user_name" : "root", "region" : "cn-north-4", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "created" : "2018-08-20T02:33:49_0800", "updated" : "2018-08-20T02:33:49_0800", "volume" : { "type" : "POOL", "used_size" : 100 }, "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "flavor_ref" : "gaussdb.mysql.c3.small.4", "flavor_info" : { "vcpus" : 8, "ram" : 16 }, "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "charge_info" : { "charge_mode" : "postPaid" }, "enterprise_project_id" : 0, "time_zone" : "UTC", "tags" : [ ] } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instances Array of MysqlInstanceListInfo objects 实例列表信息。 total_count Integer 总记录数。 表5 MysqlInstanceListInfo 参数 参数类型 描述 id String 实例ID。 name String 创建的实例名称。 status String 实例状态。 private_ips Array of strings 实例写内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空字符串。 public_ips Array of strings 实例外网IP地址列表。 port String 数据库端口号。 type String 实例类型，取值为“Cluster”。 region String 实例所在区域。 datastore MysqlDatastore object 数据库信息。 created String 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。说明：创建时返回值为空，数据库实例创建成功后该值不为空。 updated String 更新时间，格式与"created"字段对应格式完全相同。说明：创建时返回值为空，数据库实例创建成功后该值不为空。 db_user_name String 默认用户名。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 安全组ID。 flavor_ref String 规格码。 flavor_info MysqlFlavorInfo object flavor规格信息。 volume MysqlVolumeInfo object 存储盘信息。 backup_strategy MysqlBackupStrategy object 自动备份策略 enterprise_project_id String 企业项目ID。 time_zone String 时区。 charge_info MysqlChargeInfo object 计费类型信息，支持包年包月和按需，默认为按需。 dedicated_resource_id String 专属资源池ID，只有数据库实例属于专属资源池才会返回该参数。 表6 MysqlDatastore 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql version String 数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 表7 MysqlFlavorInfo 参数 参数类型 描述 vcpus String CPU核数。 ram String 内存大小，单位GB。 表8 MysqlVolumeInfo 参数 参数类型 描述 type String 磁盘类型。 size String 已使用磁盘大小，单位GB。 表9 MysqlBackupStrategy 参数 参数类型 描述 start_time String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 keep_days String 自动备份保留天数，取值范围：1-732 表10 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 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /mysql/v3/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 实例ID。 “”为系统保留字符，如果id是以 “”起始，表示按照 “”后面的值模糊匹配，否则，按照id精确匹配查询。不能只传入 “”。 name 否 String 实例名称。 “”为系统保留字符，如果name是以 “”起始，表示按照 “”后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入 “”。 type 否 String 按照实例类型查询。目前仅支持Cluster。 datastore_type 否 String 数据库类型，现在只支持gaussdb-mysql。 vpc_id 否 String 虚拟私有云ID。 subnet_id 否 String 子网的网络ID信息。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

URI GET /v3/{project_id}/instances/{instance_id}/sql-filter/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 node_id 是 String 节点ID。 type 否 String SQL限流类型，取值为SELECT、UPDATE、DELETE，不区分大小写；若不传则默认查询所有类型的限流规则。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 node_id String 节点ID sql_filter_rules Array of SqlFilterRule objects SQL限流规则 表5 SqlFilterRule 参数 参数类型 描述 sql_type String Sql限流类型。 取值范围： SELECT UPDATE DELETE patterns Array of SqlFilterRulePattern objects SQL限流具体规则。 表6 SqlFilterRulePattern 参数 参数类型 描述 pattern String SQL限流规则。 max_concurrency Integer 最大并发数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07", "sql_filter_rules" : [ { "sql_type" : "SELECT", "patterns" : [ { "pattern" : "select~from~t1", "max_concurrency" : 0 }, { "pattern" : "select~from~t2~where~id", "max_concurrency" : 10 } ] }, { "sql_type" : "UDPATE", "patterns" : [ { "pattern" : "update~t1", "max_concurrency" : 0 }, { "pattern" : "update~t2~where~id", "max_concurrency" : 10 } ] }, { "sql_type" : "DELETE", "patterns" : [ { "pattern" : "delete~from", "max_concurrency" : 0 } ] } ]}

响应参数 状态码： 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参数 参数 是否必选 参数类型 描述 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 一级备份保留数量，默认值为0。当一级备份开关开启时，该参数值有效。取值：0或1

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

请求示例 修改实例的自动备份策略，每周的周一至周五的19:00-20:00进行备份，备份文件保留7天。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update{ "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,3,4,5" }}

请求示例 修改数据库备注。 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 错误消息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 开启/关闭全量SQL操作结果。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应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 错误消息。

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

请求示例 为实例绑定弹性公网IP。 PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/public-ips/bind{ "public_ip" : "10.145.51.214", "public_ip_id" : "8403e9cd-a7fa-4288-8b15-c7ceac1etest"}

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

请求示例 修改数据库用户的备注。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/comment{ "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "comment" : "first_database_user" } ]}

响应参数 状态码： 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 表4 响应Body参数 参数 参数类型 描述 job_id String 修改实例名称的任务ID 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。