apierror

Documentation

Index

• func IsNetErr(err error) bool
• type ApiCode
• type ApiError
  • func NewApiError(code ApiCode, err string) *ApiError
  • func NewApiErrorWithError(err error) *ApiError
  • func NewFailedApiError(err string) *ApiError
  • func NewOkApiError() *ApiError
  • func ParseCommonApiError(data []byte) *ApiError
  • func ParseCommonResponseApiError(resp *http.Response) ([]byte, *ApiError)
  • func (a *ApiError) ErrCode() ApiCode
  • func (a *ApiError) Error() string
  • func (a *ApiError) SetErr(code ApiCode, err string)
  • func (a *ApiError) String() string
• type ErrorResp
  • func (e *ErrorResp) GetErrorMsg() string
• type ErrorXmlResp

Functions

func IsNetErr

func IsNetErr(err error) bool

IsNetErr 是否是网络错误

Types

type ApiCode

type ApiCode int

const (

	// ApiCodeOk 成功
	ApiCodeOk ApiCode = 0
	// ApiCodeFailed 失败
	ApiCodeFailed ApiCode = 999

	// ApiCodeNetError 网络错误
	ApiCodeNetError ApiCode = 800

	// ApiCodeNeedCaptchaCode 验证码
	ApiCodeNeedCaptchaCode ApiCode = 10
	// ApiCodeTokenExpiredCode 会话/Token已过期
	ApiCodeTokenExpiredCode ApiCode = 11
	// ApiCodeFileNotFoundCode 文件不存在 NotFound.File / NotFound.FileId
	ApiCodeFileNotFoundCode ApiCode = 12
	// ApiCodeUploadFileStatusVerifyFailed 上传文件失败
	ApiCodeUploadFileStatusVerifyFailed = 13
	// ApiCodeUploadOffsetVerifyFailed 上传文件数据偏移值校验失败
	ApiCodeUploadOffsetVerifyFailed = 14
	// ApiCodeUploadFileNotFound 服务器上传文件不存在
	ApiCodeUploadFileNotFound = 15
	// ApiCodeFileAlreadyExisted 文件已存在 AlreadyExist.File
	ApiCodeFileAlreadyExisted = 16
	// ApiCodeUserDayFlowOverLimited 上传达到日数量上限
	ApiCodeUserDayFlowOverLimited = 17
	// ApiCodeAccessTokenInvalid Token无效或者已过期 AccessTokenInvalid，合并到ApiCodeTokenExpiredCode错误
	ApiCodeAccessTokenInvalid = 18
	// ApiCodeForbidden 被禁止 Forbidden
	ApiCodeForbidden = 19
	// ApiCodeRefreshTokenExpiredCode RefreshToken已过期
	ApiCodeRefreshTokenExpiredCode ApiCode = 20
	// ApiCodeFileShareNotAllowed 文件不允许分享
	ApiCodeFileShareNotAllowed ApiCode = 21
	// ApiCodeInvalidRapidProof 文件上传水印码错误
	ApiCodeInvalidRapidProof ApiCode = 22
	// ApiCodeNotFoundView 资源不存在
	ApiCodeNotFoundView ApiCode = 23
	// ApiCodeBadRequest 请求非法
	ApiCodeBadRequest ApiCode = 24
	// ApiCodeInvalidResource 请求无效资源
	ApiCodeInvalidResource ApiCode = 25
	// ApiCodeVideoPreviewInfoNotFound 视频预览信息不存在
	ApiCodeVideoPreviewInfoNotFound ApiCode = 26
	// ApiCodeFeatureTemporaryDisabled 功能维护中
	ApiCodeFeatureTemporaryDisabled ApiCode = 27
	// ApiCodeForbiddenFileInTheRecycleBin 文件已经被删除
	ApiCodeForbiddenFileInTheRecycleBin ApiCode = 28
	// ApiCodeBadGateway 502网关错误，一般代表请求被限流了
	ApiCodeBadGateway ApiCode = 29
	// ApiCodeTooManyRequests 429 Too Many Requests错误，一般代表请求被限流了
	ApiCodeTooManyRequests ApiCode = 30
	// ApiCodeUserDeviceOffline 客户端离线，阿里云盘单账户最多只允许同时登录 10 台设备
	ApiCodeUserDeviceOffline ApiCode = 31
	// ApiCodeDeviceSessionSignatureInvalid 签名过期，需要更新签名密钥
	ApiCodeDeviceSessionSignatureInvalid ApiCode = 32
	// ApiCodePermissionDenied 用户已取消授权，或权限已失效，或 token 无效。需要重新发起授权
	ApiCodePermissionDenied ApiCode = 33
	// ApiCodeUserNotAllowedAccessDrive 用户没有授权应用访问当前drive
	ApiCodeUserNotAllowedAccessDrive ApiCode = 34
)

type ApiError

type ApiError struct {
	Code ApiCode
	Err  string
}

func NewApiError

func NewApiError(code ApiCode, err string) *ApiError

func NewApiErrorWithError

func NewApiErrorWithError(err error) *ApiError

func NewFailedApiError

func NewFailedApiError(err string) *ApiError

func NewOkApiError

func NewOkApiError() *ApiError

func ParseCommonApiError

func ParseCommonApiError(data []byte) *ApiError

ParseCommonApiError 解析阿里云盘错误，如果没有错误则返回nil

func ParseCommonResponseApiError

func ParseCommonResponseApiError(resp *http.Response) ([]byte, *ApiError)

ParseCommonResponseApiError 解析阿里云盘错误，如果没有错误则返回nil

func (*ApiError) ErrCode

func (a *ApiError) ErrCode() ApiCode

func (*ApiError) Error

func (a *ApiError) Error() string

func (*ApiError) SetErr

func (a *ApiError) SetErr(code ApiCode, err string)

func (*ApiError) String

func (a *ApiError) String() string

type ErrorResp

type ErrorResp struct {
	ErrorCode       string `json:"code"`
	ErrorMsg        string `json:"message"`
	ErrorDisplayMsg string `json:"display_message"`
}

ErrorResp 默认的错误信息

func (*ErrorResp) GetErrorMsg

func (e *ErrorResp) GetErrorMsg() string

type ErrorXmlResp

type ErrorXmlResp struct {
	XMLName xml.Name `xml:"Error"`
	Code    string   `xml:"Code"`
	Message string   `xml:"Message"`
}