アクション API

このページでは、イベントへの応答としてトリガーされるさまざまなアクションを作成、設定、および管理するために使用できる、アクション API メソッドについて説明します。この API を使用して、次のタイプのアクションを作成します。

警告: JSON ペイロードの構文検証は、アクションの作成時に実行されます。

新しいアクションの作成

指定された JSON ペイロードを使用して新しいアクションを作成します。「プロパティの詳細」を参照してください。

リソースURL

POST <controller_url>/controller/alerting/rest/v1/applications/<application_id>/actions

要求/応答の形式

JSON

例

リクエスト

この例では、タイプ「スレッドダンプ」のアクションを作成します。「例のダウンロード」を参照してください。

{
         "actionType": "THREAD_DUMP",
         "name": "Thread Dump Action",
         "numberOfThreadDumps": 2,
         "intervalInMs": 500,
         "approvalBeforeExecution": {
             "requireApproval": true,
             "approverEmail": "email@website.com"
         }
}

レスポンス

この例では、作成されたアクションオブジェクトを返します。

{
		 "id": "3",
         "actionType": "THREAD_DUMP",
         "name": "Thread Dump Action",
         "numberOfThreadDumps": 2,
         "intervalInMs": 500,
         "approvalBeforeExecution": {
             "requireApproval": true,
             "approverEmail": "email@website.com"
         }
}

特定のアプリケーションに対するアクションリストの取得

指定されたアプリケーション ID に関連するアクションのアクション ID、名前、および説明を返します。「プロパティの詳細」を参照してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/actions

応答形式

JSON

応答の例

この例では、特定のアプリケーション ID に関連するアクションリストを返します。

[{"id":1,"name":"Thread Dump Action","actionType":"THREAD_DUMP"}]

指定されたアクションの詳細の取得

指定された ID を持つアクションの詳細を取得します。「プロパティの詳細」を参照してください。

注: 有効なアクション ID が指定されていることを確認してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/actions/{action-id}

応答形式

JSON

応答の例

この例では、アクションの詳細を取得します。「例のダウンロード」を参照してください。

{
 "id": 1,
 "actionType": "THREAD_DUMP",
 "name": "Thread Dump Action",
 "numberOfThreadDumps": 2,
 "intervalInMs": 500,
 "approvalBeforeExecution": {
 "requireApproval": true,
 "approverEmail": "email@website.com"
 }
}

アクションの更新

指定された JSON ペイロードを使用して既存のアクションを更新します。「プロパティの詳細」を参照してください。

ヒント: この要求には、入力として完全な JSON ペイロードが必要です。そのため、 GET /action/(action-id) を使用して JSON ペイロードを取得し、必須フィールドを更新することをお勧めします。その後、変更したペイロードを要求の一部として送信します。

リソースURL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action/{action-id}

要求/応答の形式

JSON

例

この例では、アクションを更新します。「例のダウンロード」を参照してください。

リクエスト

{
         "actionType": "THREAD_DUMP",
         "name": "Thread Dump Action",
         "numberOfThreadDumps": 2,
         "intervalInMs": 500,
         "approvalBeforeExecution": {
             "requireApproval": true,
             "approverEmail": "email@website.com"
         }
}

レスポンス

この例では、更新されたアクションを返します。

{
		 "id": "3",
         "actionType": "THREAD_DUMP",
         "name": "Thread Dump Action",
         "numberOfThreadDumps": 2,
         "intervalInMs": 500,
         "approvalBeforeExecution": {
             "requireApproval": true,
             "approverEmail": "email@website.com"
         }
}

アクションの削除

指定された ID を持つアクションを削除します。「プロパティの詳細」を参照してください。

注: 有効なアクション ID が指定されていることを確認してください。

リソースURL

DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action/{action-id}

応答コード


コード	説明
200	正常に取得されました
201	正常に作成されました
204	正常に削除されました
400	Bad request
401	Unauthorized
403	Forbidden
404	リソースが見つかりません
409	すでに存在します

Property Details

アクション

