API V3 マニュアル > エラーについて

エラーレスポンスの形式

API実行時にエラーが発生すると以下のようなレスポンスが返ります。

HTTP/1.1 4XX エラータイプ
{
"error"": {
"message": "エラー内容"
}
}

各API共通のエラーレスポンス

ここでは各APIで共通して発生するエラーについてご説明します。

URLが間違っています

HTTP/1.1 404 Page Not Found
{
"result": false,
"exception": "Page Not Found",
"exceptiontype": "EPageOrActionNotFoundException"
}

URLが以下のようになっているか確認してください。
http(s)://<ホスト名>/fileblog/api/v3/<APIグループ名>/<API名>

HTTPメソッドが間違っています

HTTP/1.1 403 Forbidden
{
"error": {
"message": "Your request's HTTP request method is \"GET\".This function only accepts the HTTP request method \"POST\"."
}
}

GETではなくPOSTを指定してください。

API名が間違っています

HTTP/1.1 403 Forbidden
{
"error": {
"message": "Unknown API function:file/list_folder"
}
}

/file/list_folderではなく/files/list_folderに修正します。

認証に失敗しました（Authorizationの指定がない）

HTTP/1.1 401 UnAuthorized
{
"error": {
"message": "Must provide HTTP header \"Authorization\"."
}
}

HTTPヘッダにAuthorizationフィールドが見つかりません。
Authorization: Bearer CA4C1E2219374643ACBA8B4BEE12319F　のように指定してください

認証に失敗しました（Authorizationの間違い）

HTTP/1.1 401 UnAuthorized
{
"error": {
"message": "Invalid authorization value in HTTP header \"Authorization\": \"CA4C1E2219374643ACBA8B4BEE12319F\". Expecting \"Bearer <access_token>\"."
}
}

HTTPヘッダのAuthorizationフィールドの値が正しく指定されていません。
Authorization: Bearer CA4C1E2219374643ACBA8B4BEE12319F　のように指定してください

認証に失敗しました（その他）

HTTP/1.1 401 UnAuthorized
{
"error": {
"message": "Invalid access token."
}
}

以下の理由が考えられます。

•セッションがタイムアウトした。

•アクセストークンの指定方法が間違っている。指定方法についてはこちらをご確認ください。

Content-Typeが間違っています

HTTP/1.1 403 Forbidden
{
"error": {
"message": "Error in call to API function \"files/list_folder\": Bad HTTP \"Content-Type\" header: \"text/plain;charset=UTF-8\". Expecting one of \"application/json\", \"application/json; charset=utf-8\"."
}
}

application/jsonを指定します。

リクエスト本文が指定されていません

HTTP/1.1 403 Forbidden
{
"error": {
"message": "Error in call to API function \"files/list_folder\": This function requires its argument in the HTTP request body, but your request body is empty."
}
}

本文をjson形式で指定します。

リクエスト時の本文がjson形式になっていません

HTTP/1.1 403 Forbidden
{
"error": {
"message": "Error in call to API function \"files/list_folder\": request body: could not decode input as JSON."
}
}

本文をjson形式で指定します。

必須パラメータが指定されていません

HTTP/1.1 403 Forbidden
{
"error": {
"message": "Error in call to API function \"files/list_folder\": request body: missing required field \"path\"."
}
}

パラメータを指定してください。もしくはpathの綴りが間違っていないか確認してください。

パラメータの値が空になっています

HTTP/1.1 403 Forbidden
{
"error": {
"Error in call to API function \"files/list_folder\": request body: empty value on \"path\" field is not allowed"
}
}

値を設定してください。

パラメータ名が間違っています

HTTP/1.1 403 Forbidden
{
"error": {
"message": "Error in call to API function \"files/list_folder\": request body: unknown field \"limt\""
}
}

パラメータ名を確認してください。（ここではlimitのスペルが間違っています）

pathに指定されたファイル/フォルダが見つかりません

HTTP/1.1 404 File Not Found
{
"error": {
"message": "指定されたパスが見つかりません。 (3) (/DocRoot/aaa)"
}
}

pathに指定されたファイル・フォルダが存在しません。値を確認してください。

Windowsセキュリティの読み取り権限がありません

HTTP/1.1 403 Access Denied
{
"error": {
"message": "アクセスが拒否されました。 (5) (/DocRoot/win_security/cannotRead)"
}
}

pathに指定したフォルダのWindowsセキュリティの読み取り権限がありません。

FileBlogセキュリティの読み取り権限がありません

HTTP/1.1 403 Access Denied (securityconfig)
{
"error": {
"message": "読み取り権限が不足しています (FileBlogセキュリティ設定が原因です) (/DocRoot/fb_security/cannotRead)"
}
}

pathに指定したフォルダのFileBlogセキュリティの読み取り権限がありません。

ドキュメントルート外です

HTTP/1.1 403 Forbidden
{
"error": {
"message": "ルートフォルダ外です (/sample/sample.txt)"
}
}

指定したパスがドキュメントルート外です。パスの表記が間違っていないかエイリアス名が間違っていないか確認してください。パスについてはこちらをご覧ください。

ファイルが読み取り専用になっています

HTTP/1.1 403 Access Denied
{
"error": {
"message": "このファイルは読み取り専用のため更新できません (/DocRoot/sample.txt)"
}
}

書き込み先のファイルが読み取り専用になっています。（読み取り専用フラグを外してください）

他のプロセスによって使用されています

HTTP/1.1 403 Sharing Violation
{
"error": {
"message": "プロセスはファイルにアクセスできません。別のプロセスが使用中です。 (32) (/DocRoot/sample.txt)"
}
}

書き込み先のファイルが他のプロセスによって使用されています。他のプロセスを終了するか、ファイルを閉じてください。