公共错误码说明
公共错误码说明
云控制台API返回异常结果中用于标识错误信息的代码与消息统称为错误码。
云控制台API的错误码分为公共错误码与业务错误码。公共错误码是云控制台API通用的错误码，用于标识公共的错误信息；业务错误码是各个接口根据接口具体场景和可能出现的特定错误定义的错误码，用于标识接口的特定错误信息。
错误码包含错误代码和错误信息两部分。错误代码包括标准的HTTP错误状态码和云控制台API定义错误状态码。错误信息描述了具体的错误原因。结合错误状态码和错误信息，用户可以有效地对失败的调用进行分析与排查。
错误返回结果的格式如下：
{
"requestId": <请求ID>,
"success": <成功标识(true为成功，false为失败)>,
"code": <错误代码>,
"errorCode": <错误信息>
}
以下是云控制台API公共错误码的列表：
| 错误代码 | 错误信息 | 错误说明 |
|---|---|---|
| 400 | Invalid argument. | 无效参数。 |
| 401 | Unauthorized. | 访问未授权。 |
| 402 | Payment Required. | 保留，将来使用 |
| 403 | PermissionDenied. | 操作被拒绝。 |
| 404 | Not Found. | 请求资源不存在。 |
| 409 | Request was denied due to conflict with a previous request. | 请求时发生冲突，请求被拒绝。 |
| 500 | The request processing has failed due to some unknown error, exception or failure. | 未知错误，请求处理失败。 |
| 503 | The request has failed due to a temporary failure of the server. | 服务器内部错误，无法完成请求。 |
| 601 | Sign error. | 签名错误。 |
| 602 | User account is invalid. | 无效的用户账号。 |
| 603 | Parameter "requestId" is duplicated, the request header x-ycs-requestid specified "requestId" is duplicated. | 请求头x-ycs-requestid的值 "requestId"重复。 |
| 604 | Request is expired, the request header x-ycs-timestamp specified timestamp is expired. | 请求头x-ycs-timestamp的时间戳过期。 |
| 605 | Forbidden. | 禁止访问。 |
| 610 | Validation error. | 业务参数校验错误。 |
1. 错误码示例
以下以某异常返回结果为例：
{
"requestId": "19c0e7ff-5554-4e90-b3a5-3aab644a8e30",
"success": false,
"code": 401,
"message": "client enabled is false",
"errorCode": "InvalidUserAccount"
}
通过"success"字段值false，可以判断本次请求失败。通过"code"字段值，可以获取到失败的错误状态码为605，通过"errorCode"字段可以获得该错误代码的说明，而通过message则可以获取到更具体的错误描述信息。