イベントに対する応答としてトリガーされたアクションのペイロードの詳細。


プロパティ名	タイプ	説明と有効な値
id	整数	これはシステムによって自動生成され、応答で返されます。これは readOnly 値です。
actionType	文字列	イベントに対する応答としてトリガーされたアクションのタイプ。 Enums SMS EMAIL CUSTOM_EMAIL THREAD_DUMP HTTP_REQUEST RUN_SCRIPT_ON_NODES DIAGNOSE_BUSINESS_TRANSACTIONS CREATE_UPDATE_JIRA

SmsAction

SMS 通知がイベントへの応答としてトリガーされます。

警告:

注

AppDynamics の電子メールと SMS の設定が完了していることを確認します。「メールサーバの有効化」を参照してください。


プロパティ名	タイプ	説明と有効な値
id	整数	これはシステムによって自動生成され、応答で返されます。これは readOnly 値です。
actionType^*	文字列	イベントに対する応答としてトリガーされたアクションのタイプ。 Enums SMS EMAIL CUSTOM_EMAIL THREAD_DUMP HTTP_REQUEST RUN_SCRIPT_ON_NODES DIAGNOSE_BUSINESS_TRANSACTIONS CREATE_UPDATE_JIRA
phoneNumber^*	文字列パターン： D10

EmailAction

電子メール通知がイベントへの応答としてトリガーされます。


プロパティ名	タイプ	説明と有効な値
id	整数	これはシステムによって自動生成され、応答で返されます。これは readOnly 値です。
actionType^*	文字列	イベントに対する応答としてトリガーされたアクションのタイプ。 Enums SMS EMAIL CUSTOM_EMAIL THREAD_DUMP HTTP_REQUEST RUN_SCRIPT_ON_NODES DIAGNOSE_BUSINESS_TRANSACTIONS CREATE_UPDATE_JIRA
emails^*	文字列 pattern pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$

CustomEmailAction

事前定義されたテンプレートに基づいて電子メール通知がイベントへの応答としてトリガーされます。

注: テンプレートをアクションに使用するには、事前にテンプレートが作成されている必要があります。サポートされている SFP および SFP+ モジュールのリストについては、

電子メールテンプレート

プロパティ名タイプ説明と有効な値

id

整数

これはシステムによって自動生成され、応答で返されます。

これは readOnly 値です。

actionType^*

文字列

イベントに対する応答としてトリガーされたアクションのタイプ。

Enums

SMS

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

RUN_SCRIPT_ON_NODES

DIAGNOSE_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

name^*

stringminLength: 1

ActionName

アクションに割り当てる名前。

emailTemplateName^*

stringminLength: 1

電子メール通知に使用されるテンプレートの名前。

to^*

stringpattern:

pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$

EmailArray

電子メール ID のリスト。

cc^*

stringpattern:

pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$

EmailArray

電子メール ID のリスト。

bcc^*

stringpattern:

pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$

EmailArray

電子メール ID のリスト。

customTemplateVariables

文字列

KeyValuePair


プロパティ名	タイプ
`key^*`	文字列
`value^*`	文字列

ThreadDumpAction

プロパティ名タイプ説明と有効な値

id

整数

これはシステムによって自動生成され、応答で返されます。

これは readOnly 値です。

actionType^*

文字列

イベントに対する応答としてトリガーされたアクションのタイプ。

Enums

SMS

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

RUN_SCRIPT_ON_NODES

DIAGNOSE_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

name^*

stringminLength: 1

ActionName

アクションに割り当てる名前。

numberOfThreadDumps^* integerminimum: 1maximum: 50 「アクション」で収集するスレッドダンプサンプルの数。

intervalInMs^* integerminimum: 500 収集されたスレッドダンプサンプル間の時間間隔（ミリ秒単位）。

approvalBeforeExecution^*

ApprovalBeforeExecution

スレッドダンプアクションが開始される前に承認を義務付けます。


プロパティ名	タイプ
`requireApproval`	boolean
`approverEmail`	文字列パターン： pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$

HttpRequestAction

