コントローラAPIの使用
このページでは、API の使用状況について説明します。コントローラ API は、イベントサービスまたはエージェントコンポーネントによってではなく、コントローラインスタンスによって提供されます。具体的には以下のとおりです。
- アカウント API
- アプリケーションモデル API
- メトリックとスナップショット API
- アラートと応答API
- 構成 API
- 構成インポートおよびエクスポート API
- 分析イベント API
コントローラ API のベース URI
特定のメソッドの形式リストに示されている場合を除き、コントローラ API の URI には次のベース URI を使用します。
http://<controller_host>:<controller_port>/controller/rest/<REST_URI>JSON 形式のデータの取得
Splunk AppDynamics コントローラ API は、拡張マークアップ言語（XML）または JavaScript Object Notation（JSON）でデータを返します。デフォルトの出力形式は XML です。
コントローラ API のベース URI に表示される /controller/rest/ の URI を持つコントローラ API は、JSON 形式でデータを返すことができます。
JSON 形式でデータを取得するには、次のように出力クエリパラメータを JSON に設定して API を呼び出します。
curl --user user1@customer1:secret http://demo.appdynamics.com/controller/rest/applications?output=JSON
[
{
"description": "",
"id": 5,
"name": "ECommerce_E2E"
},
{
"description": "",
"id": 8,
"name": "ECommerce_E2E-Fulfillment"
},
]コントローラ API の場合は、JSON 出力形式を指定できます。
クライアントが HTTP 1.1 を使用し、gzip コンテンツのエンコーディングを受け入れる場合、コントローラは gzip 圧縮を使用して JSON 応答を返します。
認証
認証に OAuth ID タイプを使用できます。「API クライアント」を参照してください。
基本 HTTP 認証を使用して REST API を呼び出すには、認証クレデンシャルとアカウント情報を指定する必要があります。これらを次に示します。
- アカウント：Splunk AppDynamics テナントアカウント名
- ユーザ名：このアカウントのユーザ
- パスワード：このアカウントに設定したパスワード
次の形式で認証情報を渡します。
<your_username>@<your_accountname>:<your_password>
ほとんどのオンプレミスコントローラは、プライマリ デフォルト アカウント名として customer1 を使用するシングルテナント コントローラです。アカウント名はデフォルトのままにしておく必要があります。例：
<your_username>@customer1:<your_password>
ほとんどの SaaS コントローラはマルチテナントコントローラであり、customer1 を独自のインスタンス固有のアカウント名に置き換えることができます。「ライセンス使用状況の確認」を参照してください。
ユーザ名とパスワードに使用できない文字
REST API コールでは、次の表に指定される文字を含むユーザー名とパスワードは認証されません。
| 無効な文字 | |
|---|---|
| ユーザ名: |
\ / " [ ] : |< > + =;, ? * , ' % <tab> <space> @ |
|
パスワード： |
+ % \ |
許可されていない文字のいずれかを含むユーザクレデンシャル（「User: customer66」など）をすでに作成している場合は、許可された文字のみを使用して新しい認証情報を作成し、REST API へアクセスします。
「@」記号を含むユーザ名またはパスワードの場合、URL では「@」文字が %40 にエンコードされます。
メトリックブラウザでのメトリック URL のコピー
- [Metric Browser] のメトリックを右クリックします。
- メトリックの完全な REST URL をコピーします。
- REST URL をコードまたはコマンドラインに貼り付けます。