CA Performance Center API の概要 › REST Web サービス内の基本操作

REST Web サービス内の基本操作

REST 指定はある程度の柔軟性を備えています。 そのため REST Web サービスは、基本的な HTTP 構文を使って、さまざまなタスクを実行することができます。 CA Performance Center のすべての REST Web サービスでは、HTTP リクエスト ヘッダにユーザおよびパスワード認可を埋め込む必要があります。 CA Performance Center ユーザ インターフェースからログインするときに使用するものと同じ認証情報を使用できます。

この実装では、基本的な REST コマンドを以下のように使用します。

• GET - サーバ データベースにログインしたり、サーバ データベースから情報を取得します。 ブラウザ セッションのみを必要とします。
• POST - オブジェクトを作成します。 通常、パラメータを提供するために XML 入力が必要です。
• PUT - 既存のオブジェクトを編集します。 また場合によっては、オブジェクトの作成にも使われます。 通常、パラメータを提供するために XML 入力を必要としません。
• DELETE - 既存のオブジェクトを削除します。

テナントの説明パラメータを更新する単純な PUT 操作の例を以下に示します。

http://CA Performance Center Server IP Address:8181/pc
/center/webservice/tenants/tenantName/tenantName/tenantDescription
/NewDescription

イタリック体の部分は、必要な値に置き換えてください。 一部のパラメータは必須です。

tenantName

編集するテナントの名前。

tenantDescription

このテナントを識別する新しい説明。

テナント Web サービスを使用してテナント ID および名前のリストを返す単純な GET 操作の例を以下に示します。

http://CA Performance Center Server IP Address:8181/pc
/center/webservice/tenants/idNames

以下の XML が返されます。

<?xml version="1.0" encoding="UTF-8"?>

<idNames>

  <idName value="tenantAccountId" />

  <idName value="tenantItemId" />

  <idName value="tenantName" />

</idNames>

HTTP リクエストでは、成功した場合も必ずレスポンスおよびステータス コードが返されます。 レスポンス テキストは、予測していた結果または問題を示すエラー メッセージのいずれかです。 ステータス コードは、成功レスポンスの場合の 200、または数値のエラー インジケータです。 以下の HTTP レスポンス コード範囲が使用されます。

• 200 - コマンド ステータスは「OK」です。
• 400 - ユーザ エラーが発生しました。 この範囲のエラーは、入力テキストの問題（400）またはユーザ認証情報の問題（403）を示し、通常は容易に修正できます。
• 500 - システム エラーが発生しました。 この範囲のエラーは通常、システム障害を示します。 そのようなエラーを解決するには、CA テクニカル サポートへの問い合わせが必要な場合があります。

HTTP ステータス コードの詳細については、以下の IETF Web サイトを参照してください。

http://www.ietf.org/rfc/rfc2616.txt