Click or drag to resize
ServiceException Class

The exception returned from OSS server side.

ServiceExceptionis used for wrap the error messages from OSS server side. For example, if Access key Id does not exist, it will throw ServiceException. The exception has the error codes for caller to handle.

WebException means there's network issue when OSS client sends request to OSS server. For example, if the network is not available, it will throw WebException.

InvalidOperationException means the client code handnle parse or handle the response. In this case it might means the response is incomplete or the SDK does not match the OSS's response, in which case the SDK needs the upgrade.

Generally speaking, caller only needs to handle ServiceException. It means the request has been processed by OSS (so network is not an issue), but the request could not be processed by OSS correctly. The error code of ServiceException could help to understand the issue and the caller could handle it properly.

Inheritance Hierarchy

Namespace: Aliyun.OSS.Common
Assembly: Aliyun.OSS (in Aliyun.OSS.dll) Version: 2.8.0.0 (2.8.0)
Syntax
[SerializableAttribute]
public class ServiceException : Exception

The ServiceException type exposes the following members.

Constructors
  NameDescription
Public methodServiceException
Creates a ServiceException instance.
Public methodServiceException(String)
Creates a new ServiceException instance.
Protected methodServiceException(SerializationInfo, StreamingContext)
Creates a new ServiceException instance.
Public methodServiceException(String, Exception)
Creates a new ServiceExceptioninstance.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBaseException
When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetObjectData (Overrides ExceptionGetObjectData(SerializationInfo, StreamingContext).)
Public methodGetType
Gets the runtime type of the current instance.
(Inherited from Exception.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Creates and returns a string representation of the current exception.
(Inherited from Exception.)
Top
Properties
  NameDescription
Public propertyData
Gets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception.)
Public propertyErrorCode
The error code getter
Public propertyHelpLink
Gets or sets a link to the help file associated with this exception.
(Inherited from Exception.)
Public propertyHostId
Host ID getter
Protected propertyHResult
Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception.)
Public propertyInnerException
Gets the Exception instance that caused the current exception.
(Inherited from Exception.)
Public propertyMessage
Gets a message that describes the current exception.
(Inherited from Exception.)
Public propertyRequestId
The requestId getter
Public propertySource
Gets or sets the name of the application or the object that causes the error.
(Inherited from Exception.)
Public propertyStackTrace
Gets a string representation of the frames on the call stack at the time the current exception was thrown.
(Inherited from Exception.)
Public propertyTargetSite
Gets the method that throws the current exception.
(Inherited from Exception.)
Top
See Also