カスタムタグ API

コントローラにカスタムタグをインポートできます。タグを使用してエンティティをフィルタリングして表示し、正常性ルールの設定やカスタムダッシュボードの作成などのさまざまなタスクを実行することができます。カスタムタグのソースには、API または CMDB を使用できます。

タグの詳細については、「タグ」を参照してください。

現在、カスタムタグ付けでは以下のエントリがサポートされています。

エンティティ	タイプ
Application	アプリケーション
階層	APPLICATION_COMPONENT
ノード	APPLICATION_COMPONENT_NODE
サーバー	SIM_MACHINE
合成ページ	BASE_PAGE
ビジネストランザクション	BUSINESS_TRANSACTION

カスタムタグ付けの有効化

この機能を使用するには、管理コンソールで entity.tagging.enabled アカウントレベルプロパティを true に設定します。デフォルトでは、このプロパティは無効になっています。

管理コンソールは Splunk AppDynamics によって管理されます。設定を更新するには、Splunk AppDynamics サポートにお問い合わせください。

カスタムタグの追加

同じタイプのエンティティをグループ化するには、カスタムタグが必要です。tagEntitiesInBatch POST API を使用して、タグソース（CMDB または API）からコントローラにキーと値のペアをインポートすることができます。

タグに関するガイドライン

カスタムタグをコントローラにインポートする前に、次のガイドラインに従ってください。

タグキーにスペースを含めることはできません。
タグのキーと値を null にすることはできませんが、長さは最大で 255 文字にすることができます（文字、数字、句読点、および記号を含む）。
各タグキーには 1 つの値を持たせることができます。
エンティティあたりのタグの最大制限は 50 です。
エンティティあたりのタグのデフォルト制限は 25 です。50 まで拡張するには、管理者が管理コンソールを使用して max.tags.per.entity プロパティを更新します。
アカウントあたりのタグの最大制限は 100000 です。
アカウントあたりのタグのデフォルト制限は 50000 です。100000 まで拡張するには、管理者が管理コンソールで max.tags.per.account プロパティを更新します。

形式

POST controller/restui/tags/tagEntitiesInBatch

CODE

Input parameters

Parameter Name	Parameter Type	Value	必須
`entityType`	`RequestPayload`	エンティティのタイプ。値には、`APPLICATION`、`APPLICATION_COMPONENT,APPLICATION_COMPONENT_NODE, SIM_MACHINE, BASE_PAGE, BUSINESS_TRANSACTION` を使用できます	はい
`source`	`RequestPayload`	カスタムタグのソース。値には、`CMDB` または `API` を使用できます。	はい
`entities`	`RequestPayload`	`entityName` や `entityId` などのエンティティの詳細と、カスタムタグのキーと値が含まれます。ここで、`entityName` はオプションのパラメータであり、`entityId` はエンティティの Splunk AppDynamics ID（数値）です。	はい

要求の例

{
    "entityType": "APPLICATION",
    "source":"API",
    "entities" :
    [
        {
            "entityName": "sample App 1",
            "entityId": 10,
            "tags":
            [
                {
                    "key": "owner",
                    "value": "joe"
                },
                {
                    "key": "environment",
                    "value": "production"
                }
            ]
        },
        {
            "entityName": "sample App 2",
            "entityId": 12,
            "tags":
            [
                {
                    "key": "owner",
                    "value": "joe"
                },
                {
                    "key": "environment",
                    "value": "development"
                },
                {
                    "key": "criticality",
                    "value": "low"
                }
            ]
        }
    ]
}

CODE

応答の例

{
    "entityType": "APPLICATION",
    "success" : {
        "count": 1,
        "entityIds": [10]
    },
    "failure" : {
        "count": 1,
        "entityIds": [12]
    }
}

CODE

応答には、正常にタグ付けされたエンティティの数が表示されます。

エンティティのすべてのカスタムタグの削除

特定のエンティティに関連付けられているすべてのタグを削除できます。

DELETE /controller/restui/tags/allTagsOnEntity?entityId={entityId}&entityType={entityType}

CODE

Input parameters

Parameter Name	Parameter Type	Value	必須
entityId	URI	エンティティの Splunk AppDynamics ID（数値）。	はい
entityType	URI	指定した entityId の、すべてのタグを削除するエンティティのタイプ。値には、`APPLICATION`、`APPLICATION_COMPONENT,APPLICATION_COMPONENT_NODE, SIM_MACHINE, BASE_PAGE, BUSINESS_TRANSACTION` を使用できます	はい

例

この例では、ID が 10. であるアプリケーションに関連付けられたすべてのタグを削除します。

https://<controller_host>:<controller_port>/controller/restui/tags/allTagsOnEntity?entityId=10&entityType=APPLICATION

CODE

エンティティのカスタムタグの削除

特定のエンティティに関連付けられている特定のタグを削除できます。

DELETE /controller/restui/tags/tagOnEntity?tagId={tagId}&entityId={entityId}&entityType={entityType}

CODE

Input parameters

Parameter Name	Parameter Type	Value	必須
tagId	URI	タグの ID。	はい
entityId	URI	エンティティの Splunk AppDynamics ID（数値）。	はい
entityType	URI	エンティティのタイプ。値には、`APPLICATION`、`APPLICATION_COMPONENT,APPLICATION_COMPONENT_NODE, SIM_MACHINE, BASE_PAGE, BUSINESS_TRANSACTION` を使用できます	はい

Example

この例では、ID が 10 であるアプリケーションに関連付けられた ID が 5 であるタグを削除します

https://<controller_host>:<controller_port>/controller/restui/tags/tagOnEntity?tagId=5&entityId=10&entityType=APPLICATION

CODE

グループ内のエンティティのカスタムタグの削除

同じタイプのエンティティのすべてのタグを一括で削除できます。

POST /controller/restui/tags/removeAllTagsOnEntitiesInBatch

CODE

Input parameters

Parameter Name	Parameter Type	Value	必須
`entityType`	`RequestPayload`	カスタムタグを削除する必要があるエンティティのタイプ。値には、`APPLICATION`、`APPLICATION_COMPONENT,APPLICATION_COMPONENT_NODE, SIM_MACHINE, BASE_PAGE, BUSINESS_TRANSACTION` を使用できます	はい
`entityIds`	`RequestPayload`	タグを削除する必要がある entityID の配列。	はい

要求の例

https://<controller_host>:<controller_port>/controller/restui/tags/removeAllTagsOnEntitiesInBatch

CODE

{
 	"entityType": "APPLICATION",
	"entityIds" : [10, 11, 12]
}

CODE

応答の例

{
    "entityType": "APPLICATION",
    "success": {
        "count": 2,
        "entityIds": [10, 11]
    },
    "failure": {
        "count": 1,
        "entityIds": [12]
    }
}

CODE