华为云用户手册

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 backup backup object 备份信息。 表5 backup 参数 参数类型 描述 id String 备份ID name String 备份名称。 descriprion String 备份描述。 begin_time String 备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”,其中T指时间字段的开始;Z指时区偏移量。 status Object 备份状态 枚举值: BUILDING:备份中。 COMPLETED:备份完成。 FAILED:备份失败。 AVAILABLE:备份可用。 type Object 备份类型,取值: 枚举值: manual:手动全量备份。 instance_id String 实例ID。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应示例 状态码: 200 Success. { "backup" : { "id" : "2f4ddb93-b901-4b08-93d8-1d2e472f30fe", "name" : "backup-1", "description" : "手动备份", "begin_time" : "2020-07-07T01:17:05+0800", "status" : "BUILDING", "type" : "manual", "instance_id" : "ef25188419f941309882d2986b2210b9in07" }}
  • 响应参数 状态码: 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 错误消息。
  • 请求示例 删除数据库用户"gaussdb_mysql_user1"的数据库权限。 DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/privilege{ "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "databases" : [ "test" ] } ]}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 configuration_id String 参数模板ID。 configuration_name String 参数模板名称。 状态码: 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参数 参数 是否必选 参数类型 描述 users 是 Array of DeleteDatabasePermission objects 数据库用户列表,列表最大长度为50。 表4 DeleteDatabasePermission 参数 是否必选 参数类型 描述 name 是 String 数据库用户名 host 是 String 主机地址 databases 是 Array of strings 数据库列表
  • 响应参数 状态码: 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 错误消息。
  • 响应参数 状态码: 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 错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 priorities 是 Array of integers 指定创建的只读节点故障倒换优先级。倒换优先级列表个数即为只读节点格式。 故障倒换优先级的取值范围为1~16,数字越小,优先级越大,即故障倒换时,主节点会优先倒换到优先级高的备节点上,优先级相同的备节点选为主节点的概率相同。 is_auto_pay 否 String 创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 true,为自动支付,默认该方式。 false,为手动支付。 枚举值: true false
  • 请求示例 创建计费模式为按需计费,自动备份开始时间是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" }}
  • 响应示例 状态码: 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" }, "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"}
  • 响应参数 状态码: 201 表10 响应Body参数 参数 参数类型 描述 instance MysqlInstanceResponse object 实例信息 job_id String 实例创建的任务ID。 仅创建按需实例时会返回该参数。 order_id String 订单号,创建包年包月时返回该参数。 表11 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 计费类型信息,支持包年包月和按需,默认为按需。 表12 MysqlDatastore 参数 参数类型 描述 type String 数据库引擎,现在只支持gaussdb-mysql version String 数据库版本。 数据库支持的详细版本信息,可调用查询数据库引擎的版本接口获取。 表13 MysqlBackupStrategy 参数 参数类型 描述 start_time String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围:非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同,且取值必须为00。 keep_days String 自动备份保留天数,取值范围:1-732 表14 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,为不自动续订,默认该方式。 is_auto_pay String 创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 true,为自动支付,默认该方式。 false,为手动支付。 状态码: 400 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表16 响应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 时区。默认时区为UTC。 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组。 lower_case_table_names 否 Integer 表名大小写是否敏感,默认值是“1”。 取值范围: 0:表名被存储成固定且表名称大小写敏感。 1:表名将被存储成小写且表名称大小写不敏感。 enterprise_project_id 否 String 企业项目ID。如果账户开通企业项目服务则该参数必选,未开启该参数不可选。 dedicated_resource_id 否 String 专属资源池ID,只有开通专属资源池后才可以下发此参数。 restore_point 否 MysqlRestorePoint object 备份恢复信息。 表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,为不自动续订,默认该方式。 is_auto_pay 否 String 创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 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 磁盘大小。默认值为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 参数 是否必选 参数类型 描述 restore_time 否 Long PITR。要恢复的时间点。 source_instance_id 是 String 源实例ID。 backup_id 否 String 备份文件ID。 type 否 String 备份类型。当参数为空时,backup_id不能为空,即默认按备份文件恢复。 当参数不为空时,取值范围: backup:表示按备份文件恢复; timestamp:表示按时间点恢复;
  • 请求示例 GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/slowlog?offset=0&limit=1&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07&type=INSERT
  • 响应示例 状态码: 200 Success. { "slow_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.000Z", "client_ip" : "192.*.*.1" } ], "long_query_time" : 10, "total_record" : 15}
  • URI GET /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指时区偏移量,例如偏移1个小时显示为+0100。 end_date 是 String 结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 offset 否 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数 limit 否 Integer 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。 type 否 String 语句类型,取空值,表示查询所有语句类型,也可指定如下日志类型: INSERT UPDATE SELECT DELETE ALTER DROP CREATE node_id 是 String 节点ID
  • 响应参数 状态码: 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 错误消息。
  • 响应示例 状态码: 200 Success. { "jobs" : [ { "instance_id" : "ede953923f06448d9be8686ef0c1378ein07", "instance_name" : "gauss-1234", "instance_status" : "deleted", "job_id" : "7155730b-a60b-4dc0-9f89-3f55897f29d6", "order_id" : "", "job_name" : "Close GaussDB forMySQLProxy", "status" : "Completed", "process" : "", "created_time" : "2018-08-06T10:41:14+0000", "ended_time" : "2018-08-06T12:41:14+0000", "fail_reason" : "Single task exception." } ], "total_count" : 1}
  • URI GET /v3/{project_id}/immediate-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 任务执行状态。 取值: 值为“Running”,表示任务正在执行。 值为“Completed”,表示任务执行成功。 值为“Failed”,表示任务执行失败。 值为“Pending”,表示任务未执行。 job_name 否 String 任务名称。取值有: "CreateGaussDBforMySQLInstance"表示创建实例。 "RestoreGaussDBforMySQLNewInstance"表示恢复新实例。 "AddGaussDBforMySQLNodes"表示添加节点。 "DeleteGaussDBforMySQLNode"表示删除节点。 "RebootGaussDBforMySQLInstance"表示重启实例。 "ModifyGaussDBforMySQLPort"表示修改实例端口。 "ModifyGaussDBforMySQLSecurityGroup"表示修改实例安全组。 "ResizeGaussDBforMySQLFlavor"表示实例规格变更。 "SwitchoverGaussDBforMySQLMasterNode"表示只读升主。 "GaussDBforMySQLBindEIP"表示绑定弹性公网IP。 "GaussDBforMySQLUnbindEIP"表示解绑弹性公网IP。 "RenameGaussDBforMySQLInstance"表示修改实例名称。 "DeleteGaussDBforMySQLInstance"表示删除实例集群。 "UpgradeGaussDBforMySQLDatabaseVersion"表示版本升级。 "EnlargeGaussDBforMySQLProxy"表示实例的数据库代理节点扩容。 "OpenGaussDBforMySQLProxy"表示开启实例的数据库代理。 "CloseGaussDBforMySQLProxy"表示关闭实例的数据库代理。 "GaussdbforMySQLModifyProxyIp"表示修改数据库代理ip。 "ScaleGaussDBforMySQLProxy"表示实例的数据库代理节点规格变更。 "GaussDBforMySQLModifyInstanceMetricExtend"表示实例秒级监控。 "GaussDBforMySQLModifyInstanceDataVip"表示修改实例数据Vip。 "GaussDBforMySQLSwitchSSL"表示切换实例SSL开关。 "GaussDBforMySQLModifyProxyConsist"表示修改代理一致性。 "GaussDBforMySQLModifyProxyWeight"表示修改代理权重。 job_id 否 String 任务ID。 offset 否 String 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为1,必须为数字,不能为负数。 limit 否 String 查询记录数。默认为10,取值为10、20、50。 start_time 否 String 起始时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 end_time 否 String 结束时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of TaskDetailInfo objects 任务详情。 total_count Integer 任务总数。 表5 TaskDetailInfo 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称。 instance_status String 实例状态。 取值: 值为“createfail”,表示实例创建失败。 值为“creating”,表示实例创建中。 值为“normal”,表示实例正常。 值为“abnormal”,表示实例异常。 值为“deleted”,表示实例已删除。 job_id String 任务ID。 order_id String 订单ID。 job_name String 任务名称。取值有: "CreateGaussDBforMySQLInstance"表示创建实例。 "RestoreGaussDBforMySQLNewInstance"表示恢复新实例。 "AddGaussDBforMySQLNodes"表示添加节点。 "DeleteGaussDBforMySQLNode"表示删除节点。 "RebootGaussDBforMySQLInstance"表示重启实例。 "ModifyGaussDBforMySQLPort"表示修改实例端口。 "ModifyGaussDBforMySQLSecurityGroup"表示修改实例安全组。 "ResizeGaussDBforMySQLFlavor"表示实例规格变更。 "SwitchoverGaussDBforMySQLMasterNode"表示只读升主。 "GaussDBforMySQLBindEIP"表示绑定弹性公网IP。 "GaussDBforMySQLUnbindEIP"表示解绑弹性公网IP。 "RenameGaussDBforMySQLInstance"表示修改实例名称。 "DeleteGaussDBforMySQLInstance"表示删除实例集群。 "UpgradeGaussDBforMySQLDatabaseVersion"表示版本升级。 "EnlargeGaussDBforMySQLProxy"表示实例的数据库代理节点扩容。 "OpenGaussDBforMySQLProxy"表示开启实例的数据库代理。 "CloseGaussDBforMySQLProxy"表示关闭实例的数据库代理。 "GaussdbforMySQLModifyProxyIp"表示修改数据库代理ip。 "ScaleGaussDBforMySQLProxy"表示实例的数据库代理节点规格变更。 "GaussDBforMySQLModifyInstanceMetricExtend"表示实例秒级监控。 "GaussDBforMySQLModifyInstanceDataVip"表示修改实例数据Vip。 "GaussDBforMySQLSwitchSSL"表示切换实例SSL开关。 "GaussDBforMySQLModifyProxyConsist"表示修改代理一致性。 "GaussDBforMySQLModifyProxyWeight"表示修改代理权重。 status String 任务执行状态。 取值: 值为“Pending”,表示延时任务,未执行。 值为“Running”,表示任务正在执行。 值为“Completed”,表示任务执行成功。 值为“Failed”,表示任务执行失败。 process String 任务进度。 created_time String 任务创建时间。格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 ended_time String 任务结束时间。格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 fail_reason String 任务失败原因。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 tags Array of ResourceTagItem objects 标签列表。 表5 ResourceTagItem 参数 参数类型 描述 key String 标签键。 value String 标签值。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • URI GET /v3/{project_id}/instances/{instance_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 Integer 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。
  • 响应参数 状态码: 202 表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 Success. { "error_log_list" : [ { "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "time" : "2022-07-17T07:34:33", "level" : "ERROR", "content" : "[MY013508] [Repl] do failed: 1" } ]}
  • 请求示例 GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/errorlog?offset=0&limit=1&level=ALL&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07
  • URI GET /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指时区偏移量,例如偏移1个小时显示为+0100。 end_date 是 String 结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 offset 否 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数 limit 否 Integer 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。 level 否 String 日志级别。 取值范围: ALL INFO LOG WARNING ERROR FATAL PANIC NOTE 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 表4 响应Body参数 参数 参数类型 描述 users Array of ListGaussMySqlDatabaseUser objects 数据库用户列表。 total_count Integer 实例的数据库用户总数 表5 ListGaussMySqlDatabaseUser 参数 参数类型 描述 name String 数据库用户名。 host String 主机地址。 comment String 数据库用户备注。 databases Array of ListGaussMySqlDatabase objects 数据库列表。 表6 ListGaussMySqlDatabase 参数 参数类型 描述 name String 数据库名称。 readonly Boolean 是否为只读权限: true,表示只读。 false,表示可读写。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应示例 状态码: 200 Success. { "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "comment" : "database_user_comment", "databases" : [ { "name" : "test", "readonly" : false } ] } ], "total_count" : 1}
  • URI GET /v3/{project_id}/instances/{instance_id}/db-users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 Integer 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。
共100000条