华为云用户手册

  • 背景说明 当购买需求管理、代码托管、测试计划等单服务套餐时,租户管理员可以通过“服务级权限管理”页面,按服务为项目成员分配访问权限。 服务级权限管理仅对需求管理、代码托管、测试设计、测试计划等计费项中有“用户数”的服务生效。任何加入项目的成员均可根据实际购买情况使用代码检查、构建、部署、流水线等服务。 项目中添加成员时会根据已购买服务的套餐人数自动分配服务访问权限,直到达到套餐人数规格,您可以随时到本页面手动分配人员访问权限。 例如:团队中有5个人A、B、C、D、E, 购买2人规格需求管理套餐、3人规格代码托管套餐。创建项目后,按照A、B、C、D、E的顺序,依次将5个人加入项目。此时,A、B两人默认拥有两个服务的访问权限,C有 代码托管服务 的访问权限,D、E对两个服务没都访问权限。租户管理员可以根据实际需要,在“服务级权限管理”页面中为5个人开启或关闭两个服务的访问权限,其中最多可为2个人设置需求管理访问权限、最多可为3个人设置代码托管访问权限。 首次购买某类套餐时,按用户名升序自动分配服务访问权限,直到达到套餐人数规格;非首次购买同类套餐时,恢复为上一次的成员服务访问权限。 例如:团队中有5个人A、B、C、D、E,当前已购买5人规格需求管理套餐,并已在项目中添加5人。此时购买3人规格代码托管套餐,默认A、B、C将拥有代码托管服务的访问权限。租户管理员取消A、B的代码托管服务访问权限,并为D、E授权访问代码托管服务。当代码托管套餐到期后,C、D、E失去代码托管服务访问权限;如果再次购买3人规格代码托管套餐,则C、D、E将恢复代码托管服务的访问权限。
  • 接口约束 该接口公测中,如需使用请联系客服申请。 账户余额必须大于等于0元,余额不足会导致自动扩容失败。 该接口仅支持RDS for MySQL和RDS for PostgreSQL磁盘大小为40GB及以上的云盘实例(即存储类型为SSD云盘或极速型SSD)。 实例在进行规格变更、内核小版本升级、备机迁移、重启时,不能进行自动扩容。 包周期实例存在未完成订单时,不会自动扩容。 实例状态为“正常”和“存储空间满”时可以进行扩容。最大可自动扩容至4000GB。
  • 请求示例 设置实例可用存储空间小于等于总空间10%或者为10GB时触发自动扩容,扩容上限为4000GB。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/disk-auto-expansion { "switch_option" : true, "limit_size" : 4000, "trigger_threshold" : 10 } 设置实例可用存储空间小于等于总空间10%或者为10GB时触发自动扩容,扩容上限为4000GB,每次自动扩容当前存储空间的20%。 { "switch_option" : true, "limit_size" : 4000, "trigger_threshold" : 10, "step_percent" : 20 }
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 switch_option 是 Boolean 是否开启自动扩容。 true为开启。 false为关闭。 limit_size 否 Integer 扩容上限,单位GB。“switch_option”为true时,该参数必填。 取值范围40GB~4000GB,需要大于等于实例当前存储空间总大小。 trigger_threshold 否 Integer 可用存储空间百分比,小于等于此值或者为10GB时触发扩容。“switch_option”为true时,该参数必填。 枚举值: 10 15 20 step_percent 否 Integer 每次自动扩容的步长,单位为百分比,即每次自动扩容当前存储空间的百分比。取值范围为5%~50%。 “switch_option”为true,且开启了自定义扩容步长功能时,该参数可选,不填时默认为20%。
  • 响应消息 正常响应要素说明 表2 要素说明 参数 参数类型 描述 total_count Integer 历史记录总数。 histories Array of objects 参数修改历史。 详情请参见表3。 表3 histories字段数据结构说明 名称 参数类型 说明 parameter_name String 参数名称。 old_value String 旧参数值。 new_value String 新参数值。 update_result String 更新结果。 SUC CES S:成功。 FAILED:失败。 applied Boolean 是否已应用。 true:已应用。 false:未应用。 update_time String 参数修改时间。 apply_time String 参数应用时间。 正常响应样例 { "total_count" : 3, "histories" : [ { "parameter_name" : "fill factor (%)", "old_value" : "0", "new_value" : "2", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:39:21+0000", "apply_time" : "2022-10-31T01:46:29+0000" }, { "parameter_name" : "remote login timeout (s)", "old_value" : "10", "new_value" : "20", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:38:36+0000", "apply_time" : "2022-10-29T09:38:36+0000" }, { "parameter_name" : "remote query timeout (s)", "old_value" : "600", "new_value" : "601", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:40:30+0000", "apply_time" : "2022-10-29T09:40:30+0000" } ] } 异常响应 请参见异常请求结果。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/configuration-histories?offset={offset}&limit={limit}&start_time={start_time}&end_time={end_time}¶m_name={param_name} 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 offset 否 Integer 分页参数。 缺省值:0 limit 否 Integer 分页参数。 缺省值:10 start_time 否 String 开始时间默认为当前时间的前7天,格式:2020-09-01T18:50:20Z end_time 否 String 结束时间默认为当前时间,格式:2020-09-01T18:50:20Z param_name 否 String 参数名称。
  • 故障二的解决方案 这类问题是由于已有连接被释放掉,使用已经释放的连接会出现这个报错。可能原因主要有以下几种: 网络链路问题 数据库重启或后端进程crash 空闲连接超时释放 解决方案: 首先排查网络连通性,判断是否有网络链路因素(丢包率、重传比例高)导致连接断开。 如果没有网络层面的问题,需要排查业务是否有其他报错导致连接断开。 如果业务上也没有其他报错,则尝试排查连接超时参数(如jdbc连接池参数sockettimeout和connecttimeout),如果设置值较小,会导致连接被主动释放。
  • 故障描述 客户端通过已有连接执行业务时,返回如下报错信息: 故障一 org.postgresql.util.PSQLException: An I/O error occurred while sending to the backend. 故障二 org.postgresql.util.PSQLException: The connection attempt failed ... Caused by: java.net.SocketException: Connection reset
  • 修订记录 发布日期 修改说明 2024-06-18 第十八次发布,包含以下内容: RDS for MySQL内核版本说明更新RDS for MySQL 8.0.28版本说明。 2024-05-23 第十七次发布,包含以下内容: RDS for MySQL内核版本说明补充RDS for MySQL 8.0.32版本更新说明。 2024-04-11 第十六次发布,包含以下内容: RDS for PostgreSQL内核版本说明补充RDS for PostgreSQL 16版本更新说明。 2023-12-01 第十五次发布,包含以下内容: RDS for MySQL内核版本说明补充RDS for MySQL 5.7的版本更新说明。 2023-10-30 第十四次发布,包含以下内容: RDS for MySQL内核版本说明补充RDS for MySQL 8.0、RDS for MySQL 5.7、RDS for MySQL 5.6的版本更新说明。 2023-09-28 第十三次发布,包含以下内容: 新增RDS for PostgreSQL内核。 2023-09-21 第十二次发布,包含以下内容: 新增RDS for MariaDB内核。 2023-06-28 第十一次发布,包含以下内容: RDS for MySQL内核版本说明补充RDS for MySQL 5.7的版本更新说明。 2022-09-09 第十次发布,包含以下内容: RDS for MySQL内核版本说明补充RDS for MySQL 8.0、RDS for MySQL 5.7、RDS for MySQL 5.6的版本更新说明。 2022-06-01 第九次发布,包含以下内容: RDS for MySQL内核版本说明补充RDS for MySQL 8.0、RDS for MySQL 5.7、RDS for MySQL 5.6的版本更新说明。 2022-01-26 第八次发布,包含以下内容: RDS for MySQL内核版本说明补充RDS for MySQL 5.7的版本更新说明。 2021-11-26 第七次发布,包含以下内容: RDS for MySQL内核版本说明补充RDS for MySQL 5.7的版本更新说明。 2021-08-07 第六次发布,包含以下内容: RDS for MySQL内核版本说明补充RDS for MySQL 8.0、RDS for MySQL 5.7、RDS for MySQL 5.6的版本更新说明。 2021-06-10 第五次发布,包含以下内容: 优化主动终止空闲事务中的“idle_transaction_timeout”参数。 2021-04-13 第四次发布,包含以下内容: RDS for MySQL内核版本说明补充RDS for MySQL 8.0、RDS for MySQL 5.7、RDS for MySQL 5.6的版本更新说明。 MDL锁视图补充performance_schema描述。 2021-01-21 第三次发布,包含以下内容: 补充内核版本说明。 2020-11-20 第二次发布,包含以下内容: RDS for MySQL 8.0、RDS for MySQL 5.7、RDS for MySQL 5.6补充内核版本更新说明。 2020-10-09 第一次发布。
  • 在费用中心续费 登录管理控制台。 单击“控制台”页面上方“费用与成本”,在下拉菜单中选择“续费管理”。 进入“续费管理”页面。 自定义查询条件。 可在“手动续费项”、“自动续费项”、“到期转按需项”、“到期不续费项”页签查询全部待续费资源,对资源进行手动续费的操作。 图3 续费管理 所有需手动续费的资源都可归置到“手动续费项”页签,具体操作请参见如何恢复为手动续费。 手动续费资源。 单个续费:在资源页面找到需要续费的资源,单击操作列的“续费”。 图4 单个续费 批量续费:在资源页面勾选需要续费的资源,单击列表左上角的“批量续费”。 图5 批量续费 选择续费时长,判断是否勾选“统一到期日”,将到期时间统一到各个月的某一天(详细介绍请参见统一包年/包月资源的到期日)。确认配置费用后单击“去支付”。 图6 续费确认 进入支付页面,选择支付方式,确认付款,支付订单后即可完成续费。
  • 修订记录 发布日期 更新特性 2024-02-26 第十次正式发布。 查询实例会话列表新增参数node_id。 2023-09-18 第九次正式发布。 新增执行SQL诊断。 新增获取诊断结果。 2023-06-15 第八次正式发布。 优化请求示例描述。 2023-05-29 第七次正式发布。 新增设置共享链接。 新增删除共享链接。 2022-11-30 第六次正式发布。 新增查看SQL限流开关状态。 新增设置SQL限流开关状态。 新增查询SQL限流规则列表。 新增创建SQL限流规则。 新增删除SQL限流规则。 新增查询SQL限流任务。 新增导出TopSQL模板列表。 新增导出SQL执行耗时区间数据。 新增导出慢SQL模板列表。 2022-08-31 第五次正式发布。 修改查询元数据锁列表的响应示例。 修改查询InnoDB锁等待列表的响应示例。 2021-11-19 第四次正式发布。 修改全量SQL和慢SQL的使用限制。 2021-09-16 第三次正式发布。 新增查询云DBA配额。 2021-03-11 第二次正式发布。 新增全量SQL和慢SQL接口参考。 2021-03-08 第一次正式发布。
  • 基础概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在 IAM 中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要求,或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目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。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 是 application/json Content-Length 请求body长度,单位为Byte。 POST请求为可选,GET请求该字段值留空。 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK 认证方式的接口请求或者多project场景采用AK/SK认证的接口请求则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 以下仅为Token示例片段 MIIPAgYJKoZfegerIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见IAM与企业管理的区别。 DAS支持的自定义策略授权项请参见DAS授权分类。
  • 请求示例 获取数据库列表。 GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/fa7d0b6e40704cd48facf9889d6e745bin01/space-analysis?datastore_type=MySQL&object_type=database&show_instance_info=true&offset=0&limit=100 获取表列表。 GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/fa7d0b6e40704cd48facf9889d6e745bin01/space-analysis?datastore_type=MySQL&object_type=table&database_id=24937&show_instance_info=false&offset=0&limit=100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Long 记录总数 db_objects Array of DbObjectSpaceInfo objects 数据库对象列表 instance_info InstanceSpaceInfo object 实例空间信息。数据来源于文件系统。已用空间包含数据空间、日志空间和其他空间,其他空间包括引擎产生的临时文件等。 表5 DbObjectSpaceInfo 参数 参数类型 描述 object_type String 对象类型,如果是table,同时需要传database_id 枚举值: database table object_name String 对象名称 object_id String 对象ID used_size Long 已使用空间,以字节为单位 data_size Long 数据空间,以字节为单位 index_size Long 索引空间,以字节为单位 estimated_rows Long 估算值行数,以字节为单位 表6 InstanceSpaceInfo 参数 参数类型 描述 total_size Long 实例总空间,以字节为单位。 GaussDB (for MySQL)不会返回总空间 used_size Long 已使用空间,以字节为单位 data_size Long 数据空间,以字节为单位 log_size Long 日志空间,以字节为单位 avg_daily_growth Long 近七日的数据平均日增长量,以字节为单位 last_result_time Long 最后一次分析的结果时间,毫秒单位时间戳 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 Success. { "db_objects" : [ { "object_type" : "database", "object_name" : "db_01", "object_id" : "24937", "used_size" : 171687936, "data_size" : 129646592, "index_size" : 38895616 }, { "object_type" : "database", "object_name" : "test_db", "object_id" : "24936", "used_size" : 84574208, "data_size" : 41484288, "index_size" : 38895616 } ], "total" : 2, "instance_info" : { "total_size" : 42949672960, "used_size" : 2635862016, "data_size" : 256262144, "log_size" : 2100001252, "avg_daily_growth" : 86016, "last_result_time" : 1615323657065 } }
  • URI GET /v3/{project_id}/instances/{instance_id}/space-analysis 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 object_type 是 String 对象类型 缺省值:database 枚举值: database table database_id 否 String 数据库ID offset 否 String 偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。offset必须是limit的整数倍。 缺省值:0 limit 否 String 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。 缺省值:100 show_instance_info 否 String 是否返回实例级别数据,取值:true或者false 缺省值:true datastore_type 是 String 引擎类型 枚举值: MySQL GaussDB(for MySQL)
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 start_time 是 String 开始日期,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 end_time 是 String 结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。只能查询当前时间前一个月内的错误日志。 level 否 String 日志级别,默认为ALL。 枚举值: ALL INFO LOG WARNING ERROR FATAL PANIC NOTE line_num 否 String 日志单行序列号,第一次查询时不需要此参数,后续分页查询时需要使用,可从上次查询的返回信息中获取。line_num应在start_time和end_time之间。 search_type 否 String 搜索方式。默认forwards。配合line_num使用,以line_num为起点,向前搜索或向后搜索。 limit 否 Integer 每页多少条记录(查询结果),取值范围是1~100,不填时默认为10。
  • 请求示例 查询错误日志,每页10条记录。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/error-logs { "start_time":"2023-01-05T08:00:00+0800", "end_time":"2023-01-11T20:00:00+0800", "limit":10, "line_num":"1672908793000000000", "search_type":"forwards" }
  • 响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 error_log_list Array of objects 日志数据集合。 详情请参见表4。 表4 error_log_list字段数据结构说明 名称 参数类型 说明 time String 日期时间,UTC时间。 level String 日志级别。 content String 错误日志内容。 line_num String 日志单行序列号。 正常响应样例 { "error_log_list" : [ { "time" : "2022-08-23T22:59:17Z", "level" : "WARNING", "content" : "Occur error when reading bytes from a network handler. Client actively closes the connection.", "line_num" : "1595659490239433658" } ] } 异常响应 请参见异常请求结果。
  • 请求示例 查询慢日志数据,每页10条记录。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slow-logs { "start_time":"2023-01-02T23:58:57+0000", "end_time":"2023-01-06T01:47:20+0000", "limit":10, "line_num":"1672908793000000000" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。取值: create,表示添加标签。 delete,表示删除标签。 tags 是 Array of BatchTagActionTagOption objects 标签列表。 表4 BatchTagActionTagOption 参数 是否必选 参数类型 描述 key 是 String 标签键。最大长度128个unicode字符,不能为null或者空字符串,不能为空格,校验和使用之前会自动过滤掉前后空格。 字符集:0-9,A-Z,a-z,“_”,“-”,中文。 value 否 String 标签值。最大长度255个unicode字符,可以为空字符串。 字符集:0-9,A-Z,a-z,“_”,“.”,“-”,中文。 “action”值为“create”时,该参数必选。 “action”值为“delete”时,该参数可选。 说明: 删除标签时,如果value有值,则按照key/value匹配删除;如果value没有值,则按照key删除。
  • 请求示例 URI样例 POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags/action 添加2个标签 { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] } 删除2个标签 { "action" : "delete", "tags" : [ { "key" : "key1" }, { "key" : "key2", "value" : "value3" } ] }
  • 接口约束 该接口支持如下数据库实例: GeminiDB Cassandra GeminiDB Mongo GeminiDB Influx GeminiDB Redis 一个数据库实例具有20个标签配额,且标签key唯一。 添加标签时,如果请求体中存在重复key,调用该接口将会报错。 添加标签时,如果请求体中的key与指定实例已有的key重复,将会覆盖已有key对应的value的值。 如果待删除的标签不存在,调用该接口将默认处理成功,删除时,不对标签字符集范围做校验。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 commands 是 Array of objects 高危命令与对应重命名命令。详情请参考表4。 表4 CommandInfo 参数 是否必选 参数类型 描述 origin_name 是 String 原高危命令,当前支持的有:keys、flushdb、flushall、hgetall、hkeys、hvals、smembers name 是 String 当前生效的命令名称,当为空时表示命令禁用,允许修改为30个字符以内数字、字母和下划线的组合 最小长度:0 最大长度:30
  • 请求示例 URI样例 PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/41409e5a49ee467287d738b9b6d0adcbin12/high-risk-commands 修改高危命令 { "commands" : [ { "origin_name" : "keys", "name" : "newKeys" }, { "origin_name" : "flushdb", "name" : "newFlushdb" }, { "origin_name" : "flushall", "name" : "newFlushall" }, { "origin_name" : "hgetall", "name" : "newHgetall" }, { "origin_name" : "hkeys", "name" : "newHkeys" }, { "origin_name" : "hvals", "name" : "newHvals" }, { "origin_name" : "smembers", "name" : "newSmembers" } ] }
共100000条