Performance Center Web Services を使用する

以下の例では、capm RESTful Web サービスを使用する標準の手順を表しています。 この例の手順では、管理者アクセス権を必要とします。
capm250
以下の例では、
DX NetOps Performance Management
RESTful Web サービスを使用する標準の手順を表しています。 この例の手順では、管理者アクセス権を必要とします。
REST Web サービス内の基本操作
テナントの説明パラメータを更新する単純な PUT 操作の例を以下に示します。
http://
PC_host
:8181/pc/center/webservice/tenants/tenantName/tenantName/tenantDescription/NewDescription
イタリック体の部分は、必要な値に置き換えてください。 一部のパラメータは必須です。
  • tenantName
    編集するテナントの名前。
  • tenantDescription
    このテナントを識別する新しい説明。
テナント Web サービスを使用してテナント ID および名前のリストを返す単純な GET 操作の例を以下に示します。
http://
PC_host
: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 サイトを参照してください。
クライアントを使用したユーザ役割の作成
ユーザ アカウントを作成する前にユーザ アカウントの役割を作成するのがベスト プラクティスです。 役割はユーザ アカウントのパラメータであり、特定の管理機能にアクセスし、選択したタスクを実行することを可能にします。
CA
NetOps Portal
役割 Web サービスを呼び出すように設定した REST クライアントを使用できます。
以下の手順に従います。
  1. REST クライアント インターフェースで、URL フィールドに以下の URL を入力します。
    http://
    PC_host
    :8181/pc/center/webservice/roles/
  2. メソッドに
    POST
    を選択します。
  3. Body テキスト フィールドに以下のテキストを入力します。
    <role> <name>{Name for the role}</name> <description>{Text to describe the role in the UI}</description> <enabled>{Whether the role is activated or disabled}</enabled> </role>
  4. 任意の値を新しい役割に対して使用する値に置換します。
    たとえば、以下のパラメータを提供します。
    <role> <name>Data Center Manager</name> <description>Manages data center operations and performs troubleshooting</description> <enabled>True</enabled> </role>
  5. [送信]
    をクリックし、メソッドを実行します。
  6. 以下の GET メソッドを実行し、新しい役割に自動的に割り当てられた役割 ID を取得します。
    http://
    PC_host
    :8181/pc/center/webservice/roles/idNames
  7. [レスポンス ボディ(強調表示)]タブをクリックし、レスポンスを参照します。
    roleId
    の値と
    roleName
    プロパティが返されます。
    Web サービス ドキュメント インターフェースに表示される場合は、
    roleID
    値または
    roleName
    値を
    {roleIdName}
    プロパティの代わりに使用できます。
  8. (オプション)以下の手順に従い、新しい役割が作成されたことを確認します。
    1. グローバル管理者として
      NetOps Portal
      にログインします。
    2. [管理]
      [役割]
      をクリックします。
    [役割の管理]ページに役割の一覧が表示されます。 新しいロールが一覧に表示されます。
クライアントを使用したユーザ アカウントの作成
これで、設定した REST クライアントを使用し、ユーザ アカウントを追加できます。 前の手順で作成した新しい役割に役割 ID を与えます。
以下の手順に従います。
  1. REST クライアントに、CA
    NetOps Portal
    RESTful Web サービス API の URL を入力します。 次の構文を使用し、ユーザ Web サービスを呼び出します。
    http://
    PC_host
    :8181/pc/center/webservice/users/role/
    {roleIdName}
    /
    {roleIdValue}
    /
    {roleIdName}
    {roleIdValue}
    については、前の手順で roles/idNames メソッドを実行したときに返された値を使用します。
    Web サービス ドキュメント インターフェースに表示される場合は、
    roleID
    値または
    roleName
    値を
    {roleIdName}
    プロパティの代わりに使用できます。
    マルチテナンシーを展開している場合、作成した役割が、ユーザ アカウントが関連付けられるテナントと自動的に関連付けられました。
    1. HTTP メソッド
      [POST]
      を選択します。
    2. 以下の
      'application/xml'
      を、以下のように設定されたままにします。
      'Body Content-type'
      .
  2. [ボディ]テキスト フィールドに以下のパラメータを入力します。
    <user> <name>{UserName}</name> <description>{UserDescription}</description> <enabled>{UserEnabled}</enabled> <removable>{UserRemovable}</removable> <timezone>{UserTimeZone}</timezone> <culture>{UserCulture}</culture> </user>
    任意の値を新しいテナントに対して使用する値に置換します。
    たとえば、以下のパラメータを提供します。
    <user> <name>Jane Doe</name> <description>User associated with the John Doe Corporation tenant.</description> <enabled>true</enabled> <removable>true</removable> <timezone>CST6CDT</timezone> <culture>en-US</culture> </user>
    ユーザ パラメータの詳細については、「基本ユーザ アカウント パラメータ」を参照してください。
  3. メソッドを実行します。
  4. 必要な数のユーザを作成するまで、前述の手順を繰り返します。