Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド

アクティビティ・ストリームのリスト

get

/api/v2/activity_stream/

このリソースに対してGETリクエストを行って、アクティビティ・ストリームのリストを取得します。

結果のデータ構造には次が含まれます。

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

countフィールドは、対象となる問合せで見つかったアクティビティ・ストリームの合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上のアクティビティ・ストリーム・レコードが含まれます。

結果

それぞれのアクティビティ・ストリーム・データ構造には次のフィールドが含まれます。

id: このアクティビティ・ストリームのデータベースID。(整数)
type: このアクティビティ・ストリームのデータ型。(選択)
url: このアクティビティ・ストリームのURL。(文字列)
related: 関連リソースのURLを含むデータ構造。(オブジェクト)
summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
timestamp: (日時)
operation: 対象となるオブジェクトに対して実行されたアクション。(選択)
- create: エンティティの作成
- update: エンティティの更新
- delete: エンティティの削除
- associate: エンティティを別のエンティティに関連付け
- disassociate: エンティティと別のエンティティの関連付けを解除
changes: オブジェクトが作成、更新または削除された場合の新しい値と変更された値のサマリー(json)
object1: create、updateおよびdeleteイベントの場合、これは影響を受けたオブジェクト・タイプです。 associateおよびdisassociateイベントの場合、これはobject2に関連付けられたオブジェクト・タイプか、関連付けが解除されたオブジェクト・タイプです。(文字列)
object2: create、updateおよびdeleteイベントの場合、移入されません。 associateおよびdisassociateイベントの場合、これはobject1が関連付けられるオブジェクト・タイプです。(文字列)
object_association: 存在する場合は、変更されたロールまたはリレーションシップのフィールド名が表示されます。(フィールド)
action_node: アクティビティが実行されたクラスタ・ノード。(文字列)
object_type: 存在する場合は、ロールまたはリレーションシップの定義の基礎となったモデルが表示されます。(フィールド)

ソート

アクティビティ・ストリームが特定の順序で返されるように指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。

?order_by=

フィールド名の先頭にダッシュ-を付けると逆の順序でソートされます。

?order_by=-

フィールド名をカンマ,で区切ると、複数のソート・フィールドを指定できます。

?order_by=,some_other_field

ページ区切り

リクエストごとに返される結果の数を変更するには、page_size問合せ文字列パラメータを使用します。特定のページの結果を取得するには、page問合せ文字列パラメータを使用します。

?page_size=100&page=2

結果で返されるpreviousリンクおよびnextリンクは、これらの問合せ文字列パラメータを自動的に設定します。

検索

モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search問合せ文字列パラメータを使用します。

?search=findme

(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。

?related__search=findme

リクエスト

サポートされているメディア・タイプ

application/json

問合せパラメータ

page(オプション): 整数

ページ区切りが設定された結果セット内のページ番号。
page_size(オプション): 整数

ページごとに返す結果の数。
search(オプション): 文字列

検索条件。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

レスポンスの例(application/json)

{
    "count":2,
    "next":null,
    "previous":null,
    "results":[
        {
            "action_node":"awx",
            "changes":{
                "custom_virtualenv":null,
                "description":"test-org-desc",
                "id":1,
                "max_hosts":0,
                "name":"test-org"
            },
            "id":1,
            "object1":"organization",
            "object2":"",
            "object_association":"",
            "object_type":"",
            "operation":"create",
            "related":{
                "organization":[
                    "/api/v2/organizations/1/"
                ]
            },
            "summary_fields":{
                "organization":[
                    {
                        "description":"test-org-desc",
                        "id":1,
                        "name":"test-org"
                    }
                ]
            },
            "timestamp":"2018-02-01T08:00:00.000000Z",
            "type":"activity_stream",
            "url":"/api/v2/activity_stream/1/"
        },
        {
            "action_node":"awx",
            "changes":{
                "email":"",
                "first_name":"",
                "id":1,
                "is_superuser":true,
                "last_name":"",
                "password":"hidden",
                "username":"admin"
            },
            "id":2,
            "object1":"user",
            "object2":"",
            "object_association":"",
            "object_type":"",
            "operation":"create",
            "related":{
                "user":[
                    "/api/v2/users/1/"
                ]
            },
            "summary_fields":{
                "user":[
                    {
                        "first_name":"",
                        "id":1,
                        "last_name":"",
                        "username":"admin"
                    }
                ]
            },
            "timestamp":"2018-02-01T08:00:00.000000Z",
            "type":"activity_stream",
            "url":"/api/v2/activity_stream/2/"
        }
    ]
}

先頭に戻る