请求状态码
| 状态码 | 描述 |
|---|---|
| 200 | 服务器返回成功，该操作是幂等的 |
| 400 | 用户请求错误，该操作是幂等的 |
| 401 | 用户无权限（用户名或者密码错误等） |
| 403 | 访问受限，被禁止 |
| 404 | 用户请求路径不存在 |
| 429 | Too many Request |
| 500 | 服务端异常 |
| 502 | 网关错误 |
| 503 | 服务不可用 |
未细分类通用码
| errorCode | 说明 | 订单状态相关性说明 | http status code | description | message |
|---|---|---|---|---|---|
| openapi.implementation.error | 服务端实现错误 | 无 | 500 | 实现错误 | implmentation error |
| openapi.requestParse.jsonExpected | 内部错误，内部系统交互问题 | 无 | 500 | 请求来源非法 | injected request not expected |
| openapi.requestParse.accessKeyInvalid | 内部错误，内部系统交互问题。 EOP系统转发问题，需求方无需处理。 |
无 | 500 | 非OpenAPI准入的ess key invalid | |
| openapi.requestParse.eopInvalidRejection | 请求格式非法 | 无 | 400 | 请求格式非法 | request should be http POSTed json |
| openapi.requestParse.emptyRequest | 请求为空 | 无 | 400 | 请求为空 | request should not be empty |
| openapi.parameter.xxxx | 无 | 400 | 请求参数错误: xxx | request param error: xxx | |
| openapi.admin.accessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| openapi.userPermission.accessFailed | 无 | 200 | 系统错误 | access internal service failed | |
| openapi.yacos.accessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| openapi.workorder.accessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| openapi.ctyunPlatform.accessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| openapi.charge.fused | 访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| openapi.innerSys.accessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
未细分类通用码（大驼峰格式）
| error | 说明 | 订单状态相关性说明 | http status code | description | message |
|---|---|---|---|---|---|
| Openapi.Implementation.Error | 服务端实现错误 | 无 | 500 | 实现错误 | implmentation error |
| Openapi.RequestParse.JsonExpected | 内部错误，内部系统交互问题 | 无 | 500 | 请求来源非法 | injected request not expected |
| Openapi.RequestParse.AccessKeyInvalid | 内部错误，内部系统交互问题。 EOP系统转发问题，需求方无需处理。 |
无 | 500 | 非OpenAPI准入的ess key invalid | |
| Openapi.RequestParse.EopInvalidRejection | 请求格式非法 | 无 | 400 | 请求格式非法 | request should be http POSTed json |
| Openapi.RequestParse.EmptyRequest | 请求为空 | 无 | 400 | 请求为空 | request should not be empty |
| Openapi.Parameter.xxxx | 无 | 400 | 请求参数错误: xxx | request param error: xxx | |
| Openapi.Admin.AccessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| Openapi.UserPermission.AccessFailed | 无 | 200 | 系统错误 | access internal service failed | |
| Openapi.Yacos.AccessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| Openapi.Workorder.AccessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| Openapi.CtyunPlatform.AccessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| Openapi.Charge.Fused | 访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| Openapi.InnerSys.AccessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
订单类结果码
| errorCode | 说明 | 订单状态相关性说明 | http status code | description | message |
|---|---|---|---|---|---|
| backup.order.accessFailed | 订单系统访问失败，可使用clientToken重试订单 | 订单状态未知，需要使用clientToken重试订单 | 200 | 访问订单系统失败：订单状态未知，使用clientToken重bss failed: order status unknown, retry this order using clientToken | |
| backup.order.inProgress | 订单处理中，可使用订单ID查询确认或使用原clientToken重试下单 | 需要使用clientToken重试订单。也可以使用返回的订单ID，查询订单状态 | 200 | 订单处理clientToken重试下单 | order in progress |
| backup.Order.ProcFailed | 订单处理失败。无需重试。通过errorDetail确认具体失败原因 | 无 | 200 | 订单处理失败 | order proc failed |
| backup.order.orderChanged | 订单状态变更，比如发生了撤单，取消等。 | 无 | 200 | 订单已取消或撤单 | order changed |
| backup.order.accepted | 订单已成功，资源创建中。 可以使用clientToken或者返回的masterOrderID重试订单，以确认订单状态。 此时不返回masterResourceID及resources |
需试订单。也可以使用返回的订单ID，查询订单状态 | 200 | 资源处理中。请稍后使用masterOrderID或者clientToken重试订单以确认状态 | order accepted，resource processing |
| backup.order.userFrozen | 用户受限，可能是被冻结的账户，或者余额不足 | 无 | 200 | 用户受限，可能是被冻结的账户，或者余额不足 | account forbidden; maybe freezen or credit not enough |
| backup.order.userQuotaLimited | 用户配额不足，是BSS侧下单时返回的配额问题（实时配额） | 无 | 200 | 用户配额不足 | user's quotas not enough |
| backup.order.regionServiceAccessFailed | 访问资源池失败 | 无 | 200 | 资源池资源服务访问失败 | access region service failed |
| backup.order.unexpectedResponse | 订单返回响应不符合预期 | 无 | 200 | 订单数据异常 | order info damaged |
| backup.order.resourceDeployFailed | 资源施工失败 | 无 | 200 | 资源施工失败 | resource process failed |
| backup.orderCheck.invalidName | 名称非法 | 无 | 200 | 云硬盘名称错误，仅允许英文字母数字及_或者-，且长度为2-63字符 | name invalid |
| backup.orderCheck.userForbiddenOnDemand | 用户不允许创建按需订购资源 | 无 | 200 | 用户不允许订购按需类订单 | user not allowed place ondemand order |
| backup.orderCheck.invalidProjectID | 订单关联的projectID不存在 | 无 | 200 | 企业项目ID不存在 | projectID invalid |
| backup.common.serviceStatusError | 云备份服务状态异常 | 无 | 200 | 云备份服务状态异常 | backup service error |
订单类结果码（大驼峰格式）
| error | 说明 | 订单状态相关性说明 | http status code | description | message |
|---|---|---|---|---|---|
| Backup.Order.AccessFailed | 订单系统访问失败，可使用clientToken重试订单 | 订单状态未知，需要使用clientToken重试订单 | 200 | 访问订单系统失败：订单状态未知，使用clientToken重bss failed: Order status unknown, retry this Order using clientToken | |
| Backup.Order.InProgress | 订单处理中，可使用订单ID查询确认或使用原clientToken重试下单 | 需要使用clientToken重试订单。也可以使用返回的订单ID，查询订单状态 | 200 | 订单处理clientToken重试下单 | Order in progress |
| Backup.Order.ProcFailed | 订单处理失败。无需重试。通过errorDetail确认具体失败原因 | 无 | 200 | 订单处理失败 | Order proc failed |
| Backup.Order.OrderChanged | 订单状态变更，比如发生了撤单，取消等。 | 无 | 200 | 订单已取消或撤单 | Order changed |
| Backup.Order.Accepted | 订单已成功，资源创建中。 可以使用clientToken或者返回的masterOrderID重试订单，以确认订单状态。 此时不返回masterResourceID及resources |
需试订单。也可以使用返回的订单ID，查询订单状态 | 200 | 资源处理中。请稍后使用masterOrderID或者clientToken重试订单以确认状态 | Order accepted，resource processing |
| Backup.Order.UserFrozen | 用户受限，可能是被冻结的账户，或者余额不足 | 无 | 200 | 用户受限，可能是被冻结的账户，或者余额不足 | account forbidden; maybe freezen or credit not enough |
| Backup.Order.UserQuotaLimited | 用户配额不足，是BSS侧下单时返回的配额问题（实时配额） | 无 | 200 | 用户配额不足 | user's quotas not enough |
| Backup.Order.RegionServiceAccessFailed | 访问资源池失败 | 无 | 200 | 资源池资源服务访问失败 | access region service failed |
| Backup.Order.UnexpectedResponse | 订单返回响应不符合预期 | 无 | 200 | 订单数据异常 | Order info damaged |
| Backup.Order.ResourceDeployFailed | 资源施工失败 | 无 | 200 | 资源施工失败 | resource process failed |
| Backup.OrderCheck.InvalidName | 名称非法 | 无 | 200 | 云硬盘名称错误，仅允许英文字母数字及_或者-，且长度为2-63字符 | name invalid |
| Backup.OrderCheck.UserForbiddenOnDemand | 用户不允许创建按需订购资源 | 无 | 200 | 用户不允许订购按需类订单 | user not allowed place ondemand Order |
| Backup.OrderCheck.InvalidProjectID | 订单关联的projectID不存在 | 无 | 200 | 企业项目ID不存在 | projectID invalid |
| Backup.Common.ServiceStatusError | 云备份服务状态异常 | 无 | 200 | 云备份服务状态异常 | Backup service error |
内部系统间访问结果码
| errorCode | http status code | description | message |
|---|---|---|---|
| backup.regionInfo.accessFailed | 200 | 查询资源池失败 | querying region failed |
| backup.regionInfo.empty | 200 | 资源池信息为空 | region info empty |
| backup.regionInfo.dataDamaged | 200 | 资源池信息不符预期 | region info data damaged |
| backup.userPermission.accessFailed | 200 | 查询用户权限失败 | querying user permission failed |
| backup.userPermission.empty | 200 | 用户权限信息为空 | user permission empty |
| backup.userPermission.dataDamaged | 200 | 用户权限信息不符预期 | user permission data damaged |
| backup.userDetail.accessFailed | 200 | 查询用户详情失败 | querying user detail failed |
| backup.userDetail.empty | 200 | 用户详情信息为空 | user detail info empty |
| backup.userDetail.dataDamaged | 200 | 用户详情信息不符预期 | user detail info damaged |
| backup.userQuota.accessFailed | 200 | 查询用户配额失败 | querying user quota info failed |
| backup.userQuota.empty | 200 | 用户配额信息为空 | user quota info empty |
| backup.userQuota.dataDamaged | 200 | 用户配额信息不符预期 | user qutoa info damaged |
| backup.resourceInfo.accessFailed | 200 | 查询资源失败 | querying resource info failed |
| backup.resourceInfo.notExists | 200 | 资源信息不存在 | resource info not exists |
| backup.resourceInfo.dataDamaged | 200 | 资源信息不符预期 | resource info damaged |
| backup.resourceOrderInfo.accessFailed | 200 | 查询资源订单信息失败 | querying resource order info failed |
| backup.resourceOrderInfo.notExists | 200 | 资源订单信息不存在 | resource order info not exists |
| backup.resourceOrderInfo.dataDamaged | 200 | 资源订单信息不符预期 | resource order info damaged |
| backup.userConsumption.accessFailed | 200 | 查询用户已用资源量失败 | querying user consumption failed |
| backup.userConsumption.empty | 200 | 用户已用资源信息为空 | user consumption info empty |
| backup.userConsumption.dataDamaged | 200 | 用户已用资源信息不符预期 | user consumption info damaged |
| backup.userResources.accessFailed | 200 | 查询用户资源信息失败 | querying user resources failed |
| backup.userResources.dataDamaged | 200 | 用户资源信息不符预期 | user resources info damaged |
| backup.userVisibleRegions.accessFailed | 200 | 查询用户可见资源池失败 | querying user visible regions failed |
| backup.userVisibleRegions.dataDamaged | 200 | 用户可见资源池信息不符预期 | user visible regions info damaged |
| backup.common.serviceStatusError | 200 | 云备份服务状态异常 | backup service error |
| backup.common.clientAccessError | 200 | 云备份客户端信息获取异常 | backup client info access failed |
| backup.common.clientCountLimit | 200 | 云备份客户端信息数量已达到配额值 | backup client count quota not enough |
| backup.common.clientInstallError | 200 | 云备份客户端安装失败 | backup client install error |
| backup.common.clientUninstallError | 200 | 云备份客户端卸载失败 | backup client uninstall error |
| backup.common.resourceDeleteError | 200 | 云备份客户端卸载失败 | backup resource delete error |
| backup.BackupPolicyParamFilter.invalidName | 200 | 云备份计划名称无效，仅允许英文字母数字及-，不能以数字和-开头、不能以-结尾,且长度不超过64个字符 | name invalid |
| backup.BackupPolicyParamFilter.invalidFormat | 200 | 参数违规不符合标准 | Format invalid |
| backup.BackupPolicyCreateProcor.invalidCreate | 200 | 创建云备份计划失败 | Create invalid |
| backup.BackupPolicyUpdateProcor.invalidUpdate | 200 | 修改云备份计划失败 | Update invalid |
| backup.BackupPolicyDeleteProcor.invalidDelete | 200 | 删除云备份计划失败 | Delete invalid |
| backup.BackupPolicyInfoChecker.policyAccessError | 200 | 云备份计划信息获取异常 | backup policy info access failed |
| backup.BackupPolicyActionProcor.policyActionError | 200 | 云备份计划操作异常 | backup policy action failed |
| backup.BackupSnapshotInfoProcor.policyAccessError | 200 | 云备份快照信息获取异常 | backup snapshot info access failed |
| backup.clientResouceInfo.invalidClientResouceCycleCount | 200 | 云备份客户端资源包订购时间无效，仅允许month:[1-11],year:[1-3]的整数 | backup client resouce cycle count invalid error |
| backup.storageInfo.invalidBackUpStorageName | 200 | 云备份存储库名称无效，仅允许英文字母数字及-，且不能以数字和-开头、且不能以-结尾 | backup storage name invalid error |
| backup.storageInfo.existName | 200 | 存储库名称已存在 | backup storage name already exists |
| backup.storageInfo.accessFailed | 200 | 查询存储库信息失败 | querying backup storage info failed |
| backup.storageInfo.invalidStorageCapacity | 200 | 云备份存储库容量无效，仅允许[100-1024000]的整数 | backup storage capacity invalid error |
| backup.storageInfo.invalidStorageCycleCount | 200 | 云备份存储库订购数无效，仅允许month:[1-11],year:[1-3]的整数 | backup storage cycle count invalid error |
| backup.restoreInfo.accessFailed | 200 | 查询恢复任务信息失败 | querying restore storage info failed |
| backup.storageOrderInfo.accessFailed | 200 | 查询存储库订单失败 | querying backup storage order failed |
| backup.storageQuota.accessQuotaFailed | 200 | 查询存储库配额失败 | querying backup storage quota failed |
| backup.storageQuota.StorageCountLimit | 200 | 云备份存储库数量已达到配额值 | backup storage count quota not enough |
| backup.restoreTask.restoreOperateError | 200 | 恢复任务操作失败 | backup restore operate error |
| backup.restoreTask.restoreOperateDamaged | 200 | 操作结果数据不符预期 | operation result damaged |
| backup.task.backupTaskOperateError | 200 | 备份任务操作失败 | backup task operate error |
| backup.task.backupTaskOperateDamaged | 200 | 操作结果数据不符预期 | operation result damaged |
| backup.task.accessFailed | 200 | 查询备份任务信息失败 | querying backup task info failed |
| backup.info.notNullParameter | 200 | 必选参数为空 | the necessary parameter is null |
内部系统间访问结果码（大驼峰格式）
| error | http status code | description | message |
|---|---|---|---|
| Backup.RegionInfo.AccessFailed | 200 | 查询资源池失败 | querying region failed |
| Backup.RegionInfo.Empty | 200 | 资源池信息为空 | region info empty |
| Backup.RegionInfo.DataDamaged | 200 | 资源池信息不符预期 | region info data damaged |
| Backup.UserPermission.AccessFailed | 200 | 查询用户权限失败 | querying user permission failed |
| Backup.UserPermission.Empty | 200 | 用户权限信息为空 | user permission empty |
| Backup.UserPermission.DataDamaged | 200 | 用户权限信息不符预期 | user permission data damaged |
| Backup.UserDetail.AccessFailed | 200 | 查询用户详情失败 | querying user detail failed |
| Backup.UserDetail.Empty | 200 | 用户详情信息为空 | user detail info empty |
| Backup.UserDetail.DataDamaged | 200 | 用户详情信息不符预期 | user detail info damaged |
| Backup.UserQuota.AccessFailed | 200 | 查询用户配额失败 | querying user quota info failed |
| Backup.UserQuota.Empty | 200 | 用户配额信息为空 | user quota info empty |
| Backup.UserQuota.DataDamaged | 200 | 用户配额信息不符预期 | user qutoa info damaged |
| Backup.ResourceInfo.AccessFailed | 200 | 查询资源失败 | querying resource info failed |
| Backup.ResourceInfo.NotExists | 200 | 资源信息不存在 | resource info not exists |
| Backup.ResourceInfo.DataDamaged | 200 | 资源信息不符预期 | resource info damaged |
| Backup.ResourceOrderInfo.AccessFailed | 200 | 查询资源订单信息失败 | querying resource Order info failed |
| Backup.ResourceOrderInfo.NotExists | 200 | 资源订单信息不存在 | resource Order info not exists |
| Backup.ResourceOrderInfo.DataDamaged | 200 | 资源订单信息不符预期 | resource Order info damaged |
| Backup.UserConsumption.AccessFailed | 200 | 查询用户已用资源量失败 | querying user consumption failed |
| Backup.UserConsumption.Empty | 200 | 用户已用资源信息为空 | user consumption info empty |
| Backup.UserConsumption.DataDamaged | 200 | 用户已用资源信息不符预期 | user consumption info damaged |
| Backup.UserResources.AccessFailed | 200 | 查询用户资源信息失败 | querying user resources failed |
| Backup.UserResources.DataDamaged | 200 | 用户资源信息不符预期 | user resources info damaged |
| Backup.UserVisibleRegions.AccessFailed | 200 | 查询用户可见资源池失败 | querying user visible regions failed |
| Backup.UserVisibleRegions.DataDamaged | 200 | 用户可见资源池信息不符预期 | user visible regions info damaged |
| Backup.Common.ServiceStatusError | 200 | 云备份服务状态异常 | Backup service error |
| Backup.Common.ClientAccessError | 200 | 云备份客户端信息获取异常 | Backup client info access failed |
| Backup.Common.ClientCountLimit | 200 | 云备份客户端信息数量已达到配额值 | Backup client count quota not enough |
| Backup.Common.ClientInstallError | 200 | 云备份客户端安装失败 | Backup client install error |
| Backup.Common.ClientUninstallError | 200 | 云备份客户端卸载失败 | Backup client uninstall error |
| Backup.Common.ResourceDeleteError | 200 | 云备份客户端卸载失败 | Backup resource delete error |
| Backup.BackupPolicyParamFilter.InvalidName | 200 | 云备份计划名称无效，仅允许英文字母数字及-，不能以数字和-开头、不能以-结尾,且长度不超过64个字符 | name invalid |
| Backup.BackupPolicyParamFilter.InvalidFormat | 200 | 参数违规不符合标准 | Format invalid |
| Backup.BackupPolicyCreateProcor.InvalidCreate | 200 | 创建云备份计划失败 | Create invalid |
| Backup.BackupPolicyUpdateProcor.InvalidUpdate | 200 | 修改云备份计划失败 | Update invalid |
| Backup.BackupPolicyDeleteProcor.InvalidDelete | 200 | 删除云备份计划失败 | Delete invalid |
| Backup.BackupPolicyInfoChecker.PolicyAccessError | 200 | 云备份计划信息获取异常 | Backup policy info access failed |
| Backup.BackupPolicyActionProcor.PolicyActionError | 200 | 云备份计划操作异常 | Backup policy action failed |
| Backup.BackupSnapshotInfoProcor.PolicyAccessError | 200 | 云备份快照信息获取异常 | Backup snapshot info access failed |
| Backup.ClientResouceInfo.InvalidClientResouceCycleCount | 200 | 云备份客户端资源包订购时间无效，仅允许month:[1-11],year:[1-3]的整数 | Backup client resouce cycle count invalid error |
| Backup.StorageInfo.InvalidBackupStorageName | 200 | 云备份存储库名称无效，仅允许英文字母数字及-，且不能以数字和-开头、且不能以-结尾 | Backup storage name invalid error |
| Backup.StorageInfo.ExistName | 200 | 存储库名称已存在 | Backup storage name already exists |
| Backup.StorageInfo.AccessFailed | 200 | 查询存储库信息失败 | querying Backup storage info failed |
| Backup.StorageInfo.InvalidStorageCapacity | 200 | 云备份存储库容量无效，仅允许[100-1024000]的整数 | Backup storage capacity invalid error |
| Backup.StorageInfo.InvalidStorageCycleCount | 200 | 云备份存储库订购数无效，仅允许month:[1-11],year:[1-3]的整数 | Backup storage cycle count invalid error |
| Backup.RestoreInfo.AccessFailed | 200 | 查询恢复任务信息失败 | querying restore storage info failed |
| Backup.StorageOrderInfo.AccessFailed | 200 | 查询存储库订单失败 | querying Backup storage Order failed |
| Backup.StorageQuota.AccessQuotaFailed | 200 | 查询存储库配额失败 | querying Backup storage quota failed |
| Backup.StorageQuota.StorageCountLimit | 200 | 云备份存储库数量已达到配额值 | Backup storage count quota not enough |
| Backup.RestoreTask.RestoreOperateError | 200 | 恢复任务操作失败 | Backup restore operate error |
| Backup.RestoreTask.RestoreOperateDamaged | 200 | 操作结果数据不符预期 | operation result damaged |
| Backup.Task.BackupTaskOperateError | 200 | 备份任务操作失败 | Backup task operate error |
| Backup.Task.BackupTaskOperateDamaged | 200 | 操作结果数据不符预期 | operation result damaged |
| Backup.Task.AccessFailed | 200 | 查询备份任务信息失败 | querying Backup task info failed |
| Backup.Info.NotNullParameter | 200 | 必选参数为空 | the necessary parameter is null |
