API 参考

 

错误码

下载 编辑
更新时间 2023-09-06

当请求发生错误时，服务器会返回错误码 ( ret_code ) 和错误信息 ( message )，完整的错误码如下表。

错误分为 客户端错误 ， 服务器端错误 ， 配置文件错误， License 错误 四种。

  • 若报客户端错误，说明该错误是由用户提交的 API 引起的；

  • 若报服务器端错误，说明该错误是由服务器端引起的；

  • 若报配置文件错误，说明配置文件中的某项存在问题；

  • 若报 License　错误，说明授权证书存在错误。

客户端错误

错误码 描述 说明
1100 消息格式错误 当缺少必要参数，或者参数值格式不正确时，会返回该错误。此时可以查看相关文档确认每个参数的格式是否正确。
1101 请求方法错误 当请求了不存在的方法，或者参数值不正确时，会返回该错误。
1200 身份验证失败 当用户提供了不存在的 access_key_id 参数，或者 API 请求的签名不正确时，会返回该错误。
此时可以检查 access_key_id 和 secret_access_key 是否配置正确，或者检查是否签名有误。
1300 消息已过期 当用户提交的 time_stamp 参数时间过期(超过 60 秒)时会返回该错误。关于 time_stamp ，可以参考公共参数。
1400 访问被拒绝 当用户试图访问不属于自己的资源，或者对于提交的操作没有权限，或者试图更改的资源处于不可更改的状态时等，会返回该错误。我们会在返回的错误信息里头提及错误原因。
1500 注册用户失败 当用户注册失败时，会返回该错误。
1510 帐号已存在 当注册已存在的账号时，会返回该错误。
1520 帐号格式不合法 当注册的账号格式不满足要求时，会返回该错误。
1600 登录失败 当用户输入错误的登录信息时，会返回该错误。
1610 找不到该用户 当用户提供了不存在的用户名时，会返回该错误。
1620 密码不匹配 当用户提供了不匹配的密码时，会返回该错误。
1630 重置密码失败 当用户重置密码不符合要求时，会返回该错误。
1640 重置密码过于频繁 当用户重置密码过于频繁时，会返回该错误。
1650 无效的密码重置 token 当用户重置密码 token 无效时，会返回该错误。
1660 用户名或密码不匹配 当用户提供了不匹配的用户名密码时，会返回该错误。
1661 用户未完成注册 当用户注册未完成时，会返回该错误。
1662 用户已被禁止访问 当用户执行超出权限时，会返回该错误。
2000 登录会话过期 当用户会话空闲过久时，会返回该错误，请重新登录。
2100 找不到资源 当用户试图访问不存在的资源时，会返回该错误。
2110 资源已存在 当用户创建已存在的资源时，会返回该错误。
2200 租赁资源失败 当用户租赁信息存在错误时，会返回该错误。
2300 解除租赁失败 当用户解除租赁失败时，会返回该错误。
2400 余额不足 当用户余额不足时，会返回该错误。
2500 超过配额 当用户试图创建的资源超过用户配额，或者短时间内的API访问请求超过配额限制，会返回该错误。
API 访问请求配额限制是以天为单位，当超过配置限额时，将会在在次日零点恢复。
您可以通过提交工单的方式来向我们申请提高配额，并说明你申请的理由。
3300 无效的 API 模块 当用户使用了无效的 API 模块时，会返回该错误。

License 错误

错误码 描述 说明
4000 无效的证书 当用户的证书失效时，会返回该错误。
4001 授权证书已经过期 当用户的授权证书已经过期时，会返回该错误。
4002 平台已有相同的授权证书 当用户的证书重复时，会返回该错误。
4003 超出证书授权 当用户的当前宿云服务器的数量已超过授权证书的规定数量时，会返回该错误。
4004 加载授权证书失败 当用户加载授权证书失败时，会返回该错误。
4005 找不到授权证书 当用户没有有效的授权证书时，会返回该错误。

服务器端错误

错误码 描述 说明
5000 内部错误 当服务器执行请求过程中，遇到未知错误时，会返回该错误信息。遇到这种错误，请及时与我们联系。
5100 服务器繁忙 当服务器执行超时，或者服务器负载过高无法完成请求时，会返回该错误信息。遇到这种错误，请稍后再尝试，或者及时与我们联系。
5200 资源不足 当我们后台计算资源不足以满足用户的创建需求时，会返回该错误信息。遇到这种错误，请及时与我们联系。
5300 服务更新中 当我们的后台服务正在更新时，会返回该错误信息。遇到这种错误，请稍后再尝试，或者及时与我们联系。
5400 存在依赖关系 当我们的后台服务正在更新时，会返回该错误信息。遇到这种错误，请稍后再尝试，或者及时与我们联系。
5500 Warehouse 服务未开启 当服务器 Warehouse 服务未开启时，会返回该错误信息。遇到这种错误，请及时与我们联系。
5600 不支持的硬盘类型 当用户向一个不支持加密的云服务器挂载加密硬盘时，会返回该错误信息。

配置文件错误

错误码 描述 说明
8000 命令参数验证失败 当用户在配置文件中提供了错误的参数时，会返回该错误。
8001 配置文件中无任何镜像 当用户配置文件中无镜像时，会返回该错误。
8002 配置文件中镜像在指定区不存在 当用户配置文件中的镜像在指定区不存在时，会返回该错误。
8003 无效的集群设置 当用户配置文件提供了无效的集群设置时，会返回该错误。
8004 缺少配置文件 当缺少相应配置文件时，会返回该错误。

错误示例

出现错误时，返回错误码和详细的错误提示如下：

{
  "message":"PermissionDenied, instance [i-2aypaijz] is not running， can not be stopped",
  "ret_code":1400
}
这篇文档解决了您的问题吗？
0
0