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を表示する方法の例を示しています。
# -*-コーディング: utf-8 -*-
oss2のインポート
oss2.credentialsからEnvironmentVariableCredentialsProviderをインポート
# 環境変数からアクセス資格情報を取得します。 サンプルコードを実行する前に、環境変数OSS_ACCESS_KEY_IDとOSS_ACCESS_KEY_SECRETが設定されていることを確認してください。
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
# バケットが配置されているリージョンのエンドポイントを指定します。 たとえば、バケットが中国 (杭州) リージョンにある場合、エンドポイントをhttps://oss-cn-hangzhou.aliyuncs.comに設定します。
# バケットの名前を指定します。 例: examplebucket.
bucket = oss2.Bucket(auth, 'https:// oss-cn-hangzhou.aliyuncs.com ', 'examplebucket')
トライ:
// ダウンロードしたオブジェクトの名前を指定します。 例: exampleobject.txt。
stream = bucket.get_object ('exampleobject.txt ')
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 | 現在のオブジェクトは追加可能なオブジェクトではありません。 |