功能说明
如果返回结果中存在 Error 字段,则表示调用 API 接口失败。例如:
{
"Response": {
"Error": {
"Code": "AuthFailure.SignatureFailure",
"Message": "The provided credentials could not be validated. Please check your signature is correct."
},
"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"
}
}
Error 中的 Code 表示错误码,Message 表示该错误的具体信息。
错误码列表
公共错误码
| 错误码 | 说明 |
|---|---|
| ActionOffline | 接口已下线。 |
| AuthFailure.InvalidAuthorization | 请求头部的 Authorization 不符合腾讯云标准。 |
| AuthFailure.InvalidSecretId | 密钥非法(不是云 API 密钥类型)。 |
| AuthFailure.MFAFailure | MFA 错误。 |
| AuthFailure.SecretIdNotFound | 密钥不存在。请在 控制台 检查密钥是否已被删除或者禁用,如状态正常,请检查密钥是否填写正确,注意前后不得有空格。 |
| AuthFailure.SignatureExpire | 签名过期。Timestamp 和服务器时间相差不得超过五分钟,请检查本地时间是否和标准时间同步。 |
| AuthFailure.SignatureFailure | 签名错误。签名计算错误,请对照调用方式中的签名方法文档检查签名计算过程。 |
| AuthFailure.TokenFailure | token 错误。 |
| AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidAction | 接口不存在。 |
| InvalidParameter | 参数错误(包括参数格式、类型等错误)。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidRequest | 请求 body 的 multipart 格式错误。 |
| IpInBlacklist | IP 地址在黑名单中。 |
| IpNotInWhitelist | IP 地址不在白名单中。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数。 |
| NoSuchProduct | 产品不存在 |
| NoSuchVersion | 接口版本不存在。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| RequestLimitExceeded.GlobalRegionUinLimitExceeded | 主账号超过频率限制。 |
| RequestLimitExceeded.IPLimitExceeded | IP 限频。 |
| RequestLimitExceeded.UinLimitExceeded | 主账号限频。 |
| RequestSizeLimitExceeded | 请求包超过限制大小。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResponseSizeLimitExceeded | 返回包超过限制大小。 |
| ServiceUnavailable | 当前服务暂时不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误,用户多传未定义的参数会导致错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedProtocol | http(s) 请求协议错误,只支持 GET 和 POST 请求。 |
| UnsupportedRegion | 接口不支持所传地域。 |
业务错误码
| 错误码 | 说明 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.APIServerFail | 调用API服务失败。 |
| FailedOperation.AgentOffline | 客户端已离线。 |
| FailedOperation.Export | 导出文件失败。 |
| FailedOperation.LicenseExceeded | 可用license数量不足,缺少1个license,请购买新license。 |
| FailedOperation.MachineDelete | 卸载主机。 |
| FailedOperation.NoProfessionHost | 无专业版主机。 |
| FailedOperation.PartSeparate | 多台主机隔离,部分或全部失败。 |
| FailedOperation.ProtectStartFail | 开启防护失败。 |
| FailedOperation.Recover | 回复木马失败。 |
| FailedOperation.RescanVul | 重新检测漏洞失败。 |
| FailedOperation.SingleSeparate | 单台主机隔离失败。 |
| FailedOperation.TooManyStrategy | 创建基线策略超过上限。 |
| InternalError.MainDBFail | 操作数据失败。 |
| InvalidParameter.DateRange | 时间区间格式错误。 |
| InvalidParameter.IllegalRequest | 非法请求。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| InvalidParameter.IpNoValid | IP格式不合法。 |
| InvalidParameter.MissingParameter | 参数缺失。 |
| InvalidParameter.NameHasRepetition | 名字已重复。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| InvalidParameter.PortNoValid | 端口格式不合法。 |
| InvalidParameter.RegexRuleError | 正则参数格式错误。 |
| InvalidParameter.ReverShellKeyFieldAllEmpty | 进程名/目标IP/目标端口,不能同时为空。 |
| InvalidParameter.RuleHostDuplicateErr | 规则类接口,主机重复。 |
| InvalidParameter.RuleHostipErr | 规则类接口,主机IP不正确。 |
| InvalidParameterValue.TagNameLengthLimit | 标签名称长度不能超过15个字符。 |
| LimitExceeded.AreaQuota | 超出批量添加数量。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.MachineNotFound | 扫描机器不存在。 |