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

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

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

• タグキー名には、名前の前後に空白を入れないでください。入力内容に空白がある場合は、タグキーの作成時に空白が削除されます。
• キーと値は大文字と小文字が区別されます。ただし、個別のエンティティに関連付けられている場合、タグキーが異なる場合があります。

  たとえば、タグ [OWNER: Joe] と [owner: John] について考えてみます。キー名「owner」は同じですが、アルファベットの大文字と小文字が異なります。

  これらのタグが同じエンティティに関連付けられている場合、タグキー名は大文字と小文字に関係なく同じであるため、エンティティは最後に適用されたタグ [owner: John] のみを認識します。逆に、タグが異なるエンティティに関連付けられている場合、タグキーは各エンティティに一意であるため、各エンティティはそれぞれのタグを認識します。

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

形式

POST controller/restui/tags/tagEntitiesInBatch

Input parameters

要求の例

{
"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"
}
]
}
]
}

応答の例

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

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

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

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

Input parameters

例

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

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

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

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

Input parameters

Example

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

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

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

POST /controller/restui/tags/removeAllTagsOnEntitiesInBatch

Input parameters

要求の例

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

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

応答の例

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