プロパティ名タイプ説明と有効な値

id

整数

これはシステムによって自動生成され、応答で返されます。

これは readOnly 値です。

actionType^*

文字列

イベントに対する応答としてトリガーされたアクションのタイプ。

Enums

SMS

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

RUN_SCRIPT_ON_NODES

DIAGNOSE_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

name^*

stringminLength: 1

ActionName

アクションに割り当てる名前。

httpRequestTemplateName

文字列

minLength: 1

HTTP リクエストアクションで使用される既存の HTTP リクエストテンプレート。

customTemplateVariables

KeyValuePair


プロパティ名	タイプ
`key^*`	文字列
`value^*`	文字列

ScriptAction

プロパティ名タイプ説明と有効な値

id

整数

これはシステムによって自動生成され、応答で返されます。

これは readOnly 値です。

actionType^*

文字列

イベントに対する応答としてトリガーされたアクションのタイプ。

Enums

SMS

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

RUN_SCRIPT_ON_NODES

DIAGNOSE_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

name^*

stringminLength: 1

ActionName

アクションに割り当てる名前。

scriptPath^*

stringminLength: 1

スクリプトの相対パス。

注: 次の後にパーツを入力します。${machine.agent.directory}/local-scripts/

logFilesPath ログファイルの絶対パス。

scriptTimeout^*

文字列

integerminimum: 1maximum: 1440

approvalBeforeExecution^*

スクリプトアクションが開始される前に承認を義務付けます。


プロパティ名	タイプ
`requireApproval`	boolean
`approverEmail`	文字列パターン： pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$

DiagnosticAction


プロパティ名	タイプ	説明と有効な値
`name^*`	stringminLength: 1	ActionName アクションに割り当てる名前。
`businessTransactions^*`	文字列	指定されたビジネストランザクションで診断セッションを実行します。 Enums ALL_AFFECTED_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS
`duration^*`	integerminimum: 1maximum: 10	診断セッションを実行する時間（分単位）。
`snapshotRate^*`	integerminimum: 1maximum: 10	診断スナップショットがキャプチャされるレート。
`actionType^*`	文字列	イベントに対する応答としてトリガーされたアクションのタイプ。 Enums SMS EMAIL CUSTOM_EMAIL THREAD_DUMP HTTP_REQUEST RUN_SCRIPT_ON_NODES DIAGNOSE_BUSINESS_TRANSACTIONS CREATE_UPDATE_JIRA
`id`	整数	これはシステムによって自動生成され、応答で返されます。これは `readOnly` 値です。

JiraAction


プロパティ名	タイプ	説明と有効な値
`id`	整数	これはシステムによって自動生成され、応答で返されます。これは readOnly 値です。
`actionType^*`	文字列	イベントに対する応答としてトリガーされたアクションのタイプ。 Enums SMS EMAIL CUSTOM_EMAIL THREAD_DUMP HTTP_REQUEST RUN_SCRIPT_ON_NODES DIAGNOSE_BUSINESS_TRANSACTIONS CREATE_UPDATE_JIRA
`name^*`	stringminLength: 1	ActionName アクションに割り当てる名前。
`jiraActionDetails^*`	文字列	jiraActionType イベントに対する応答としてトリガーされた JIRA アクションタイプ。 Enums CREATE_JIRA UPDATE_JIRA

JiraActionDetails

イベントに対する応答としてトリガーされた JIRA アクションタイプ。


プロパティ名	タイプ	説明と有効な値
`jiraActionType`	文字列	Enums CREATE_JIRA UPDATE_JIRA

JiraCreateAction

Jira アクションタイプ "create JIRA" は、イベントに対する応答としてトリガーされます。


プロパティ名	タイプ	説明と有効な値
`jiraActionType^*`	文字列	Enums CREATE_JIRA UPDATE_JIRA
`assignee^*`	文字列 minLength: 1
`project^*`	文字列 minLength: 1
`priority^*`	文字列 minLength: 1
`issueType^*`	文字列 minLength: 1

JiraUpdateAction

