移動先

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

実行環境のリスト

get

/api/v2/execution_environments/

このリソースに対してGETリクエストを行って、実行環境のリストを取得します。

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

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

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

結果

それぞれの実行環境データ構造には次のフィールドが含まれます。

• id: この実行環境のデータベースID。(整数)
• type: この実行環境のデータ型。(選択)
• url: この実行環境のURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: この実行環境が作成されたときのタイムスタンプ。(日時)
• modified: この実行環境が最後に変更されたときのタイムスタンプ。(日時)
• name: この実行環境の名前。(文字列)
• description: この実行環境のオプションの説明。(文字列)
• organization: この実行環境へのアクセス権を決定するために使用される組織。(id)
• image: コンテナ・レジストリ、イメージ名、バージョン・タグが含まれる、完全なイメージの場所。(文字列)
• managed: (ブール)
• credential: (id)
• pull: 実行前にイメージをプルするかどうか。(選択)
  • "": ---------
  • always: 実行前に常にコンテナをプルします。
  • missing: 実行前にイメージが存在しない場合にのみイメージをプルします。
  • never: 実行前に決してコンテナをプルしません。

ソート

実行環境が特定の順序で返されるように指定するには、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

問合せパラメータ

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ: schema

型: object

ソースを表示

• count(必須): 整数
• next: 文字列(uri)
• previous: 文字列(uri)
• results(必須): 配列 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/ExecutionEnvironment"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• 配列: オブジェクト ExecutionEnvironment

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

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

型: object

ソースを表示

• created: 文字列
  タイトル: Created

  読取り専用: true
• credential: 整数
  タイトル: Credential
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• image(必須): 文字列
  タイトル: Image location

  最小長: 1

  最大長: 1024

  コンテナ・レジストリ、イメージ名、バージョン・タグが含まれる、完全なイメージの場所。(文字列)
• managed: 文字列
  タイトル: Managed

  読取り専用: true
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• organization: 整数
  タイトル: Organization

  この実行環境へのアクセス権を決定するために使用される組織。
• pull: 文字列
  タイトル: Pull

  指定できる値: [ "always", "missing", "never" ]

  実行前にイメージをプルするかどうか。
• related: 文字列
  タイトル: Related

  読取り専用: true
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• type: 文字列
  タイトル: Type

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "image":{
            "description":"The full image location, including the container registry, image name, and version tag.",
            "maxLength":"1024",
            "minLength":"1",
            "title":"Image location",
            "type":"string",
            "x-nullable":true
        },
        "managed":{
            "readOnly":true,
            "title":"Managed",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this execution environment.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "pull":{
            "description":"Pull image before running?",
            "enum":[
                "always",
                "missing",
                "never"
            ],
            "title":"Pull",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "image"
    ],
    "type":"object"
}

先頭に戻る