要求構造

使用できる要求メソッドは次のとおりです。

• GET – 指定されたオブジェクトからデータを取得します。

• PUT – 指定されたオブジェクトに情報を追加します。オブジェクトが存在しない場合は、404 エラー「リソースが見つかりません（Resource Not Found）」を返します。

• POST – 指定された情報でオブジェクトを作成します。

• DELETE – 指定されたオブジェクトを削除します。

• PATCH – 指定されたオブジェクトに部分的な変更を適用します。

応答構造

各要求によって、標準ヘッダー、応答コンテンツ、およびステータスコードを含んだ ASA からの HTTPS 応答が生成されます。

応答の構造は次のようになります。

• LOCATION - 新しく作成されたリソース ID。POST の場合のみ。新しいリソース ID を（URI 表現として）保持します。

• CONTENT-TYPE 応答メッセージ本文のメディア タイプ。応答メッセージ本文の表現と構文を示します。

各応答には HTTP ステータスまたはエラー コードが含まれます。使用可能なコードは、次のカテゴリに分けられます。

• 20x - 200 番台のコードは、次のような処理の成功を示します。

  • 200 OK – 成功した要求に対する標準応答。

  • 201 Created – 要求が完了し、新しいリソースを作成。

  • 202 Accepted – 要求が受け入れられたが、処理は未完了。

  • 204 No Content – サーバーが要求を正常に処理したが、コンテンツは未送信。

• 4xx - 400 番台のコードは、次のようなクライアント側のエラーを示します。

  • 400 Bad Request – 無効なクエリパラメータ（認識されないパラメータ、欠落しているパラメータ、または無効な値など）。

  • 404 Not Found – 指定された URL が既存のリソースと一致しない。たとえば、HTTP DELETE は、そのリソースがないために失敗する場合があります。

  • 405 Method not Allowed – リソースで許可されていない HTTP 要求が行われた（読み取り専用リソースでの POST など）。

• 5xx - 500 番台のコードは、サーバー側のエラーを示します。

エラーが発生した場合は、エラー コードに加えて、エラーに関する詳細を示すエラー オブジェクトがリターン応答に含まれる場合があります。JSON のエラーおよび警告の応答スキーマは次のとおりです。

[
{ “code” : “string”,
“details”: “string”,
“context”: attribute name,
“level” : <Error/Warning/Info>
},
...
]

ここで、オブジェクトのプロパティは次のとおりです。

（注）	REST API コールによって ASA の設定に加えられた変更は、起動設定には反映されません。つまり、変更は実行時設定だけに割り当てられます。起動設定への変更を保存するには、writemem API 要求を POST できます。詳細については、『About the ASA REST API』の目次の「Write Memory API」エントリを参照してください。

JavaScript

JavaScript ファイルを使用するには、http://nodejs.org/ にある node.js のインストールが必要です。node.js を使用すると、コマンドラインスクリプトのように、通常はブラウザ用に記述された JavaScript ファイルを実行できます。インストール手順に従った後、node script.js でスクリプトを実行します。

Python

Python スクリプトでは、https://www.python.org/ から利用できる Python をインストールする必要があります。Python をインストールしたら、python script.py username password で目的のスクリプトを実行できます。

Perl

Perl スクリプトを使用するには、いくつかの追加のセットアップが必要です。Perl 自体と、次の 4 つの Perl ライブラリを含む 5 つのコンポーネントが必要となります。

• Perl パッケージ：http://www.perl.org/

• Bundle::CPAN：http://search.cpan.org/~andk/Bundle-CPAN-1.861/CPAN.pm

• REST::Client：

  http://search.cpan.org/%7Emcrawfor/REST-Client-88/lib/REST/Client.pm

• MIME::Base64：http://perldoc.perl.org/MIME/Base64.html

• JSON：http://search.cpan.org/~makamaka/JSON-2.90/lib/JSON.pm

次に、Macintosh で Perl をブートストラップする例を示します。

$ sudo perl -MCPAN e shell
cpan> install Bundle::CPAN
cpan> install REST:: Client
cpan> install MIME::Base64
cpan> install JSON

依存関係をインストールしたら、perl script.pl username password を使用してスクリプトを実行できます。