Jira アクションタイプ "update JIRA" は、イベントに対する応答としてトリガーされます。


プロパティ名	タイプ	説明と有効な値
`jiraActionType^*`	文字列	Enums CREATE_JIRA UPDATE_JIRA
`changePriorityTo^*`	文字列 minLength: 1

ActionName

アクションに割り当てる名前。


プロパティ名	タイプ	説明と有効な値
ActionName	文字列 minLength: 1

ApprovalBeforeExecution

アクションの実行が開始される前に電子メールの承認を義務付けます。


プロパティ名	タイプ
`requireApproval`	boolean
`approverEmail`	文字列パターン： pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$

BusinessTransactions

指定されたビジネストランザクションで診断セッションを実行します。


プロパティ名	タイプ	説明と有効な値
`businessTransactionScope`	文字列	Enums ALL_AFFECTED_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

AllAffectedBusinessTransactions

すべてのビジネストランザクションで診断セッションを実行します。


プロパティ名	タイプ	説明と有効な値
`businessTransactionScope`	文字列	Enums ALL_AFFECTED_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

SpecificBusinessTransactions

指定された条件に一致するビジネストランザクションで診断セッションを実行します。


プロパティ名	タイプ	説明と有効な値
`businessTransactionScope`	文字列	Enums ALL_AFFECTED_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS
`businessTransactionNames^*`	文字列 minItems: 1

EmailArray


プロパティ名	タイプ
`EmailArray`	文字列 pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$

KeyValuePair


プロパティ名	タイプ
`key^*`	文字列
`value^*`	文字列

メールアドレス


プロパティ名	タイプ
`Email`	文字列 pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$

ActionSummaryArray


プロパティ名	タイプ	説明と有効な値
`id`	整数	これはシステムによって自動生成され、応答で返されます。これは `readOnly` 値です。
`name^*`	stringminLength: 1	Enums アクションに割り当てる名前。
`actionType^*`	文字列	イベントに対する応答としてトリガーされたアクションのタイプ。 Enums SMS EMAIL CUSTOM_EMAIL THREAD_DUMP HTTP_REQUEST RUN_SCRIPT_ON_NODES DIAGNOSE_BUSINESS_TRANSACTIONS CREATE_UPDATE_JIRA

ActionSummary


プロパティ名	タイプ	説明と有効な値
`id`	整数	これはシステムによって自動生成され、応答で返されます。これは `readOnly` 値です。
`name^*`	stringminLength: 1	ActionName アクションに割り当てる名前。
`actionType^*`	文字列	イベントに対する応答としてトリガーされたアクションのタイプ。 Enums SMS EMAIL CUSTOM_EMAIL THREAD_DUMP HTTP_REQUEST RUN_SCRIPT_ON_NODES DIAGNOSE_BUSINESS_TRANSACTIONS CREATE_UPDATE_JIRA

StringIntegerPair


プロパティ名	タイプ
`id`	整数
`name^*`	stringminLength: 1

JiraActionTypeEnum


プロパティ名	タイプ	説明と有効な値
`jiraActionTypeEnum`	文字列	CREATE_JIRA UPDATE_JIRA

BusinessTransactionScopeEnum


プロパティ名	タイプ	説明と有効な値
BusinessTransactionScopeEnum	文字列	ALL_AFFECTED_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

ActionTypeEnum


プロパティ名	タイプ	説明と有効な値
`ActionTypeEnum`	文字列	Enums SMS EMAIL CUSTOM_EMAIL THREAD_DUMP HTTP_REQUEST RUN_SCRIPT_ON_NODES DIAGNOSE_BUSINESS_TRANSACTIONS CREATE_UPDATE_JIRA

ErrorResponse


プロパティ名	タイプ
`statusCode`	整数
`message`	文字列

このプロパティは必須です。

^* This property is required.

例のダウンロード

アクションを設定するのに役立つ一連の例 actions_api.zip をダウンロードします。

SWAGGER YAML ファイルのダウンロード

Swagger の actions_openapi.yml をダウンロードします。