ZStack Cloud 产品文档
全部版本
全部版本
ZStack Cloud 4.4.0>产品手册>CLI命令使用手册>设置>全局设置>全局设置条目>apiTimeout
下载PDF

apiTimeout

调用API时传入timeout参数
ZStack的RESTful API支持在HTTP header中通过X-API-Timeout传入timeout，单位为秒，例如：
X-API-Timeout: 300

该timeout会自动赋值给API产生的下游消息和agent command。

通过全局配置设置API的默认timeout

如果API调用者未通过X-API-Timeout HTTP Header指定timeout，ZStack会通过全局配置获得该API的默认timeout。

所有操作类API（非读API，例如query api）都有一个全局配置项控制其默认timeout。其全局配置如下：
category： apiTimeout
name: API的java class全名，例如：org.zstack.header.vm.APICreateVmInstanceMsg

单位为毫秒。

全局配置也支持字符串配置timeout的方式，例如300s, 1h, 2m, 3d, 10w, 1y，这里s/m/h/d/w/y分别代表:秒/分/小时/天/周/年，如没有后缀则代表毫秒。

配置创建云主机的timeout示例：
UpdateGlobalConfig category=apiTimeout name=org.zstack.header.vm.APICreateVmInstanceMsg value=3h
兼容历史版本的zstack.properties配置API timeout
历史版本（3.2.0之前）可以在zstack.properties配置API的默认超时时间，例如：
ApiTimeout.org.zstack.header.image.APIAddImageMsg = timeout::3h
3.2.0兼容这种方式。当升级到3.2.0及后续版本时，在创建对应API的全局配置时，使用zstack.properties中配置的API timeout值作为该API全局配置的默认值。
说明: 升级到3.2.0后，通过zstack.properties配置API timeout的方式已不再需要，所有API的超时可通过全局配置设置。
注意事项
  • 读API未提供全局配置设置超时时间。
    读API主要为数据库读取操作，不应过长，默认超时时间为5分钟，可以在zstack.properties中通过api.timeout.syncCallAPI配置所有读API的超时时间，例如：
    api.timeout.syncCallAPI = 10m
  • 非API触发的内部消息的超时时间只能通过zstack.properties配置。
    非API触发的内部消息是指该消息是内部服务发起的，例如HA服务发出的StartVmInstanceMsg，此类内部消息的超时时间也只能通过zstack.properties配置，默认为30分钟：
    api.timeout.internalMessage = 30m
名字 描述 默认值 可选的参数值
org.zstack.header.image.APIAddImageMsg
  • 默认为3h，单位为s/m/h/d（即：秒/分/小时/天），用于设置添加镜像的超时上限。
  • 如果超过此时间，镜像还未添加完成，此操作会失败。
 3h [5min,+∞)
org.zstack.header.image.APICreateRootVolumeTemplateFromRootVolumeMsg
  • 默认为3d，单位为s/m/h/d（即：秒/分/小时/天），用于设置从根云盘创建云盘镜像的超时上限。
  • 如果超过此时间，云盘镜像还未创建完成，此操作会失败。
 3d [5min,+∞)
org.zstack.header.image.APICreateDataVolumeTemplateFromVolumeMsg
  • 默认为3d，单位为s/m/h/d（即：秒/分/小时/天），用于设置从数据云盘创建数据云盘镜像的超时上限。
  • 如果超过此时间，数据云盘镜像还未创建完成，此操作会失败。
 3d [5min,+∞)
org.zstack.header.volume.APICreateDataVolumeFromVolumeTemplateMsg
  • 默认为3d，单位为s/m/h/d（即：秒/分/小时/天），用于设置从云盘镜像创建数据云盘的超时上限。
  • 如果超过此时间，数据云盘还未创建完成，此操作会失败。
 3d [5min,+∞)
org.zstack.header.image.APICreateRootVolumeTemplateFromVolumeSnapshotMsg
  • 默认为3h，单位为s/m/h/d（即：秒/分/小时/天），用于设置从云盘快照创建根云盘镜像的超时上限。
  • 如果超过此时间，根云盘镜像还未创建完成，此操作会失败。
 3h [5min,+∞)
