機械翻訳について

移動先

• リクエスト
• レスポンス

アドホック・コマンドのアクティビティ・ストリームのリスト

get

/api/v2/ad_hoc_commands/{id}/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=name

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

?order_by=-name

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

?order_by=name,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

パス・パラメータ

• id(required): string

問合せパラメータ

• page: integer
  ページ区切りが設定された結果セット内のページ番号。
• page_size: integer
  ページごとに返す結果の数。
• search: string
  検索条件。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/ActivityStream"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

ネストされたスキーマ: results

型: array

ソースを表示

• Array of: object ActivityStream

{
    "items":{
        "$ref":"#/definitions/ActivityStream"
    },
    "type":"array"
}

ネストされたスキーマ : ActivityStream

型: object

ソースを表示

• action_node: string
  タイトル: Action node

  読取り専用: true

  最小長: 1

  アクティビティが実行されたクラスタ・ノード。
• changes: string
  タイトル: Changes

  読取り専用: true

  オブジェクトの作成、更新または削除時の新規および変更された値のサマリー
• id: integer
  タイトル: ID

  読取り専用: true
• object1(required): string
  タイトル: Object1

  最小長: 1

  イベントを作成、更新および削除する場合、これは影響を受けたオブジェクト・タイプです。 関連付けおよび関連付け解除イベントの場合、これはobject2に関連付けられているオブジェクト・タイプまたは関連付け解除されたオブジェクト・タイプです。
• object2(required): string
  タイトル: Object2

  最小長: 1

  イベントの作成、更新および削除のための未移入。 関連付けおよび関連付け解除イベントの場合、これはobject1が関連付けられているオブジェクト・タイプです。
• object_association: string
  タイトル: Object association

  読取り専用: true

  存在する場合、変更されたロールまたは関係のフィールド名が表示されます。
• object_type: string
  タイトル: Object type

  読取り専用: true

  存在する場合、ロールまたは関係が定義されたモデルが表示されます。
• operation(required): string
  タイトル: Operation

  指定できる値: [ "create", "update", "delete", "associate", "disassociate" ]

  指定されたオブジェクトに関して実行されるアクション。
• related: string
  タイトル: Related

  読取り専用: true
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• timestamp: string(date-time)
  タイトル: Timestamp

  読取り専用: true
• type: string
  タイトル: Type

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "action_node":{
            "description":"The cluster node the activity took place on.",
            "minLength":"1",
            "readOnly":true,
            "title":"Action node",
            "type":"string"
        },
        "changes":{
            "description":"A summary of the new and changed values when an object is created, updated, or deleted",
            "readOnly":true,
            "title":"Changes",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "object1":{
            "description":"For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2.",
            "minLength":"1",
            "title":"Object1",
            "type":"string",
            "x-nullable":true
        },
        "object2":{
            "description":"Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with.",
            "minLength":"1",
            "title":"Object2",
            "type":"string",
            "x-nullable":true
        },
        "object_association":{
            "description":"When present, shows the field name of the role or relationship that changed.",
            "readOnly":true,
            "title":"Object association",
            "type":"string"
        },
        "object_type":{
            "description":"When present, shows the model on which the role or relationship was defined.",
            "readOnly":true,
            "title":"Object type",
            "type":"string"
        },
        "operation":{
            "description":"The action taken with respect to the given object(s).",
            "enum":[
                "create",
                "update",
                "delete",
                "associate",
                "disassociate"
            ],
            "title":"Operation",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timestamp":{
            "format":"date-time",
            "readOnly":true,
            "title":"Timestamp",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "operation",
        "object1",
        "object2"
    ],
    "type":"object"
}

先頭に戻る