リスト実行環境
get
/api/v2/execution_environments/
このリソースに対するGETリクエストを実行して、実行環境のリストを取得します。
結果のデータ構造には次のものが含まれます:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
count
フィールドは、指定された問合せで見つかった実行環境の合計数を示します。 next
フィールドとprevious
フィールドには、単一ページに収まる以上の結果へのリンクが表示されます。 results
リストには、0個以上の実行環境レコードが含まれます。
結果
各実行環境のデータ構造には次のフィールドが含まれます:
id
: この実行環境のデータベースID。(整数)type
: この実行環境のデータ型。(選択)url
: この実行環境のURL。(文字列)related
: 関連リソースのURLを持つデータ構造。(オブジェクト)summary_fields
: 関連リソースの名前/説明を持つデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created
: この実行環境が作成された時点のタイムスタンプ。(日時)modified
: この実行環境が最後に変更された時点のタイムスタンプ。(日時)name
: この実行環境の名前。(文字列)description
: この実行環境のオプションの説明。(文字列)organization
: この実行環境へのアクセスを決定するために使用される組織。(id)image
: コンテナ・レジストリ、イメージ名およびバージョン・タグを含む完全なイメージのロケーション。(文字列)managed
: (boolean)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タワー3.1.0で追加」)関連フィールド全体を検索します:
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- page: integer
ページ区切り結果セット内のページ番号。
- page_size: integer
ページ当たりに返す結果の数。
- search: string
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ネストされたスキーマ : ExecutionEnvironment
型:
ソースを表示
object
- created: string
タイトル:
Created
読取り専用:true
- credential: integer
タイトル:
Credential
- description: string
タイトル:
Description
- id: integer
タイトル:
ID
読取り専用:true
- image(required): string
タイトル:
Image location
最小長:1
最大長:1024
コンテナ・レジストリ、イメージ名およびバージョン・タグを含むフル・イメージのロケーション。 - managed: string
タイトル:
Managed
読取り専用:true
- modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- organization: integer
タイトル:
Organization
この実行環境へのアクセス権を決定するために使用される組織。 - pull: string
タイトル:
Pull
指定できる値:[ "always", "missing", "never" ]
実行前にイメージをプルしますか? - related: string
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- type: string
タイトル:
Type
読取り専用:true
- url: string
タイトル:
Url
読取り専用:true