org.zstack.header.volume.APICreateDataVolumeFromVolumeSnapshotMsg
  • 默认为3h，单位为s/m/h/d（即：秒/分/小时/天），用于设置从云盘快照创建数据云盘的超时上限。
  • 如果超过此时间，数据云盘还未创建完成，此操作会失败。
 3h [5min,+∞)
org.zstack.header.volume.APICreateVolumeSnapshotMsg
  • 默认为3h，单位为s/m/h/d（即：秒/分/小时/天），用于设置创建云盘快照的超时上限。
  • 如果超过此时间，云盘快照还未创建完成，此操作会失败。
 3h [5min,+∞)
org.zstack.header.vm.APICreateVmInstanceMsg
  • 默认为12h，单位为s/m/h/d（即：秒/分/小时/天），用于设置创建云主机的超时上限。
  • 如果超过此时间，云主机还未创建完成，此操作会失败。
 12h [5min,+∞)
org.zstack.storage.primary.local.APILocalStorageMigrateVolumeMsg
  • 默认为1d，单位为s/m/h/d（即：秒/分/小时/天），用于设置迁移本地存储上存放的云盘的超时上限。
  • 如果超过此时间，云盘还未迁移完成，此操作会失败。
 1d [5min,+∞)
org.zstack.header.storage.volume.backup.APICreateVmFromVmBackupMsg
  • 默认为1d，单位为s/m/h/d（即：秒/分/小时/天），用于设置从云主机备份创建云主机的超时上限。如果超过此时间，云主机还未创建完成，此操作会失败。
 1d [5min,+∞)

学习路径

ZStack Cloud 产品学习路径

了解ZStack Cloud
ZStack Cloud 技术白皮书
ZStack Cloud 用户手册
新手快速入门
ZStack Cloud 快速安装使用教程（新手快速入门）
ZStack Cloud 升级教程
基础实践
ZStack Cloud CentOS7系统模板封装教程 ZStack Cloud Windows Server 2008 R2... ZStack Cloud CLI命令使用手册（基础命令） ZStack Cloud 存储部署教程 Shared Block-FC ZStack Cloud 存储部署教程 Shared Block-iSCSI ZStack Cloud 扁平网络使用教程
ZStack Cloud 专有网络VPC使用教程 ZStack Cloud 监控监控报警使用教程 ZStack Cloud 账户管理教程 ZStack Cloud 计费功能使用教程 ZStack Cloud 云主机高可用实践教程 ZStack Cloud 磁盘快照使用教程
进阶实验
ZStack Cloud 运维手册 ZStack Cloud CTL命令使用手册（高级命令） ZStack Cloud 多管理节点物理高可用教程 ZStack Cloud 企业管理使用教程 ZStack Cloud 网络QoS/磁盘QoS 使用教程 ZStack Cloud 亲和组使用教程 ZStack Cloud 弹性伸缩使用教程 ZStack Cloud vCenter环境管理指南
ZStack Cloud 迁移服务使用教程 ZStack Cloud 混合云使用教程 ZStack Cloud 灾备服务使用教程 ZStack Cloud 裸金属管理使用教程 ZStack Cloud 弹性裸金属管理使用教程 ZStack Cloud GPU设备透传使用教程 ZStack Cloud vGPU虚拟化使用教程 ZStack Cloud 资源编排使用教程
开发者资源
ZStack Cloud 开发手册
ZStack Cloud-CLI命令使用手册
常见问题
常见问题

ZStack Cloud 产品学习路径

快速梳理文档，点击相应文本链接，快速跳转到相应文档的页面，学习 ZStack Cloud 产品。

我知道了

升级提醒

若您选择升级至4.0.0及之后版本，请注意以下功能调整：

1. 云路由器全面升级为VPC路由器，云路由网络全面升级为VPC网络，不再单独设云路由器页面。升级全程无感知，相关业务不受任何影响。

