Versions Compared

    Key

    • This line was added.
    • This line was removed.
    • Formatting was changed.
    Comment: Published by Scroll Versions from this space and version 20.8
    Sv translation
    languageen

    This page describes the Configuration API methods you can use to read and modify selected Controller configuration settings programmatically. You can use it to script or automate tasks that must be performed frequently or in large batches, such as adding users. 

    Info

    The Configuration Export and Import API provides the ability to perform select configuration changes as well as you can edit and import Controller configuration definition files.

    Create and Modify AppDynamics Users

    Use this to create or modify user accounts in the Controller.

    You pass the user configuration settings as query parameters to the API call. The format of the create and modify user calls are identical except for the user-id parameter, which is not passed for the create operation. The user-id is generated by the create operation. 

    Format

    POST /controller/rest/users

    Input Parameters

    Parameter Name

    Parameter Type

    Value

    Mandatory

    user-name

    Query

    user name

    Yes

    user-id

    Query

    user id

    No for a create; yes for an update

    user-display-name

    Query

    display name

    Yes

    user-roles

    Query

    comma-separated list of roles

    No

    user-password

    Query

    user password

    Yes for a create; optional for an update

    user-email

    Query

    user email

    Yes

    Example

    No Format
    curl -X POST --user user1@customer1:your_password http://demo.appdynamics.com/controller/rest/users?user-name=user2\&user-display-name=User%20Two\&user-password=welcome\&user-email=user2\@example.com

    Include or Exclude a Business Transaction from Monitoring

    You can exclude or include business transactions for monitoring by passing the exclude parameter to the business-transactions retrieval API described in the Application Model API.

    To exclude a business transaction, pass the XML-represented ID of the business transaction to be excluded with the exclude parameter set to true. To turn on monitoring for a currently excluded business transaction, set the exclude parameter to false

    Send the list of business transactions to be excluded or re-included as the XML-formatted POST payload. A sample business-transaction list is:

    No Format
    <business-transactions>
        <business-transaction>
            <id>15</id>
        </business-transaction>
        <business-transaction>
            <id>16</id>
        </business-transaction>
    </business-transactions>
    
    Note

    Ensure that the Content-Type header is set to application/xml.


    Format

    POST /controller/rest/applications/application_id/business-transactions

    Input Parameters

    Parameter Name

    Parameter Type

    Value

    Mandatory

    application_id

    URI

    Provide either the application name or application id.

    Yes

    exclude

    Post

    true|false

    Yes

    Example

    No Format
    curl -X POST -H "Content-Type:text/xml" --user user1@customer1:your_password http://demo.appdynamics.com/controller/rest/applications/6/business-transactions\?exclude=true -d @businesstransaction.xml

    Retrieve All Controller Settings

    The Controller global configuration values are made up of the Controller settings that are presented in the Administration Console

    Format

    GET /controller/rest/configuration

    Input Parameters

    Parameter Name

    Parameter Type

    Value

    Mandatory

    output

    Query

    HTTP Request parameter included as part of the URL to change the output format. Valid values are XML (default) or JSON.

    No

    Example

    No Format
    curl --user admin@customer1:your_password http://demo.appdynamics.com/controller/rest/configuration
     
    <configuration-items><configuration-item>
      <name>eventsvc.request.segment.data.max.retrieval.size</name>
      <value>5000</value>
      <description>Max number of request segment data that can be retrieved from event service in a query</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    <configuration-item>
      <name>machine.agent.max.new.actions.per.min</name>
      <value>15</value>
      <description>Maximum number of new actions dispatched per minute for each machine agent</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    ...
    <configuration-item>
      <name>tss.retention.period</name>
      <value>336</value>
      <description>Time (in hours) to retain 12 hour tss data values before they are purged from the system.</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    <configuration-item>
      <name>snapshots.retention.period</name>
      <value>336</value>
      <description>Time (in hours) to retain snapshots before they are purged from the system.</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    <configuration-item>
      <name>metrics.min.retention.period</name>
      <value>4</value>
      <description>Time (in hours) to retain minute metric data values before they are purged from the system.</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    <configuration-item>
      <name>system.notification.event.types</name>
      <value>LICENSE,DISK_SPACE,CONTROLLER_AGENT_VERSION_INCOMPATIBILITY,CONTROLLER_EVENT_UPLOAD_LIMIT_REACHED,CONTROLLER_RSD_UPLOAD_LIMIT_REACHED,CONTROLLER_METRIC_REG_LIMIT_REACHED,CONTROLLER_METRIC_DATA_BUFFER_OVERFLOW,CONTROLLER_ERROR_ADD_REG_LIMIT_REACHED,CONTROLLER_ASYNC_ADD_REG_LIMIT_REACHED,AGENT_ADD_BLACKLIST_REG_LIMIT_REACHED,AGENT_METRIC_BLACKLIST_REG_LIMIT_REACHED,CONTROLLER_STACKTRACE_ADD_REG_LIMIT_REACHED,CONTROLLER_SEP_ADD_REG_LIMIT_REACHED,CONTROLLER_MEMORY_ADD_REG_LIMIT_REACHED,CONTROLLER_TRACKED_OBJECT_ADD_REG_LIMIT_REACHED,CONTROLLER_COLLECTIONS_ADD_REG_LIMIT_REACHED</value>
      <description>Comma separated list of Event Types (with no spaces between each) that will shown as System Notifications in the UI.</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    </configuration-items>

    Retrieve a Controller Setting by Name

    Use this to get the value of a given Controller configuration setting.  

    Format 

    GET /configuration?name=controller_setting_name

    Input Parameters

    Parameter Name

    Parameter Type

    Value

    Mandatory

    name

    Query

    Name of the Controller setting to retrieve

    Yes

    output

    Query

    HTTP Request parameter included as part of the URL to change the output format. Valid values are XML (default) or JSON.

    No

    Example

    No Format
    curl --user admin@customer1:your_password http://demo.appdynamics.com/controller/rest/configuration?name=metrics\.min\.retention\.period
    
    <configuration-items><configuration-item>
      <name>metrics.min.retention.period</name>
      <value>4</value>
      <description>Time (in hours) to retain minute metric data values before they are purged from the system.</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    </configuration-items>

    Configure Global Controller Settings

    Use this to set a Controller setting to a specified value.

    Note

    You cannot use this REST API to modify Controller settings on SaaS.

    Format 

    POST /controller/rest/configuration

    Input Parameters

    Parameter Name

    Parameter Type

    Value

    Mandatory

    name

    Query

    Name of the Controller setting to get.

    Yes

    value

    Query

    Value to set.

    Yes

    Mark Nodes as Historical

    Use this to mark nodes as historical, which directs AppDynamics to stop collecting metrics for the nodes. By default, AppDynamics marks as historical (soft deletes) a node that has lost contact with the Controller for the number of hours configured in the node.retention.period Controller setting. The default is 500 hours.

    Pass one or more identifiers of the node to be marked as historical, up to a maximum of 25 nodes. Multiple IDs should be comma-separated.

    Format

    POST /controller/rest/mark-nodes-historical?application-component-node-ids=value

    Input Parameters

    Parameter Name

    Parameter Type

    Value

    Mandatory

    application-component-node-ids

    Query

    Comma-separated list of node IDs

    Yes

    Example

    No Format
    curl -X POST --user admin@customer1:your_password http://demo.appdynamics.com/controller/rest/mark-nodes-historical?application-component-node-ids=44,45
     
    <application-component-node-id>
    <44/>
    <45/>
    </application-component-node-id>
    Sv translation
    languageja
    Appd tocbox
    Width325px

    On this page

    Table of Contents
    maxLevel2

    構成 API を使用すると、選択したコントローラ構成の設定を、プログラムによって読み取りおよび変更することができます。API を使用して、頻繁に実行する必要があるタスクや、ユーザの追加などの大規模なバッチをスクリプト化または自動化できます。 

    Info

    コントローラのコンフィギュレーション定義ファイルを編集してインポートすることができるため、構成インポートおよびエクスポート API では、API を使用して設定の変更を選択する機能も用意されています。

    AppDynamics ユーザを作成および変更する

    コントローラでユーザアカウントを作成または変更します。

    API コールに対して、ユーザ設定をクエリパラメータとして渡します。ユーザコールの作成および変更形式は、作成操作で渡されない user-id パラメータを除き、同一です。user-id は作成操作によって生成されます。 

    形式

    POST /controller/rest/users

    入力パラメータ

    Parameter Name

    Parameter Type

    Value

    必須

    user-name

    [Query(クエリ)]

    ユーザ名

    あり

    user-id

    [Query(クエリ)]

    ユーザ ID

    作成の場合は「いいえ」、更新の場合は「はい」

    user-display-name

    [Query(クエリ)]

    表示名

    あり

    user-roles

    [Query(クエリ)]

    ロールのカンマ区切りリスト

    なし

    user-password

    [Query(クエリ)]

    ユーザのパスワード

    作成の場合は「はい」、更新はオプション

    user_email

    [Query(クエリ)]

    ユーザの電子メール

    あり

    No Format
    curl -X POST --user user1@customer1:your_password http://demo.appdynamics.com/controller/rest/users?user-name=user2\&user-display-name=User%20Two\&user-password=welcome\&user-email=user2\@example.com

    ビジネストランザクションをモニタリング対象に含めるか除外する

    Application Model API」で説明されているビジネストランザクション取得 API に対して exclude パラメータのバイパスをモニタリングするビジネストランザクションを除外するか、含めることができます。

    ビジネストランザクションを除外するには、exclude パラメータを true に設定して、除外されるビジネストランザクションの XML で表された ID を渡します。現在除外されているビジネストランザクションのモニタリングをオンにするには、exclude パラメータを false に設定します。 

    除外する、または再度含めるようにするビジネストランザクションのリストを、XML 形式の POST ペイロードとして送信します。ビジネス トランザクション リストのサンプルは次のとおりです。

    No Format
    <business-transactions>
        <business-transaction>
            <id>15</id>
        </business-transaction>
        <business-transaction>
            <id>16</id>
        </business-transaction>
    </business-transactions>
    

    Content-type ヘッダーが「application/xml」に設定されていることを確認してください。

    形式

    POST /controller/rest/applications/application_id/business-transactions

    入力パラメータ

    Parameter Name

    Parameter Type

    Value

    必須

    application_id

    URI

    アプリケーション名またはアプリケーション ID のいずれかを指定します。

    あり

    exclude

    2 四半期

    true|false

    あり

    No Format
    curl -X POST -H "Content-Type:text/xml" --user user1@customer1:your_password http://demo.appdynamics.com/controller/rest/applications/6/business-transactions\?exclude=true -d @businesstransaction.xml

    すべてのコントローラの設定を取得する

    コントローラのグローバル構成値は、管理コンソールに表示されるコントローラ設定で構成されます。 

    形式

    GET /controller/rest/configuration

    入力パラメータ

    Parameter Name

    Parameter Type

    Value

    必須

    出力

    [Query(クエリ)]

    出力形式を変更するために URL の一部として含まれている HTTP リクエストパラメータ。有効な値は「XML」(デフォルト)または「JSON」です。

    なし

    No Format
    curl --user admin@customer1:your_password http://demo.appdynamics.com/controller/rest/configuration
     
    <configuration-items><configuration-item>
      <name>eventsvc.request.segment.data.max.retrieval.size</name>
      <value>5000</value>
      <description>Max number of request segment data that can be retrieved from event service in a query</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    <configuration-item>
      <name>machine.agent.max.new.actions.per.min</name>
      <value>15</value>
      <description>Maximum number of new actions dispatched per minute for each machine agent</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    ...
    <configuration-item>
      <name>tss.retention.period</name>
      <value>336</value>
      <description>Time (in hours) to retain 12 hour tss data values before they are purged from the system.</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    <configuration-item>
      <name>snapshots.retention.period</name>
      <value>336</value>
      <description>Time (in hours) to retain snapshots before they are purged from the system.</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    <configuration-item>
      <name>metrics.min.retention.period</name>
      <value>4</value>
      <description>Time (in hours) to retain minute metric data values before they are purged from the system.</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    <configuration-item>
      <name>system.notification.event.types</name>
      <value>LICENSE,DISK_SPACE,CONTROLLER_AGENT_VERSION_INCOMPATIBILITY,CONTROLLER_EVENT_UPLOAD_LIMIT_REACHED,CONTROLLER_RSD_UPLOAD_LIMIT_REACHED,CONTROLLER_METRIC_REG_LIMIT_REACHED,CONTROLLER_METRIC_DATA_BUFFER_OVERFLOW,CONTROLLER_ERROR_ADD_REG_LIMIT_REACHED,CONTROLLER_ASYNC_ADD_REG_LIMIT_REACHED,AGENT_ADD_BLACKLIST_REG_LIMIT_REACHED,AGENT_METRIC_BLACKLIST_REG_LIMIT_REACHED,CONTROLLER_STACKTRACE_ADD_REG_LIMIT_REACHED,CONTROLLER_SEP_ADD_REG_LIMIT_REACHED,CONTROLLER_MEMORY_ADD_REG_LIMIT_REACHED,CONTROLLER_TRACKED_OBJECT_ADD_REG_LIMIT_REACHED,CONTROLLER_COLLECTIONS_ADD_REG_LIMIT_REACHED</value>
      <description>Comma separated list of Event Types (with no spaces between each) that will shown as System Notifications in the UI.</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    </configuration-items>

    コントローラの設定を名前ごとに取得する

    指定したコントローラ構成の設定値を取得します。  

    形式

    GET /configuration?name=controller_setting_name

    入力パラメータ

    Parameter Name

    Parameter Type

    Value

    必須

    name

    [Query(クエリ)]

    取得するコントローラ設定の名前

    あり

    出力

    [Query(クエリ)]

    出力形式を変更するために URL の一部として含まれている HTTP リクエストパラメータ。
    有効な値は「XML」(デフォルト)または「JSON」です。

    なし

    No Format
    curl --user admin@customer1:your_password http://demo.appdynamics.com/controller/rest/configuration?name=metrics\.min\.retention\.period
    
    <configuration-items><configuration-item>
      <name>metrics.min.retention.period</name>
      <value>4</value>
      <description>Time (in hours) to retain minute metric data values before they are purged from the system.</description>
      <updateable>true</updateable>
      <scope>cluster</scope>
    </configuration-item>
    </configuration-items>

    グローバルコントローラを設定する

    コントローラ構成を指定された値に設定します。

    Note

    この REST API を使用して SaaS のコントローラ構成を変更することはできません。

    形式

    POST /controller/rest/configuration

    入力パラメータ

    Parameter Name

    Parameter Type

    Value

    必須

    name

    [Query(クエリ)]

    取得するコントローラ設定の名前。

    あり

    の値を入力します。

    [Query(クエリ)]

    設定する値。

    あり

    ノードを履歴としてマークする

    ノードを履歴としてマークし、ノードでのメトリックの収集を停止するよう AppDynamics に指示します。デフォルトでは、node.retention.period コントローラ設定で設定した時間切断されていたコントローラを持つノードが、AppDynamics で履歴としてマーク(削除済みアイテムフォルダへ移動)されます。デフォルトは 500 時間です。

    履歴としてマークされるノードの識別子を 1 つ以上(最大 25 ノード)渡します。ID が複数ある場合はカンマで区切って指定する必要があります。

    形式

    POST /controller/rest/mark-nodes-historical?application-component-node-ids=value

    入力パラメータ

    Parameter Name

    Parameter Type

    Value

    必須

    application-component-node-ids

    [Query(クエリ)]

    ノード ID のカンマ区切りリスト

    あり

    No Format
    curl -X POST --user admin@customer1:your_password http://demo.appdynamics.com/controller/rest/mark-nodes-historical?application-component-node-ids=44,45
     
    <application-component-node-id>
    <44/>
    <45/>
    </application-component-node-id>