华为云用户手册

  • URI GET /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信息。 private_ip 否 String 读写内网IP。 readonly_private_ip 否 String 读内网IP。 proxy_ip 否 String 读写分离IP。 offset 否 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 Integer 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。 tags 否 String 根据实例标签键值对进行查询。 {key}表示标签键。 {value}表示标签值。 如果同时使用多个标签键值对进行查询,中间使用逗号分隔开,表示查询同时包含指定标签键值对的实例。key不能重复,key之间是与的关系。
  • 响应参数 状态码: 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地址列表。弹性云服务器创建成功后该值存在,其他情况下为空字列表。 proxy_ips Array of strings 实例读写分离IP地址列表。 GaussDB (for MySQL)实例开启代理成功后该值存在,其他情况下为空列表。 readonly_private_ips Array of strings 实例读内网IP地址列表。弹性云服务器创建成功后该值存在,其他情况下为空列表。 public_ips Array of strings 实例外网IP地址列表。 port String 数据库端口号。 type String 实例类型,取值为“Cluster”。 region String 实例所在区域。 datastore MysqlDatastoreWithKernelVersion object 数据库信息。 created String 创建时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 说明:创建时返回值为空,数据库实例创建成功后该值不为空。 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,只有数据库实例属于专属资源池才会返回该参数。 tags Array of InstanceTagItem objects 标签列表。 表6 MysqlDatastoreWithKernelVersion 参数 参数类型 描述 type String 数据库引擎,现在只支持gaussdb-mysql version String 数据库版本。 数据库支持的详细版本信息,可调用查询数据库引擎的版本接口获取。 kernel_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,为不自动续订,默认该方式。 is_auto_pay String 创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 true,为自动支付,默认该方式。 false,为手动支付。 表11 InstanceTagItem 参数 参数类型 描述 key String 标签键。 value String 标签值。 状态码: 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 DBS.200001 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 400 DBS.200004 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 400 DBS.200006 The request is null. Enter a request parameter. 请求为空,请输入请求参数。 检查是否有必选请求参数为空。 400 DBS.200021 Invalid DB instance name. 实例名非法。 检查实例名称是否正确。 400 DBS.200023 Storage space is out of range. 卷大小超出允许范围。 检查磁盘大小是否超出允许范围。 400 DBS.200024 Invalid region. Region非法。 检查可用区名称是否正确,可用区是否在可用范围内。 400 DBS.200025 Invalid AZ. 可用区取值非法。 检查可用区名称是否正确,可用区是否在可用范围内。 400 DBS.200026 Invalid storage type. 卷类型非法。 检查磁盘类型是否正确。 400 DBS.200027 Storage space must be a multiple of 10. 卷大小不是10的整数倍。 检查磁盘大小是否是10的整数倍。 400 DBS.200040 The DB engine or version is not supported. 不支持的数据库类型或版本。 检查是否数据库类型和版本是否匹配,数据库类型和版本是否符合要求。 400 DBS.200041 Invalid database version. 数据库版本非法。 检查数据库的版本号是否支持。 400 DBS.200042 The DB engine does not exist. 引擎版本不存在。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.200043 Invalid synchronize model. HA同步模式非法。 检查HA同步模式是否符合要求。 400 DBS.200048 Invalid VPC ID. VPC id非法。 检查VPC ID、名称是否正确,是否符合要求。 400 DBS.200049 Invalid subnet ID. 子网的网络id非法。 检查子网ID、名称是否正确,是否符合要求。 400 DBS.200051 Invalid HA mode. 不合法的ha模式。 检查HA模式是否符合要求。 400 DBS.200052 Invalid database root password. 数据库root密码非法。 检查用户名和密码是否匹配,密码是否符合密码要求。 400 DBS.200053 The selected specifications do not exist. 所选规格不存在。 检查规格是否正确,当前可用区是否支持该规格。 400 DBS.200054 Invalid specifications. 所选规格非法。 检查规格是否正确,当前可用区是否支持该规格。 400 DBS.200056 The maximum number of nodes has been reached. 节点个数达到最大值。 检查实例节点个数是否达到最大值。 400 DBS.200063 Invalid cluster mode. 集群模式非法。 检查传入的mode参数是否非法。 400 DBS.200086 This operation is not allowed by the DB instance status. 实例状态不允许做该操作。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.200087 The number of tags added for the DB instance has reached the quota. 单个实例标签数量达到最大配额。 检查实例的标签是否超过最大限制 400 DBS.200098 The tag already exists. 该资源标签已存在。 检查标签是否已经存在。 400 DBS.200302 Storage space must be a multiple of 10. 磁盘大小不是10的整数倍。 检查磁盘大小是否是10的倍数。 400 DBS.200306 The new storage space must be greater than or equal to the original storage space. 扩容参数不合法。 检查设置的磁盘大小是否已经超过上限。 400 DBS.200461 The parameter value is out of range. 参数值超出范围。 检查传入的port参数是否非法 400 DBS.200504 Invalid database version. 数据库版本非法。 检查传入的数据库版本号是否非法 400 DBS.200543 The job does not exist. 任务不存在 检查传入的任务Id是否非法 400 DBS.200823 The database does not exist. 数据库不存在。 检查传入的数据库是否不存在 400 DBS.200824 The database account does not exist. 数据库帐号不存在。 检查传入的用户是否存在 400 DBS.201014 This operation is not allowed by the DB instance status. 实例状态不允许做该操作。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.201101 Invalid backup cycle. 备份周期非法。 检查备份周期是否符合要求。 400 DBS.201103 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求。 400 DBS.201106 Invalid retention days. 备份保留天数非法。 检查备份保留天数是否符合要求。 400 DBS.201203 The backup file does not exist. 备份文件不存在。 检查该备份是否存在,备份是否匹配实例。 400 DBS.201207 The DB engine or version is not supported. 不支持该数据库引擎或版本。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.201208 The operation is not allowed by the backup status. 备份状态不允许。 请检查备份状态是否为"备份完成"。 400 DBS.212002 Incorrect parameter group quota. 参数组配额错误。 参数组配额超过限制,请删除无用的参数模板再重新创建。 400 DBS.212003 Operation not allowed. 不支持此操作。 默认参数模板不允许重置和删除。 400 DBS.212004 Parameter group update error. 参数组更新错误。 请检查要修改的参数值是否合法。 400 DBS.212005 The node does not belong to the group. 节点不属于组。 该节点不属于该实例,请检查实例id或节点Id是否正确。 400 DBS.212007 The DB engine does not exist. 引擎不存在。 检查数据库引擎是否存在。 400 DBS.212008 The DB engine is not supported. 不支持的引擎。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.212009 Task processing failed. 任务处理失败。 任务处理失败,请联系客服解决。 400 DBS.212010 The parameter group is being applied. 绑定正在执行。 正在应用参数模板,待完成后再进行其他操作。 400 DBS.212011 Application failed. 绑定失败。 应用参数模板失败,请联系客服解决。 400 DBS.212012 The parameter does not exist. 参数不存在。 请检查要修改的参数名是否正确。 400 DBS.212014 The node does not have a default parameter group. 节点没有默认参数组。 请检查节点ID或参数组ID是否正确。 400 DBS.212015 Partial success. 部分成功。 请检查要修改的参数名是否正确。 400 DBS.212016 Parameter update failed. 参数更新失败。 修改参数失败,请联系客服解决。 400 DBS.212017 Invalid parameter. 参数错误。 请检查参数名是否合法。 400 DBS.212025 Update failed. 更新失败。 修改参数失败,请联系客服解决 400 DBS.212030 Parameter error 参数错误。 参数模板名已经存在。 400 DBS.212032 The parameter template has been applied. 参数模板已被应用。 参数模板已经被应用,不能删除该模板。 400 DBS.212037 Parameters are incorrectly set. 参数设置不正确。 检查参数是否合法或参数是否在合法范围内。 400 DBS.270024 Proxy instance does not exist. Proxy实例不存在。 检查租户是否拥有该proxy实例,传入的proxy实例id是否正确,代理实例是否存在。 400 DBS.270025 Invalid weight. 权重非法。 检查传入的权重格式和范围是否正确。 400 DBS.270026 Invalid proxy mode. 数据库代理类型非法。 检查传入的数据库代理类型是否正确。 400 DBS.270027 Select a proxy instance. 未指定数据库代理。 检查参数数据库代理id是否为空。 400 DBS.280001 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确,是否符合要求。 400 DBS.280127 Invalid backup description. 备份描述非法。 检查备份描述是否正确,是否符合要求。 400 DBS.280128 The database name does not exist. 数据库名不存在。 检查租户是否拥有该实例,实例名或实例ID是否正确,实例是否存在。 400 DBS.280203 This is a weak password. Please enter a strong password. 这是一个弱密码,请输入一个强度大一些的密码. 检查密码是否过于简单,请更改为较复杂的密码。 400 DBS.280204 Invalid parameter. 输入参数不合法。 检查参数是否合法或参数是否在合法范围内。 400 DBS.280214 The backup does not exist. 备份不存在。 检查备份保留天数是否正确。 400 DBS.280216 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求,备份开始时间和备份结束时间的关系是否正确。 400 DBS.280235 Invalid database type. 数据库类型非法 检查数据库引擎名称是否正确。 400 DBS.280237 Datastore not specified. Datastore为空。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.280238 The DB engine or version is not supported. 不支持的数据库类型或版本。 检查是否数据库类型和版本是否匹配,数据库类型和版本是否符合要求。 400 DBS.280239 Invalid specifications. 所选规格非法。 检查规格码是否正确,规格在当前可用区是否存在,规格是否支持。 400 DBS.280241 Invalid storage type. 卷类型非法。 检查磁盘的类型是否正确,是否符合要求。 400 DBS.280242 Storage space is out of range. 卷大小超出允许范围。 检查磁盘大小的值是否正确。 400 DBS.280246 Invalid database root password 数据库root密码非法。 检查用户名和密码是否匹配,密码是否符合密码要求。 400 DBS.280250 Invalid backup retention days. 备份保留期非法。 检查输入备份数据的保留时间是否合法或是否在合法范围内。 400 DBS.280251 Invalid backup cycle. 备份周期不合法。 检查输入备份周期是否合法或是否在合法范围内。 400 DBS.280253 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求,备份开始时间和备份结束时间的关系是否正确。 400 DBS.280260 Invalid available zone mode. 无效的可用区模式。 检查可用区的模式是否有效。 400 DBS.280270 The parameter does not exist. 参数不存在。 请检查要修改的参数名是否正确。 400 DBS.280271 The parameter value is out of range. 参数值超出范围。 检查参数值是否在有效范围内。 400 DBS.280272 The tag key must be unique. 新增tag存在重复的key。 检查新增tag是否已存在。 400 DBS.280277 Invalid backup name. 备份名称非法。 检查备份名称是否正确,是否符合要求。 400 DBS.280285 Invalid AZ. 可用区取值非法。 检查可用区名称是否正确,可用区是否在可用范围内。 400 DBS.280288 Invalid FlavorRef. 规格非法。 检查规格ID是否为null或空串。 400 DBS.280311 Invalid storage space size. 存储空间大小非法。 检查磁盘大小的值是否正确,是否符合要求。 400 DBS.280325 Invalid storage information. 硬盘信息不合法。 检查磁盘大小或磁盘类型是否合法。 400 DBS.280342 Invalid cluster mode. 集群模式非法。 检查实例模式是否正确,是否符合要求,实例模式与实例ID是否匹配。 400 DBS.280364 Invalid database port. 数据库端口号无效。 检查数据库设置的端口是否可用。 400 DBS.280402 Invalid HA mode. Ha模式非法。 检查输入的Ha模式是否符合要求。 400 DBS.280404 Invalid DB instance ID or node ID format. 实例ID非法。 检查实例ID是否符合规则。 400 DBS.280434 Invalid specification code. 所选规格码非法。 检查规格码是否符合规则,规格是否存在,规格是否可用。 400 DBS.280439 Invalid records. Enter a positive integer less than 100. 无效的查询记录数,请输入小于100的正整数。 检查查询记录数是否在有效范围内。 400 DBS.280448 The storage type is sold out. 当前卷类型已售罄。 检查当前卷类型是否存在可用。 400 DBS.280449 Operation not allowed on frozen objects. 不能对冻结的对象执行该操作。 检查实例是否冻结,当前操作是否支持在实例冻结期间进行。 400 DBS.280450 The DB instance specifications are sold out. 当前规格已售罄。 规格已售罄,请更换可用区或联系客服。 400 DBS.280505 CBC error: There are unprocessed orders. CBC错误:存在未处理的订单,不能进行当前操作。 检查当前订单是否已处理完成。 400 DBS.290000 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确,是否符合要求。 400 DBS.290001 Invalid parameter letter case. 参数大小写错误。 检查传入的参数大小写是否正确,是否符合要求。 403 DBS.200010 The DB instance ID or user ID may be null, or the operation is not authorized. 实例ID和用户ID可能为空,或者操作越权。 检查入参是否正确,实例是否存在,检查租户是否操作越权。 403 DBS.200044 Resource not found or permission denied. 访问资源不存在,或者无访问权限。 检查入参是否正确,访问资源是否存在,检查租户是否有访问权限。 403 DBS.200604 The DB instance ID or user ID may be null, or the operation is not authorized. 实例ID和用户ID可能为空,或者操作越权。 检查入参是否正确,实例是否存在,检查租户是否操作越权。 403 DBS.200810 You are not allowed to create databases on read replicas. 不能在只读实例创建数据库。 只读实例不允许创建数据库,请更换读写实例创建数据库。 403 DBS.200819 You are not allowed to delete database users on read replicas. 不能在只读实例执行删除数据库用户。 只读实例不允许删除数据库用户。 403 DBS.201003 Resource not found or permission denied. 访问资源不存在,或者无访问权限。 检查入参是否正确,访问资源是否存在,检查租户是否有访问权限。 403 DBS.280015 Resource not found or permission denied. 访问资源不存在,或者无访问权限。 检查入参是否正确,访问资源是否存在,检查租户是否有访问权限。 403 DBS.280056 Invalid token. Token非法。 检查实例是否属于租户,token是否已经重新获取。 404 DBS.200002 The DB instance does not exist. 实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.200008 The E CS information of the DB instance cannot be found. 请检查数据库,确认实例的虚拟机信息,找不到该实例的虚拟机信息。 检查入参是否正确,实例状态是否正常。 404 DBS.200013 The original DB instance does not exist. 源实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.200045 The DB instance does not exist. 实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.200050 The security group does not exist or does not belong to the VPC. 安全组不存在,或不属于该VPC。 检查输入安全组ID是否合法,安全组是否存在,节点的读内网地址是否属于该安全组。 404 DBS.200408 The DB instance does not exist. 实例不存在或已删除。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.200470 The region or AZ does not exist. Region或可用区不存在。 检查可用区是否正确。 404 DBS.200501 The subnet does not exist or does not belong to the VPC. 子网不存在,或不属于该VPC。 检查子网ID、名称是否存在,是否匹配VPC。 404 DBS.200503 The VPC does not exist or does not belong to the user. VPC不存在,或不属于该用户。 检查租户是否拥有该VPC。 404 DBS.200602 The DB instance does not exist. 该实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.201010 The backup information does not exist. 备份信息不存在。 检查该备份是否存在,备份是否匹配实例。 404 DBS.201028 The DB instance does not exist. 实例不存在或已删除。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.212001 The parameter group does not exist. 参数组不存在。 检查参数组是否存在。 404 DBS.290002 The selected specifications do not exist. 所选规格不存在。 检查规格是否正确,当前可用区是否支持该规格。 404 DBS.290005 The DB instance does not exist. 该实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.290011 The DB instance does not exist. 实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.290013 Resource not found. 未找到资源。 检查入参是否正确,实例是否存在。 409 DBS.200011 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.200019 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其他操作或该实例故障,无法执行该操作,请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.200022 The DB instance name already exists. 实例名称已存在。 检查实例名称是否已经存在。 409 DBS.200047 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.200316 This operation cannot be performed because the DB instance status is Storage full. 当前实例状态为存储空间满,不能进行该操作。 实例存储空间已满,请调整存储空间大小。 409 DBS.200826 The database name already exists. 数据库名称已存在。 检查数据库名称是否合法。 409 DBS.200827 The database user already exists. 账号名称已存在。 检查数据库用户是否合法。 409 DBS.200828 You are not allowed to create a database built-in account. 数据库内置账号,用户不可创建。 检查数据库用户是否合法。 409 DBS.201202 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.201205 Backup is in progress, please wait. 正在备份中,请稍等。 实例正在备份中,等待备份完成后重试操作。 409 DBS.212006 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.280406 Operation not allowed by the DB instance type or status. 实例类型或状态受限,操作不允许。 操作不允许,可能是实例类型错误或实例状态不允许,请检查实例类型和实例状态。 413 DBS.200046 The number of DB instances has reached the quota. 实例数量达到配额。 实例数量配额达到限制,请联系管理员调整配额。 413 DBS.290003 The number of DB instances has reached the quota. 实例数量达到配额。 实例数量配额达到限制,请联系管理员调整配额。 422 DBS.212019 The parameter cannot be processed. 请求中的参数或对象不能被正确识别。 请求参数错误,请检查参数合法性。 500 DBS.108000 Server failure. 服务器错误。 服务内部错误,请联系客服。 500 DBS.108002 Server failure. 服务器错误。 服务内部错误,请联系客服。 500 DBS.108005 Server failure. 服务器错误。 服务内部错误,请联系客服。 500 DBS.200005 Server failure. 服务器错误。 服务内部错误,请联系客服。 500 DBS.200208 Server failure. 服务器错误。 服务内部错误,请联系客服。 500 DBS.200811 Failed to create the database. 创建数据库失败。 检查失败原因,可能是资源不足,请联系客服。 500 DBS.200821 Failed to modify database user permissions. 修改数据库用户权限失败。 可能是操作状态校验拦截,请重试。 500 DBS.213002 Failed to process the request. 请求处理失败。 服务内部错误,请联系客服。 500 DBS.213004 Failed to process the request. 请求处理失败。 服务内部错误,请联系客服。 500 DBS.290006 Failed to process the request. 请求处理失败。 服务内部错误,请联系客服。 500 DBS.290015 Failed to process the request. 请求处理失败。 服务内部错误,请联系客服。 父主题: 附录
  • 请求示例 查询慢日志详细信息。 POST https://{endpoint}/v3.1/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/slow-logs{ "start_time" : "2022-11-20T00:00:00+0800", "end_time" : "2022-11-29T00:00:00+0800", "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "limit" : 10, "line_num" : 1669344916000}
  • 响应示例 状态码: 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" : "2022-11-25T10:55:16.000", "client_ip" : "192.*.*.1", "line_num" : 1669344916000 } ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表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 SQL语句类型,取空值,表示查询所有语句类型,也可指定如下日志类型: INSERT UPDATE SELECT DELETE ALTER DROP CREATE database 否 String 所属数据库。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 slow_log_list Array of LtsLogSlowDetail objects 慢日志列表。 表5 LtsLogSlowDetail 参数 参数类型 描述 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地址。 line_num String 日志单行序列号。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应示例 状态码: 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 错误消息。
共100000条