Object Storage Service (OSS) SDK for Pythonは、ClientError、RequestError、ServerErrorの3種類の例外を返します。 これらの例外はoss2.exceptionsサブモジュールで定義されています。
次の表に、例外の変数を示します。
変数 | タイプ | 説明 |
status | int |
|
request_id | str |
|
コードとメッセージ | str | OSSエラー応答のCodeおよびMessage XMLタグのテキスト。 詳細については、「概要」をご参照ください。 |
例外処理の例
次のサンプルコードは、存在しないオブジェクトをダウンロードしようとしたときに、例外を処理し、エラーのHTTPステータスコードとリクエストIDを表示する方法の例を示しています。
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# Obtain access credentials from the environment variables. Before you run the sample code, make sure that you have configured environment variables OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET.
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com.
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# Specify the ID of the region that maps to the endpoint. Example: cn-hangzhou. This parameter is required if you use the signature algorithm V4.
region = "cn-hangzhou"
# Specify the name of the bucket.
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)
try:
# Specify the name of the downloaded object. Example: exampleobject.txt.
stream = bucket.get_object('exampleobject.txt')
except oss2.exceptions.NoSuchKey as e:
print('status={0}, request_id={1}'.format(e.status, e.request_id))
ClientError
クライアントの入力が正しくないため、ClientErrorが発生します。 たとえば、bucket.batch_delete_objectsメソッドを使用して空のオブジェクトリストを受け取った場合にエラーが発生します。 ClientErrorのstatusの値はoss2.exceptions.OSS_CLIENT_ERROR_STATUSです。
RequestError
HTTPライブラリがエラーをスローすると、OSS SDK for PythonはエラーをRequestErrorに変換します。 RequestErrorのstatusの値はoss2.exceptions.OSS_REQUEST_ERROR_STATUSです。
ServerError
OSSサーバーがHTTPステータスコードを返すと、OSS SDK for PythonはステータスコードをServerErrorに変換します。 ServerErrorは、HTTPステータスコードとOSSエラーコードに基づいて複数のサブクラスを導出します。 NotFoundサブクラスは、HTTPステータスコード404に対応します。 Conflictサブクラスは、HTTPステータスコード409に対応します。
次の表に、一般的なエラーコードを示します。
例外クラス | HTTPステータスコード | OSSエラーコード | 説明 |
NotModified | 304 | ヌル | If-Modified-Sinceパラメーターの指定された値は、オブジェクトが変更された実際の時刻よりも後です。 |
InvalidArgument | 400 | InvalidArgument | リクエスト本文は、x-oss-complete-allをyesに設定したマルチパートアップロードリクエストで指定されます。 この場合、リクエストボディは指定できません。 そうしないと、エラーが発生します。 |
AccessDenied | 403 | AccessDenied | 必要な権限がありません。 |
NoSuchBucket | 404 | NoSuchBucket | 指定したバックアップは存在しません。 |
NoSuchKey | 404 | NoSuchKey | 指定されたオブジェクトは存在しません。 |
NoSuchUpload | 404 | NoSuchUpload | マルチパートアップロードまたは再開可能アップロードリクエストでオブジェクトが完全にアップロードされていません。 |
NoSuchWebsite | 404 | NoSuchWebsiteConfiguration | 指定されたバケットに静的Webサイトホスティング設定がありません。 |
NoSuchLifecycle | 404 | NoSuchLifecycle | 指定されたバケットにはライフサイクルルールが設定されていません。 |
NoSuchCors | 404 | NoSuchCORSConfiguration | 指定されたバケットには、クロスオリジンリソース共有 (CORS) ルールが設定されていません。 |
BucketNotEmpty | 409 | BucketNotEmpty | 削除するバケットには、オブジェクト、不完全なマルチパートアップロードタスクによって生成されたパーツ、またはLiveChannelsが含まれます。 |
PositionNotEqualToLength | 409 | PositionNotEqualToLength | リクエスト内のpositionの値が現在のオブジェクトサイズと一致しません。 |
ObjectNotAppendable | 409 | ObjectNotAppendable | 現在のオブジェクトは追加可能なオブジェクトではありません。 |