2. 企业管理账号体系取代用户组与用户，不再单独设用户/用户组页面，不可再使用用户/用户组账号登录云平台。升级前，请先将“用户组与用户”纳管的账号数据妥善迁移至“企业管理”纳管，再执行升级操作。注意：对于admin创建并具备admin权限的用户账号同步取消，如有需要，可使用企业管理账号体系中的平台管理员实现相同功能。

3. 调整AD/LDAP与账户的对接管理方式，统一由企业管理纳管，不再单独设AD/LDAP页面。升级前，请先将“账户”对接纳管的AD/LDAP账号数据妥善迁移至“企业管理”纳管，再执行升级操作。

如对上述升级提醒有任何疑问或需要升级帮助，请联系ZStack官方技术支持

下载ZStack企业版

您已填写过基本信息？点击这里

姓名应该不少于两个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
公司名称不应该少于4个字符
邮箱格式错误

下载链接将会通过邮件形式发送至您的邮箱，请谨慎填写。

下载ZStack企业版

还未填写过基本信息？点击这里

邮箱或手机号码格式错误
验证手机号
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
登录观看培训视频
仅对注册用户开放，请 登录 或 填写资料 观看培训视频
填写资料

商务咨询：

400-962-2212 转 1

售后咨询：

400-962-2212 转 2

商务联系：

sales@zstack.io
ZStack认证培训咨询
姓名应该不少于两个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
公司名称不应该少于4个字符
邮箱格式错误

商务咨询：

400-962-2212 转 1

商务联系：

channel@zstack.io
申请ZStack多机版
姓名应该不少于两个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
公司名称不应该少于4个字符
邮箱格式错误

商务咨询：

400-962-2212 转 1

售后咨询：

400-962-2212 转 2

商务联系：

sales@zstack.io
培训认证合作伙伴申请
姓名应该不少于2个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
邮箱格式错误
城市名称不应该少于2个字符
公司名称不应该少于4个字符
职位名称不应该少于2个字符

商务咨询：

400-962-2212 转 1

商务联系：

channel@zstack.io
ZStack&工信人才联合证书申请
已获得ZStack原厂证书
未获得ZStack原厂证书
请填写您的基本信息
姓名应该不少于2个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
邮箱格式错误
城市名称不应该少于2个字符
公司/学校名称不应该少于4个字符
证书类型
ZCCT
ZCCE
ZCCA
ZCPC-ISP
申请ZStack&工信人才联合证书须支付工本费，是否可以接受

商务咨询：

400-962-2212 转 1

商务联系：

channel@zstack.io

下载链接已发送至您的邮箱。

如未收到，请查看您的垃圾邮件、订阅邮件、广告邮件。 当您收到电子邮件后，请点击 URL 链接，以完成下载。

下载链接已发送至您的邮箱。

如未收到，请查看您的垃圾邮件、订阅邮件、广告邮件。
或点击下方URL链接 (IE内核浏览器请右键另存为), 完成下载：

感谢您使用 ZStack 产品和服务。

成功提交申请。

我们将安排工作人员尽快与您取得联系。

感谢您使用 ZStack 产品和服务。

产品

解决方案

支持

联系

咨询

ZStack-logo

版权所有©2022 上海云轴信息科技有限公司 (云轴科技)  沪ICP备15055560号

立即体验

联系我们

商务咨询
400-962-2212 转 1
售后咨询
400-962-2212 转 2

回到顶部

产品试用申请
请选择您要试用的产品
ZStack Cloud 企业版
ZStack Ceph分布式存储
ZStack Cloud 混合云版
ZStack Cube 超融合一体机
ZStack Cloud 基础版
ZStack Mini 边缘计算一体机
ZStack Cloud 标准版
ZStack CMP 多云管理平台
ZStack 信创云平台
ZStack Zaku 容器云平台
请填写您的基本信息
姓名应该不少于两个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
公司名称不应该少于4个字符
邮箱格式错误

商务咨询：

400-962-2212 转 1

售后咨询：

400-962-2212 转 2

商务联系：

sales@zstack.io

成功提交申请。

我们将安排工作人员尽快与您取得联系。

感谢您使用 ZStack 产品和服务。