华为云用户手册

状态码 状态码列表： 表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协议的版本，无法完成处理。 父主题： 附录

响应示例 状态码： 200 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 }, "name" : "proxy-name" }, "master_node" : { "id" : "5ee8010ab992460d8d9cffcc5edabb59no07", "instance_id" : "7a871d6d494e4327ad2e326afb591108in07", "status" : "ACTIVE", "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01", "weight" : 0, "available_zones" : { "code" : "az1", "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" : "az1", "description" : "可用区1" } } }

响应参数 状态码： 200 表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和unfreezing。 address String Proxy读写分离地址。 port Integer Proxy端口信息。 pool_status String Proxy实例状态。 取值范围：ACTIVE、BUILD、FAILED和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规格信息。 name String Proxy实例名称。 表5 MysqlProxyNodes 参数 参数类型 描述 id String Proxy节点id。 status String Proxy节点状态。 取值范围：ACTIVE、ABNORMAL、BUILD和FAILED。 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 表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 /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规则。

请求参数 表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 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 order_id String 订单ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 backup_policy BackupPolicy object 备份策略信息。 表4 BackupPolicy 参数 参数类型 描述 keep_days Integer 指定已生成的备份文件可以保存的天数。取值范围：1～732，您也可以联系客服将最大保留天数调整为3660。 最小值：1 最大值：732 start_time String 备份时间段。自动备份将在该时间段内触发。 取值范围：格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 period String 备份周期配置。自动备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字代表星期。 retention_num_backup_level1 Integer 一级备份保留数量。当一级备份开关开启时，返回此参数。 状态码： 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 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 priorities 是 Array of integers 指定创建的只读节点故障倒换优先级。倒换优先级列表个数即为只读节点格式。 故障倒换优先级的取值范围为1~16，数字越小，优先级越大，即故障倒换时，主节点会优先倒换到优先级高的备节点上，优先级相同的备节点选为主节点的概率相同。 is_auto_pay 否 String 创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true，为自动支付，默认该方式。 false，为手动支付。 枚举值： true false

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 node_names Array of strings 节点名称列表。 job_id String 实例创建的任务id。 仅创建按需实例时会返回该参数。 order_id String 订单号，创建包年包月时返回该参数。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 201 Success. { "instance_id" : "f381d0b539e644df8f5b0d3a62129515in07", "node_names" : [ "gauss-ccf5_node03", "gauss-ccf5_node04" ], "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" }

