华为云用户手册

  • 解决方案 随着业务数据的增加,原来申请的数据库磁盘容量可能会不足,建议用户扩容磁盘空间,确保磁盘空间足够。 如果原有规格的磁盘已是最大,请先升级规格。 云盘实例可以设置存储空间自动扩容,在实例存储空间达到阈值时,会触发自动扩容。 针对数据空间过大,可以删除无用的历史表数据。 如果实例变为只读状态,您需要先联系客服解除只读状态;如果实例非只读状态,则可以直接执行删除操作。 查看物理文件大小Top50库表,识别可以删除的历史表数据,具体操作请参见容量预估。 可在业务低峰期对碎片率高的表执行optimize优化,以便释放空间: 清理整张表使用DROP或TRUNCATE操作;删除部分数据,使用DELETE操作,如果是执行DELETE操作,需要使用OPTIMIZE TABLE来释放空间。 如果是RDS for MySQL Binlog日志文件占用过多,可以清理本地Binlog日志,来释放磁盘空间。 针对大量排序查询导致的临时文件过大,建议优化SQL查询。 查询数据库慢SQL和Top SQL,分析数据量大,行数多,响应时间长的SQL语句,并进行优化。 您还可以订阅实例健康日报来获取SQL及性能分析结果,包括慢SQL分析、全量SQL分析、性能 & 磁盘分析、性能指标趋势图,当发生风险点时及时收到诊断报告。 具体操作请参见诊断日报。
  • 修订记录 发布日期 修改说明 2024-09-19 第二十次正式发布,包含以下内容: 新增RDS for PostgreSQ L实例 inodes过多导致数据库重启缓慢。 2024-08-13 第十九次正式发布,包含以下内容: 新增RDS for SQL Server新建登录账号登录实例报错。 2024-06-19 第十八次正式发布,包含以下内容: 新增RDS for PostgreSQL数据库已有连接执行业务时报错。 2024-05-10 第十七次正式发布,包含以下内容: 新增MySQL表级时间点恢复时提示密钥失效或已删除。 2024-02-19 第十六次正式发布,包含以下内容: 新增通过DAS授权或取消授权时报错Your password does not satisfy the current policy requirements。 2023-12-27 第十五次正式发布,包含以下内容: 新增ibdata1为什么会变大。 2023-12-13 第十四次正式发布,包含以下内容: 新增RDS for MySQL插入数据提示Data too long for column。 新增RDS for MySQL慢日志里面有毫秒级别的SQL。 新增RDS for PostgreSQL通过应用程序访问数据库时提示不支持身份验证。 2023-10-27 第十三次正式发布,包含以下内容: 新增本地SSD盘规格降配选不到资源。 新增无主键表添加自增主键后导致主备节点查询数据不一致。 新增通过DAS登录实例报错Client does not support authentication protocol requested by server。 新增SQL诊断结果中记录的行数远小于慢日志中的扫描行数。 2023-09-13 第十二次正式发布,包含以下内容: 新增MySQL主备复制延迟场景及解决方案。 新增购买RDS实例报错:无 IAM 的agency相关权限。 2023-08-02 第十一次正式发布,包含以下内容: 新增RDS for MySQL Binlog生成的机制。 新增RDS for MySQL 5.6版本实例创建表报错。 2023-06-30 第十次正式发布,包含以下内容: 新增RDS for MySQL Binlog生成的机制。 新增RDS for MySQL如何定位一直存在的长事务告警。 新增RDS for MySQL部分SQL的commit时间偶现从几毫秒陡增到几百毫秒。 新增RDS for MySQL在分页查询时报错:Out of sort memory, consider increasing server sort buffer size。 新增RDS for MySQL创建用户报错:Operation CREATE USER failed。 新增RDS for MySQL使用grant授权all privileges报语法错误。 新增购买RDS实例支付报错:Policy doesn't allow bss:order:update to be performed。 新增RDS for MySQL是否可以修改数据库名称。 新增RDS for PostgreSQL有大量owner是rdsadmin的schema怎么删除。 新增RDS for PostgreSQL数据库创建索引时索引名可以包含schema名。 2022-09-09 第九次正式发布,包含以下内容: 新增RDS for MySQL全备恢复到本地提示无super权限。 新增备份期间DDL操作导致备份失败。 新增手动下发全量备份比自动下发全量备份时间长。 新增mysqldump导出数据报错权限不足。 新增MySQL主备复制原理简介。 新增主备复制延迟持续增长后自动恢复。 新增MySQL主备复制延迟场景及解决方案。 新增主备复制时延瞬间飚高回落。 新增canal工具报错权限不足。 新增canal解析Binlog报错。 新增控制台上修改long_query_time参数后未生效。 新增GROUP_CONCAT结果不符合预期。 新增RDS MySQL timeout相关参数简介。 新增命令行修改MySQL global参数失败。 新增CPU使用率高问题排查与优化。 新增内存使用超限风险与优化。 新增磁盘性能带宽超上限。 新增联合索引设置不当导致慢SQL。 新增数据库磁盘满导致被设置read_only。 新增Binlog未清理导致磁盘占用高。 新增业务死锁导致响应变慢。 新增MySQL只读实例磁盘占用远超主实例。 新增RDS for MySQL CPU升高定位思路。 新增冷热数据问题导致sql执行速度慢。 新增CPU/内存配置与TPS和QPS性能相关的问题。 新增表碎片率过高可能导致的问题。 新增复杂查询造成磁盘满。 新增长事务导致规格变更或小版本升级失败。 新增长事务导致UNDO增多引起磁盘空间满。 新增更新emoji表情数据报错Error 1366。 新增索引长度限制导致修改varchar长度失败。 新增建表时timestamp字段默认值无效。 新增自增属性AUTO_INCREMENT为什么未在表结构中显示。 新增存储过程和相关表字符集不一致导致执行缓慢。 新增RDS MySQL报错ERROR [1412]的解决方法。 新增创建二级索引报错Too many keys specified。 新增存在外键的表删除问题。 新增distinct与group by优化。 新增字符集和字符序的默认选择方式。 新增MySQL创建用户提示服务器错误。 新增delete大表数据后,再次查询同一张表时出现慢SQL。 新增设置事件定时器后未生效。 新增为什么有时候用浮点数做等值比较查不到数据。 新增开通数据库代理后有大量select请求分发到主节点。 新增连接数据库报错Access denied。 新增mariadb-connector SSL方式连接数据库失败。 新增RDS for MySQL建立连接慢导致客户端超时报connection established slowly。 新增root账号的ssl_type修改为ANY后无法登录。 新增客户端TLS版本与RDS for MySQL不一致导致SSL连接失败。 新增使用root账号连接数据库失败。 新增客户端超时参数设置不当导致连接超时退出。 新增istio-citadel证书机制导致每隔45天出现断连。 新增慢日志显示SQL语句扫描行数为0。 新增审计日志上传策略说明。 新增自增字段取值。 新增表的自增AUTO_INCREMENT初值与步长。 新增表的自增AUTO_INCREMENT超过数据中该字段的最大值加1。 新增自增字段值跳变的原因。 新增修改表的自增AUTO_INCREMENT值。 新增自增主键达到上限,无法插入数据。 新增空用户的危害。 新增pt-osc工具连接RDS for MySQL主备实例卡住。 2022-01-17 第八次正式发布,包含以下内容: 新增RDS for SQL Server规格变更或主备切换失败。 新增RDS for SQL Server如何解除和重建复制关系。 2021-05-21 第七次正式发布,包含以下内容: 新增RDS for SQL Server数据库恢复到新实例后新建用户,提示用户已存在的解决方法。 新增怎么解决执行mysqldump出现SET @@SESSION.SQL_ LOG _BIN等SQL的问题。 新增执行RENAME USER失败的解决方法。 新增表字段类型转换失败的解决方法。 新增RDS for MySQL数据库报错ERROR [1412]的解決方案。 新增RDS for MySQL创建索引失败报错[ERROR] 1071的解決方案。 新增有外键的表无法删除报错ERROR[1451]的解决方案。 新增RDS for MySQL数据库修改authentication_string字段为显示密码后无法登录。 2020-09-15 第六次正式发布,包含以下内容: 新增RDS for MySQL备份 任务失败分析思路。 新增如何将华为云上或本地的数据库备份文件恢复到RDS实例。 2020-05-30 第五次正式发布,包含以下内容: 优化RDS for MySQL大小写参数敏感类问题。 2020-04-10 第四次正式发布,包含以下内容: 新增RDS for MySQL创建表失败报错Row size too large的解决方案。 2019-11-30 第三次正式发布,包含以下内容: 新增磁盘空间满导致自动增量备份失败。 新增下载备份文件在本地恢复,登录密码错误。 2019-09-30 第二次正式发布,包含以下内容: 新增RDS for MySQL数据库报错Native error 1461的解决方案。 新增RDS for MySQL升级版本后,导致现有配置无法正常连接到MySQL-server。 新增RDS for MySQL在启用了SSL验证连接功能后,导致代码(php/java/python)等连接数据库失败。 2019-08-15 第一次正式发布。
  • 故障二 排查是否在创建RDS for MySQL用户时,添加了max_user_connections选项,导致限制了连接数。 select user,host ,max_user_connections from mysql.user where user=‘test'; 经排查发现由于设置了max_user_connections选项,导致连接失败。 增加该用户最大连接数。 alter user test@‘192.168.0.100' with max_user_connections 15。 查询变更结果,检查是否可正常访问数据库。
  • 故障一 排查密码root账号的密码是否正确。 一般情况下,ERROR 1045报错为密码错误引起的,因此需要首要排除是否密码错误问题。 select password(‘Test1i@123'); select host,user,Password from mysql.user where user=‘test1'; 使用错误的密码登录就会失败。 确认该主机是否有连接数据库实例的权限。 select user, host from mysql.user where user=‘username'; 如果该数据库用户需要从其他主机登录,则需要使用root用户连接数据库,并给该用户授权。 以加入主机IP为192.168.0.76举例: GRANT all privileges ON test.* TO 'test1'@'192.168.0.76' identified by 'Test1i@123'; flush privileges; 确认RDS for MySQL客户端和实例VIP的连通性。 尝试进行ping连接性能,若可以ping通,排除telnet数据库端口的问题。 查看实例安全组,排查是否因安全策略问题引起的报错。 查询user表信息,确认用户信息。 在排查中发现存在两个root用户。 如果用户的客户端处于192.168的网段,RDS for MySQL数据库的是对root@'192.168.%'这个用户进行认证的。而用户登录时使用的为root@'%'这个账号所对应的密码,因而导致连接失败,无法正常访问。此次问题是因密码错误引起的访问失败。 在此案例中,root@'%'为console创建实例时设置密码的账号。
  • 故障描述 客户端无法连接数据库,连接数据库时返回如下报错信息: 故障一 ERROR 1045 (28000): Access denied for user ‘root'@‘192.168.0.30' (using password:YES) 故障二 ERROR 1226 (42000):User‘test' has exceeded the‘max_user_connections' resource (current value:10) 故障三 ERROR 1129 (HY000): Host ‘192.168.0.111' is blocked because of many connection errors; unblock with 'mysqladmin flush-hosts'
  • 测试工具 HammerDB是一款开源的图形化据库负载测试和基准测试工具,可以测试任意操作系统上运行的多种数据库系统,目前有Windows和Linux版本。HammerDB支持自动化、多线程和可扩展的动态脚本。您可以使用HammerDB创建一个测试schema,加载数据,并针对OLTP(online transaction processing ,联机事务处理)和OLAP(online analytical processing,在线分析处理)场景模拟多个虚拟用户对数据库的工作负载。 本文使用的HammerDB版本为2.19,HammerDB最新下载。 安装后的界面如下。
  • 测试基准 TPC(Transaction Processing Performance Council)是一家非营利性公司,旨在确定交易处理和数据库基准,并向业界传播客观、可验证的TPC性能数据。TPC包含多种测试基准,常见的有TPC-A、TPC-C和TPC-H等,详细请参见官方文档。TPC-C是一种在OLTP基准。由于TPC-C具有多种事务类型,更复杂的数据库和总体执行结构,TPC-C与TPC-A不同且更为复杂。 本次采用TPC-C测试基准。 华为云完全基于HammerDB工具自建测试模型,不需要对模型结构进行任何优化修改。
  • 通过成本分析探索成本和使用量 常见分析成本和使用量的方式: 使用预置的分析报告进行分析:客户可以使用系统预置的成本分析报告,进行成本和使用量的数据探索。 自定义分析:客户可以把自定义分析结果保存为自定义报告,便于再次查看相同过滤条件下的分析数据。 通过标签分析成本:客户可以使用标签来管理资源,并激活为成本标签来跟踪成本。 获取成本明细:客户可以导出摊销成本的明细数据,进一步进行数据分析。 利用成本分析进行预测:客户可以使用预测功能来估计未来时间内可能消耗的成本和用量。
  • 根据计费模式优化成本 成本中心当前支持如下几种方式进行成本优化: 按需转包年包月的成本优化评估:对于长期使用的按需产品,建议客户优先采用包年或包月模式,帮助客户发现节省成本的机会。该评估基于客户E CS 、EVS、RDS历史按需资源的使用情况进行分析,为客户提供按需转包年包月的可优化资源清单和优化前后的成本对比。 资源包使用率和覆盖率分析:针对客户的资源包,分析已购买资源包的使用情况。对于使用率过低的资源包,判断是否购买过量;对于覆盖率过低的资源包,判断是否购买不足。客户可以根据分析结果优化下一周期的资源包购买。
  • 使用分配工具进行成本分配 通过关联账号维度查看成本分配:开通了企业中心的企业主客户,可以通过关联账号维度查看企业主本身、及各子账号的成本分配情况。 通过企业项目维度查看成本分配:开通了企业项目的客户,可以通过企业项目维度查看各项目的成本使用情况。 通过成本标签维度查看成本分配:成本标签创建并启用后,成本中心支持根据成本标签维护汇总成本分配情况。 使用成本单元查看成本分配:已有的关联账号、企业项目、成本标签维度不能够满足成本分配需求时,客户可以使用成本单元功能,自定义成本分拆规则。 查看CDN的成本分拆:购买按流量计费和按月结算的CDN客户,可以使用该功能对 域名 用量占比的成本进行分拆。
  • API概况 消息&短信服务所提供的接口,根据不同的API调用方式分为应用、签名、模板API和发送接收短信API。 表1 接口说明 类型 子类型 说明 应用、签名、模板API 短信应用API 可以实现查询短信应用、创建短信应用、查询应用数量、获取应用详情、修改短信应用等操作。 短信签名API 可以实现查询签名信息、创建短信签名、获取签名详情、修改短信签名、删除短信签名、申请激活签名、查询申请文件、上传申请文件等操作。 短信模板API 可以实现查询发送国家、查询短信模板、创建短信模板、获取模板详情、修改短信模板、删除短信模板、查询模板变量等操作。 发送接收短信API 发送短信API 向单个或多个用户发送相同内容的短信。 发送分批短信API 向多个用户发送不同内容的短信。 接收状态报告API 用于接收短信发送状态报告。 接收上行短信API 用于接收用户回复的短信。 如有任何疑问,请联系华为云智能客服,将有专人为您解答。
  • 申请门槛 合作伙伴已加入服务伙伴发展路径且达到角色认证阶段。 本年度内至少获得1个激励范围内的一级能力标签。 表1 一级能力标签范围及申请区域 一级能力标签 区域范围 数据库服务能力 全球 大数据服务能力 全球 数据仓库 服务能力 仅限中国区 AI平台服务能力 仅限中国区 DevSecOps服务能力 仅限中国区 解决方案集成实施服务能力 仅限中国区 公有云云运维服务能力 仅限中国区 卓越运营服务能力 仅限中国区 应用现代化服务能力 仅限中国区 注:华为云可能对以上激励范围做不定期变更(包括新增或移除)。
  • 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 IDE.00010070 Free user limit not Found! 免费资源的配置无法找到,请稍后再试 请稍后再试 403 IDE.00000004 not subscribe cloudide 未开通CloudIDE服务 开通CloudIDE服务 403 IDE.00000005 suspended 您的账户已欠费冻结 账户充值 403 IDE.00000007 not verified 账号未实名认证,请认证后再试 账号实名认证 403 IDE.00000010 account is not normal 账号状态异常,请稍后再试 检查账号是否异常 403 IDE.00010000 OPERATE LIMIT 操作受限,请确认后再操作 请确认是否有权限 403 IDE.00010085 User already exists 用户已经存在,请确认后再试 确认用户是否已存在 403 IDE.00010086 blackList user 黑名单用户不能添加 使用白名单用户 403 IDE.00010092 no such action 没有这样的动作 请确认是否有权限 406 IDE.00000011 unusual limit 15 minute 15分钟内累计输入用户名错误5次,请15分钟后再试 请15分钟后再试 406 IDE.00000097 parameter is null or error 参数错误 参数规格:参考相应的API文档 406 IDE.00010027 Instance name is exist 实例已经存在 修改实例名 406 IDE.00010028 Instance is Starting, Can't remove it now 实例正在启动,不能被删除,请稍后再试 实例停止后在删除 406 IDE.00010029 Instance has been deleted or is in deleting 实例已经被删除或正在删除,请勿重复删除 等待操作完成 406 IDE.00010030 instance not exist 实例不存在,请确认后操作 确认实例是否存在 406 IDE.00010048 active error:instance status error 实例状态异常 请稍后再试 406 IDE.00010054 Could not stop the ide, instance status is not running or starting 实例不在运行状态,无法停止,请稍后再试 实例运行后在停止 406 IDE.00010058 current user is not subUser in Domain 当前用户不是该组织下的子账号,请确认后操作 确认用户是否为组织下子账号 406 IDE.00010071 Free resource not enough! 免费资源不足,请稍后再试 使用其他免费技术栈资源或购买cloudide服务 406 IDE.00010087 not whiteList user 您不是白名单用户,请确认后操作 确认是否为白名单用户 406 IDE.00010091 Organization already existed 组织已经存在,请确认后操作 确认组织是否存在 406 IDE.00010101 INSTANCE_START_ERROR 实例启动失败,请稍后再试 请稍后再试 406 IDE.00010103 instance number limit 实例数量已经超过上限,请删除旧有实例后再试 删除旧实例 406 IDE.00010104 instance resource limit 实例资源受限,请稍后再试 请稍后再试 406 IDE.00010105 instance arm number limit arm实例数量已经超过上限,请删除旧有实例后再试 删除旧实例 406 IDE.00040001 config error 配置错误 检查配置 406 IDE.00040002 label is not correct 标签不正确 参数规格:参考相应的API文档 406 IDE.00040004 The character string length is incorrect. 字符串长度不匹配 检查字符串 406 IDE.00040005 Unsupported for spec platform or stack 不支持的平台或技术栈规格 参数规格:参考相应的API文档 500 IDE.00000040 outer http request error 外部HTTP请求错误 请稍后再试 500 IDE.00000100 Internal Server Error 服务异常,请稍后再试 服务异常,请稍后再试 500 IDE.00020001 get Repository By ProjectId error 获取仓库失败 请稍后再试 500 IDE.00020002 get Branches By RepoName error 获取分支失败 请稍后再试 500 IDE.00020003 get Related Project error 获取工程失败,请稍后再试 请稍后再试 500 IDE.00020004 get Project user error 获取工程用户信息失败,请稍后再试 请稍后再试
  • 背景说明 同步至云端的备份无法创建服务器。 同步的备份只能用于恢复至其他的云服务器,可以恢复至系统盘和数据盘。 执行恢复操作前,请务必按照操作步骤完成安全组的配置,否则可能会导致恢复失败。 VMware虚拟机使用LVM管理系统盘时,不支持云上恢复虚拟机。 云上恢复仅支持恢复到同类型操作系统,如Linux到Linux,Windows到Windows。 操作系统(OS)的启动方式需要与镜像的启动方式相同,如果IDC内VMware虚拟机的启动方式为UEFI(或BIOS),CBR执行备份后备份数据的启动方式与备份源相同,上云副本在云上恢复时,恢复的目标主机原始镜像的启动方式也需要是UEFI(或BIOS),如果OS的启动方式与镜像启动方式不匹配,可能会导致无法启动。
  • 更改安全组 安全组是一个逻辑上的分组,为同一个 虚拟私有云VPC 内具有相同安全保护需求并相互信任的弹性云服务器提供访问策略。安全组创建后,用户可以在安全组中定义各种访问规则,当弹性云服务器加入该安全组后,即受到这些访问规则的保护。安全组的默认规则是在出方向上的数据报文全部放行,安全组内的弹性云服务器无需添加规则即可互相访问。系统会为每个云账号默认创建一个默认安全组,用户也可以创建自定义的安全组。 使用VMware备份恢复前需要先更改安全组。云备份为了您的网络安全考虑,在使用前未设置安全组入方向,需要您手动进行配置。 安全组的出方向需要设置允许100.125.0.0/16网段的1-65535端口,入方向需要设置允许100.125.0.0/16网段的59526-59528端口。出方向规则默认为0.0.0.0/0,即数据报文全部放行。如果未修改出方向默认规则,则无需重新设置。 进入云服务器控制台。 单击左侧导航树中的“弹性云服务器”或“裸金属服务器”,在服务器界面选择目标服务器。进入目标服务器详情。 选择“安全组”页签,选择目标安全组,弹性云服务器界面单击列表右侧“更改安全组规则”。裸金属服务器单击“更改安全组”,在弹出框中单击“管理安全组”。 在安全组界面,选择“入方向规则”页签,单击“添加规则”,弹出“添加入方向规则”对话框,如图1所示。选择“TCP”协议,在“端口”中输入“59526-59528”,在源地址中选择“IP地址”,输入“100.125.0.0/16”。适当补充描述后,单击“确定”,完成入方向规则设置。 图1 增加入方向规则 选择“出方向规则”页签,单击“添加规则”,弹出“添加出方向规则”对话框,如图2所示。选择“TCP”协议,在“端口”中输入“1-65535”,在目的地址中选择“IP地址”,输入“100.125.0.0/16”。适当补充描述后,单击“确定”,完成出方向规则设置。 图2 增加出方向规则
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-Traceid 否 String 业务跟踪id(必须58位)
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-Traceid 否 String 业务跟踪id(必须58位) 表2 请求Body参数 参数 是否必选 参数类型 描述 shortUrl 是 String 分享shortUrl extractCode 是 String 分享码
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-Traceid 否 String 业务跟踪id(必须58位) 表3 请求Body参数 参数 是否必选 参数类型 描述 deptIds 否 Array of strings 部门id列表 groupIds 否 Array of strings 用户组id列表 userIds 否 Array of strings 用户id列表 permission 否 SharePermission object 分享权限(后续支持) expireTime 否 String 失效时间 extractCode 否 String 提取码 comment 否 String 分享留言 validDays 是 Integer 分享有效天数0-365. 0表示不变 表4 SharePermission 参数 是否必选 参数类型 描述 preview 否 Boolean 预览权限 edit 否 Boolean 编辑权限 download 否 Boolean 下载权限
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 shareLink shareLink object 分享链接信息 表6 shareLink 参数 参数类型 描述 shareId String 分享id shortUrl String 分享链接 extractCode String 提取码 createTime String 创建时间 updateTime String 修改时间 expireTime String 失效时间 linkUrl String 分享链接 shareTime String 分享时间 scope Integer 范围 displayName String 显示名称 status Integer 状态 viewCnt String 浏览次数 downloadCnt String 下载次数 saveCnt String 保存次数
  • 请求示例 PUT /koodrive/ose/v1/share/{shareId} { "deptIds" : [ "string" ], "groupIds" : [ "string" ], "userIds" : [ "string" ], "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:00:39.952Z", "extractCode" : "string", "comment" : "string", "validDays" : 0 }
  • 响应示例 状态码: 200 OK { "code" : "string", "msg" : "string", "shareLink" : { "shareId" : "string", "shortUrl" : "string", "extractCode" : "string", "createTime" : "2024-06-03T02:00:39.953Z", "updateTime" : "2024-06-03T02:00:39.953Z", "expireTime" : "2024-06-03T02:00:39.953Z" } }
  • 请求示例 将空间标识为IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4 空间下,文件id为FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y的文件重命名为“下载”。 POST /koodrive/ose/v1/files/rename/FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y Authorization:Bearer+10f88*********4791e9ff { "name": "下载", "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4", "renameMode": 2 }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-Traceid 否 String 消息日志跟踪标识(必须58位) language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 x-session-id 是 String 会话标识
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-Traceid 否 String 消息日志跟踪标识(必须58位) language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应信息 nextCursor String 分页游标,如果不存在,代表已返回最后一个 shareLinks Array of ShareWithMeLink objects 分享链接列表 表4 ShareWithMeLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 ownerId String 分享人id ownerName String 分享人姓名 displayName String 展示名称 files Array of ShareFileInfo objects 分享的文件列表 permission SharePermission object 分享权限(后续支持) expireTime String 失效时间 status Integer 分享状态,0:根据失效时间判断,1:文件已被删除,2:已失效 comment String 分享留言 containerId String 空间id downloadCnt Integer 下载次数 saveCnt Integer 保存次数 scope String 范围 updateTime String 更新时间 viewCnt String 浏览次数 表5 ShareFileInfo 参数 参数类型 描述 id String *文件id fileName String *文件名,最长160个字节 fileType String 文件类型,外部输入,最长250个字符 mimeType String *内容类型 size Integer 文件大小 parentFolder Array of strings 父目录ID列表,注意:当前只取第一个父母Id fileSuffix String 文件后缀,fullFileExtension最后一个字符串 containers Array of strings 空间标识 downloadLinks Array of downloadLinks objects 下载链接 recycled Boolean 是否在回收站标识 表6 downloadLinks 参数 参数类型 描述 usage String 用途默认:'content'-实体内容、'thumbnail'-缩略图,业务可以扩展该字段 downloadLink String 下载链接 表7 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限
  • 响应示例 状态码: 200 OK { "code" : "string", "msg" : "string", "nextCursor" : "string", "shareLinks" : [ { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "2024-06-03T02:02:00.797Z", "ownerId" : "string", "ownerName" : "string", "displayName" : "string", "files" : [ { "id" : "string", "fileName" : "string", "fileType" : "string", "mimeType" : "string", "size" : 0, "parentFolder" : [ "string" ], "fileSuffix" : "string", "containers" : [ "string" ] } ], "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:02:00.797Z", "status" : 0, "comment" : "string" } ] }
  • URI GET /koodrive/ose/v1/share/received 表1 Query参数 参数 是否必选 参数类型 描述 pageSize 否 Integer 每页返回的个数,默认是100,可接受值最大值是100。注意在到达最后的列表之前,实际有可能返回部分或者空结果 pageCursor 否 String 当前页游标,由前一个响应的nextCursor获取,默认为0 sortType 否 Integer 排序类型,4:分享时间(默认) sortDirection 否 Integer 排序方向,1:升序,2:降序(默认) displayName 否 String 支持按照展示名称模糊匹配
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-Traceid 否 String 业务跟踪id(必须58位)
  • 请求示例 POST /koodrive/ose/v1/share/files { "shortUrl" : "string", "parentFolder" : "string", "pageSize" : 0, "pageCursor" : "string", "sortType" : 0, "sortDirection" : 0, "kdstoken" : "string", "refreshCount" : true, "fileName" : "string" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应信息 nextCursor String 分页游标,如果不存在,代表已返回最后一个 link CommonShareLink object 访问链接公共信息 files Array of ShareFile objects 分享文件列表 表4 CommonShareLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 shareTime String 分享时间 ownerId String 分享人id ownerName String 分享人姓名 permission SharePermission object 分享权限(后续支持) expireTime String 失效时间 status Integer 分享状态,0:根据失效时间判断,1:文件已被删除,2:已失效 expireDate String 有效期 表5 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限 表6 ShareFile 参数 参数类型 描述 id String *文件id fileName String *文件名,最长250个字节 fileType String 文件类型,外部输入 parentFolder Array of strings 父目录ID列表,注意:当前只取第一个父母Id fileSuffix String 文件后缀,fullFileExtension最后一个字符串 size Integer 文件大小 containers Array of strings 空间标识 downloadLinks String 下载链接 editedTime String 文件修改时间
共100000条