ワークフロー・ジョブ・テンプレート・ノードのインスタンス・グループのリスト
get
/api/v2/workflow_job_template_nodes/{id}/instance_groups/
このリソースに対してGETリクエストを行って、選択したワークフロー・ジョブ・テンプレート・ノードに関連付けられたインスタンス・グループのリストを取得します。
結果のデータ構造には次のものが含まれます:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
countフィールドは、特定の問合せに対して検出されたインスタンス・グループの合計数を示します。 nextフィールドとpreviousフィールドには、単一ページに収まる以上の結果へのリンクが表示されます。 resultsリストには、ゼロ個以上のインスタンス・グループ・レコードが含まれます。
結果
各インスタンス・グループのデータ構造には次のフィールドが含まれます:
id: このインスタンス・グループのデータベースID。(integer)type: このインスタンス・グループのデータ型。(choice)url: このインスタンス・グループのURL。(string)related: 関連リソースのURLを持つデータ構造。(オブジェクト)name: このインスタンス・グループの名前。(string)created: このインスタンス・グループが作成されたときのタイムスタンプ。(datetime)modified: このインスタンス・グループが最後に変更されたときのタイムスタンプ。(datetime)capacity: (フィールド)consumed_capacity: (フィールド)percent_capacity_remaining: (field)jobs_running: (フィールド)max_concurrent_jobs: グループで実行する同時ジョブの最大数。 ゼロに設定すると、最大値は強制されません。(整数)max_forks: グループで同時に実行するフォークの最大数。 ゼロに設定すると、最大値は強制されません。(整数)jobs_total: このインスタンス・グループをターゲットとするすべてのジョブの数(integer)instances: (フィールド)is_container_group: このグループのインスタンスがcontainerized.Containerizedグループに指定されたOpenshiftまたはKubernetesクラスタがあるかどうかを示します。(ブール)credential: (id)policy_instance_percentage: 新しいインスタンスがオンラインになったときに、このグループに自動的に割り当てられるすべてのインスタンスの最小パーセンテージ。(integer)policy_instance_minimum: 新規インスタンスがオンラインになったときにこのグループに自動的に割り当てられるインスタンスの静的最小数。(integer)policy_instance_list: このグループ(json)に割り当てられる完全一致インスタンスのリストpod_spec_override: (string)summary_fields: 関連リソースの名前/説明を持つデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
ソート
インスタンス・グループが特定の順序で返されることを指定するには、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レスポンス
ネストされたスキーマ : InstanceGroup
型:
ソースを表示
object- capacity: string
タイトル:
Capacity読取り専用:true - consumed_capacity: string
タイトル:
Consumed capacity読取り専用:true - created: string
タイトル:
Created読取り専用:true - credential: integer
タイトル:
Credential - id: integer
タイトル:
ID読取り専用:true - instances: string
タイトル:
Instances読取り専用:true - is_container_group: boolean
タイトル:
Is container groupこのグループのインスタンスがcontainerized.ContainerizedグループにOpenshiftまたはKubernetesクラスタが指定されているかどうかを示します。 - jobs_running: string
タイトル:
Jobs running読取り専用:true - jobs_total: integer
タイトル:
Jobs total読取り専用:trueこのインスタンス・グループをターゲットとするすべてのジョブの数 - max_concurrent_jobs: integer
タイトル:
Max Concurrent Jobs最小値:0グループで実行する同時ジョブの最大数。 ゼロに設定すると、最大値は強制されません。 - max_forks: integer
タイトル:
Max Forks最小値:0グループで同時に実行するフォークの最大数。 ゼロに設定すると、最大値は強制されません。 - modified: string
タイトル:
Modified読取り専用:true - name(required): string
タイトル:
Name最小長:1最大長:250 - percent_capacity_remaining: string
タイトル:
Percent capacity remaining読取り専用:true - pod_spec_override: string
タイトル:
Pod spec override - policy_instance_list: array policy_instance_list
このグループに割り当てられる完全一致インスタンスのリスト
- policy_instance_minimum: integer
タイトル:
Policy Instance Minimum最小値:0新規インスタンスがオンラインになったときにこのグループに自動的に割り当てられるインスタンスの静的最小数。 - policy_instance_percentage: integer
タイトル:
Policy Instance Percentage最小値:0最大値:100新しいインスタンスがオンラインになったときに、このグループに自動的に割り当てられるすべてのインスタンスの最小割合。 - related: string
- summary_fields: string
タイトル:
Summary fields読取り専用:true - type: string
タイトル:
Type読取り専用:true - url: string
タイトル:
Url読取り専用:true