响应示例 状态码： 200 Success. { "instances" : [ { "id" : "11684a0e59e94bceba7880d58cfb07b5in07", "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" : [ "11684a0e59e94bceba7880d58cfb07b5in07.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 表4 响应Body参数 参数 参数类型 描述 instances Array of MysqlInstanceInfoDetail objects 实例详情。 表5 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 数据库代理信息。 表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，严格匹配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 主备倒换优先级。 表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 数据库代理ID。 name String 数据库代理名称。 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，严格匹配UUID规则。最多同时输入20个实例ID，用英文逗号分隔。

TaurusDB授权分类 表1 授权列表 权限 对应API接口 授权项（Action） IAM项目（Project） 企业项目（Enterprise Project） 查询资源配额 GET /mysql/v3/{project_id}/quotas gaussdb:instance:list √ √ 设置资源配额 POST /mysql/v3/{project_id}/quotas gaussdb:quota:modify √ √ 修改资源配额 PUT /mysql/v3/{project_id}/quotas gaussdb:quota:modify √ √ 查询数据库引擎版本 GET /mysql/v3/{project_id}/datastores/{database_name} gaussdb:instance:list √ √ 查询数据库规格 GET /mysql/v3/{project_id}/flavors/{database}?version_name={version_name}&spec_code={spec_code} gaussdb:instance:list √ √ 创建实例 POST /mysql/v3/{projectId}/instances gaussdb:instance:create √ √ 查询实例列表 GET /mysql/v3/{projectId}/instances gaussdb:instance:list √ √ 查询实例详细信息 GET /mysql/v3/{project_id}/instances/{instance_id} gaussdb:instance:list √ √ 删除实例 DELETE /mysql/v3/{project_id}/instances/{instance_id} gaussdb:instance:delete √ √ 查询参数模板 GET /mysql/v3/{project_id}/configurations gaussdb:param:list √ √ 获取任务信息 GET /mysql/v3/{projectId}/jobs gaussdb:instance:list √ √ 新增只读节点 POST /mysql/v3/{project_id}/instances/{instance_id}/nodes/enlarge gaussdb:instance:create √ √ 删除只读节点 DELETE /mysql/v3/{project_id}/instances/{instance_id}/nodes/{node_id} gaussdb:instance:delete √ √ 扩容包周期实例磁盘容量 POST /mysql/v3/{project_id}/instances/{instance_id}/volume/extend gaussdb:instance:modifySpec √ √ 修改实例名称 PUT /mysql/v3/{project_id}/instances/{instance_id}/name gaussdb:instance:modify √ √ 重置数据库密码 POST /mysql/v3/{project_id}/instances/{instance_id}/password gaussdb:instance:modify √ √ 变更数据库实例的规格 POST /mysql/v3/{project_id}/instances/{instance_id}/action gaussdb:instance:modifySpec √ √ 创建手动备份 POST /mysql/v3/{project_id}/backups/create gaussdb:backup:create √ √ 查询备份列表 GET /mysql/v3/{project_id}/backups gaussdb:backup:list √ √ 查询自动备份策略 GET /mysql/v3/{project_id}/instances/{instance_id}/backups/policy gaussdb:backup:list √ √ 修改自动备份策略 PUT /mysql/v3/{project_id}/instances/{instance_id}/backups/policy/update gaussdb:instance:modifyBackupPolicy √ √ 父主题： 权限策略和授权项

请求参数 表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 proxy节点扩容操作需要扩容的节点数。本次扩容的节点数的取值范围：1~30之间的整数。 限制条件：该实例的proxy节点的总数量小于等于32。 proxy_id 是 String 数据库代理ID。 如果实例只开启了一个代理，可不传该参数；如果实例开启了多个代理，则必须指定一个数据库代理，扩容新的代理节点。

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

请求示例 post https://{endpoint}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/enlarge { "node_num" : 2, "proxy_id": "151c14381ac14ecfb9703a745b992677po01" }

终端节点 终端节点（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 表3 响应Body参数 参数 参数类型 描述 configurations Array of ConfigurationSummary objects 参数模板信息。 total_count Integer 参数模板的总数。 表4 ConfigurationSummary 参数 参数类型 描述 id String 参数组ID。 name String 参数组名称。 description String 参数组描述。 datastore_version_name String 引擎版本。 datastore_name String 引擎名。 created String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 user_defined Boolean 是否是用户自定义参数模板： false，表示为系统默认参数模板。 true，表示为用户自定义参数模板。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "configurations" : [ { "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", "name" : "configuration_test", "description" : "configuration_test", "datastore_version_name" : "8.0", "datastore_name" : " GaussDB (for MySQL)", "created" : "2019-05-15T11:53:34+0000", "updated" : "2019-05-15T11:53:34+0000", "user_defined" : true }, { "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07", "name" : "Default-GaussDBforMySQL", "description" : "Default parameter template for GaussDBforMySQL", "datastore_version_name" : "8.0", "datastore_name" : "GaussDB(for MySQL)", "created" : "2019-05-27T03:38:51+0000", "updated" : "2019-05-27T03:38:51+0000", "user_defined" : false } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 实例名称。 长度最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。

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

请求示例 修改备份策略 PUT https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update { "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,3,4,5" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表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 1级备份保留数量，默认值为0。当一级备份开关开启时，该参数值有效。取值：0或1

响应示例 状态码： 200 Success. 示例 1 { "error_log_list" : [ { "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "count" : 1, "time" : "1.04899 s", "lock_time" : "0.00003 s", "rows_sent" : 0, "rows_examined" : 0, "database" : "gaussdb-mysql", "users" : "root", "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);", "type" : "INSERT", "start_time" : "2121-03-25T10:55:16", "client_ip" : "192.*.*.1" } ] } 示例 2 10 示例 3 15

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 slow_log_list Array of MysqlSlowLogList objects 错误日志具体信息。 long_query_time String 慢日志阈值。 total_record Integer 总记录数。 表5 MysqlSlowLogList 参数 参数类型 描述 node_id String 节点ID。 count String 执行次数。 time String 执行时间。 lock_time String 等待锁时间。 rows_sent String 结果行数量。 rows_examined String 扫描的行数量。 database String 所属数据库。 users String 账号。 query_sample String 执行语法。 type String 语句类型。 start_time String 发生时间,UTC时间 client_ip String IP地址。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /mysql/v3/{project_id}/instances/{instance_id}/slowlog 表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 type 否 String 语句类型，取空值，表示查询所有语句类型，也可指定如下日志类型：INSERT、UPDATE、SELECT、DELETE和CREATE node_id 是 String 节点ID

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。