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

インスタンスのインスタンスのリスト

get

/api/v2/instances/{id}/peers/

このリソースに対してGETリクエストを行って、選択したインスタンスに関連付けられているインスタンスのリストを取得します。

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

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

countフィールドは、特定の問合せに対して検出されたインスタンスの合計数を示します。 nextフィールドとpreviousフィールドには、単一ページに収まる以上の結果へのリンクが表示されます。 resultsリストには、0個以上のインスタンス・レコードが含まれます。

結果

各インスタンス・データ構造には次のフィールドが含まれます:

id: このインスタンスのデータベースID。(integer)
hostname: (文字列)
type: このインスタンスのデータ型。(choice)
url: このインスタンスのURL。(string)
related: 関連リソースのURLを持つデータ構造。(オブジェクト)
summary_fields: 関連リソースの名前/説明を持つデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
uuid: (文字列)
created: このインスタンスが作成されたときのタイムスタンプ。(datetime)
modified: このインスタンスが最後に変更されたときのタイムスタンプ。(datetime)
last_seen: 最後にインスタンスがメイン・クラスタ・ノードに対してハートビート・タスクを実行したとき。実行ノードの受容体メッシュへの最後の既知の接続。(日時)
health_check_started: このインスタンスでヘルス・チェックが最後に開始された時間。(日時)
health_check_pending: (フィールド)
last_health_check: CPU、メモリーおよび容量をリフレッシュするために、このインスタンスでヘルス・チェックが前回実行された時間。(日時)
errors: 最後のヘルス・チェックからのエラーの詳細。(文字列)
capacity_adjustment: (10進)
version: (文字列)
capacity: (整数)
consumed_capacity: (フィールド)
percent_capacity_remaining: (field)
jobs_running: このインスタンスをターゲットとする実行中または待機中の状態のジョブの数(integer)
jobs_total: このインスタンスをターゲットとするすべてのジョブの数(integer)
cpu: (10進数)
memory: このインスタンスのシステム・メモリーの合計(バイト)。(整数)
cpu_capacity: (整数)
mem_capacity: (整数)
enabled: (ブール)
managed_by_policy: (boolean)
node_type: このノードがメッシュ内で果たすロール。(選択)
- control: コントロール・プレーン・ノード
- execution: 実行プレーン・ノード
- hybrid: コントローラと実行
- hop: メッセージを渡すノード、実行機能なし
node_state: このインスタンスの現在のライフ・サイクル・ステージを示します。(選択)
- provisioning: プロビジョニング
- provision-fail: プロビジョニング失敗
- installed: インストール済み
- ready: 準備完了
- unavailable: 使用不可
- deprovisioning: De-provisioning
- deprovision-fail: プロビジョニング解除の失敗
ip_address: (string)
listener_port: 受信接続をレセプタがリスニングするポート。(整数)
peers: (フィールド)
peers_from_control_nodes: Trueの場合、コントロール・プレーン・クラスタ・ノードは自動的にピアリングされます。(ブール)

ソート

インスタンスが特定の順序で返されることを指定するには、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

パス・パラメータ

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/Instance"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

Array of: object Instance

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

ネストされたスキーマ : インスタンス

型: object

ソースを表示

capacity: integer

タイトル: Capacity

読取り専用: true

最小値: 0
capacity_adjustment: string(decimal)

タイトル: Capacity adjustment

デフォルト値: 1.00
consumed_capacity: string

タイトル: Consumed capacity

読取り専用: true
cpu: string(decimal)

タイトル: Cpu

読取り専用: true
cpu_capacity: integer

タイトル: Cpu capacity

読取り専用: true
created: string

タイトル: Created

読取り専用: true
enabled: boolean

タイトル: Enabled

デフォルト値: true
errors: string

タイトル: Errors

読取り専用: true

最小長: 1

最後のヘルス・チェックからのエラーの詳細。
health_check_pending: string

タイトル: Health check pending

読取り専用: true
health_check_started: string(date-time)

タイトル: Health check started

読取り専用: true

このインスタンスで最後にヘルス・チェックが開始された時間。
hostname(required): string

タイトル: Hostname

最小長: 1

最大長: 250
id: integer

タイトル: ID

読取り専用: true
ip_address: string

タイトル: Ip address

読取り専用: true

最小長: 1
jobs_running: integer

タイトル: Jobs running

読取り専用: true

このインスタンスをターゲットとする実行中または待機中の状態のジョブ数
jobs_total: integer

タイトル: Jobs total

読取り専用: true

このインスタンスをターゲットとするすべてのジョブの数
last_health_check: string(date-time)

タイトル: Last health check

読取り専用: true

CPU、メモリーおよび容量をリフレッシュするために、このインスタンスでヘルス・チェックが実行された前回。
last_seen: string(date-time)

タイトル: Last seen

読取り専用: true

最後にインスタンスがメイン・クラスタ・ノードに対してハートビート・タスクを実行したとき。実行ノードのレセプタ・メッシュへの最後の既知の接続。
listener_port: integer

タイトル: Listener port

最小値: 0

最大値: 65535

レセプタが着信接続をリスニングするポート。
managed_by_policy: boolean

タイトル: Managed by policy

デフォルト値: true
mem_capacity: integer

タイトル: Mem capacity

読取り専用: true
memory: integer

タイトル: Memory

読取り専用: true

このインスタンスの合計システム・メモリー(バイト)。
modified: string

タイトル: Modified

読取り専用: true
node_state: string

タイトル: Node state

デフォルト値: installed

指定できる値: [ "provisioning", "provision-fail", "installed", "ready", "unavailable", "deprovisioning", "deprovision-fail" ]

このインスタンスの現在のライフ・サイクル・ステージを示します。
node_type: string

タイトル: Node type

デフォルト値: execution

指定できる値: [ "control", "execution", "hybrid", "hop" ]

このノードがメッシュ内で果たすロール。
peers: array peers

一意のアイテムが必要: true
peers_from_control_nodes: boolean

タイトル: Peers from control nodes

Trueの場合、コントロール・プレーン・クラスタ・ノードは自動的にピアリングされます。
percent_capacity_remaining: string

タイトル: Percent capacity remaining

読取り専用: true
related: string

タイトル: Related

読取り専用: true
summary_fields: string

タイトル: Summary fields

読取り専用: true
type: string

タイトル: Type

読取り専用: true
url: string

タイトル: Url

読取り専用: true
uuid: string

タイトル: Uuid

読取り専用: true

最小長: 1
version: string

タイトル: Version

読取り専用: true

最小長: 1

{
    "properties":{
        "capacity":{
            "minimum":"0",
            "readOnly":true,
            "title":"Capacity",
            "type":"integer"
        },
        "capacity_adjustment":{
            "default":"1.00",
            "format":"decimal",
            "title":"Capacity adjustment",
            "type":"string"
        },
        "consumed_capacity":{
            "readOnly":true,
            "title":"Consumed capacity",
            "type":"string"
        },
        "cpu":{
            "format":"decimal",
            "readOnly":true,
            "title":"Cpu",
            "type":"string"
        },
        "cpu_capacity":{
            "readOnly":true,
            "title":"Cpu capacity",
            "type":"integer"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "enabled":{
            "default":true,
            "title":"Enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "errors":{
            "description":"Any error details from the last health check.",
            "minLength":"1",
            "readOnly":true,
            "title":"Errors",
            "type":"string"
        },
        "health_check_pending":{
            "readOnly":true,
            "title":"Health check pending",
            "type":"string"
        },
        "health_check_started":{
            "description":"The last time a health check was initiated on this instance.",
            "format":"date-time",
            "readOnly":true,
            "title":"Health check started",
            "type":"string",
            "x-nullable":true
        },
        "hostname":{
            "maxLength":"250",
            "minLength":"1",
            "title":"Hostname",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "ip_address":{
            "minLength":"1",
            "readOnly":true,
            "title":"Ip address",
            "type":"string",
            "x-nullable":true
        },
        "jobs_running":{
            "description":"Count of jobs in the running or waiting state that are targeted for this instance",
            "readOnly":true,
            "title":"Jobs running",
            "type":"integer"
        },
        "jobs_total":{
            "description":"Count of all jobs that target this instance",
            "readOnly":true,
            "title":"Jobs total",
            "type":"integer"
        },
        "last_health_check":{
            "description":"Last time a health check was ran on this instance to refresh cpu, memory, and capacity.",
            "format":"date-time",
            "readOnly":true,
            "title":"Last health check",
            "type":"string",
            "x-nullable":true
        },
        "last_seen":{
            "description":"Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes.",
            "format":"date-time",
            "readOnly":true,
            "title":"Last seen",
            "type":"string",
            "x-nullable":true
        },
        "listener_port":{
            "description":"Port that Receptor will listen for incoming connections on.",
            "maximum":"65535",
            "minimum":"0",
            "title":"Listener port",
            "type":"integer",
            "x-nullable":true
        },
        "managed_by_policy":{
            "default":true,
            "title":"Managed by policy",
            "type":"boolean",
            "x-nullable":true
        },
        "mem_capacity":{
            "readOnly":true,
            "title":"Mem capacity",
            "type":"integer"
        },
        "memory":{
            "description":"Total system memory of this instance in bytes.",
            "readOnly":true,
            "title":"Memory",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "node_state":{
            "default":"installed",
            "description":"Indicates the current life cycle stage of this instance.",
            "enum":[
                "provisioning",
                "provision-fail",
                "installed",
                "ready",
                "unavailable",
                "deprovisioning",
                "deprovision-fail"
            ],
            "title":"Node state",
            "type":"string",
            "x-nullable":true
        },
        "node_type":{
            "default":"execution",
            "description":"Role that this node plays in the mesh.",
            "enum":[
                "control",
                "execution",
                "hybrid",
                "hop"
            ],
            "title":"Node type",
            "type":"string",
            "x-nullable":true
        },
        "peers":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "peers_from_control_nodes":{
            "description":"If True, control plane cluster nodes should automatically peer to it.",
            "title":"Peers from control nodes",
            "type":"boolean",
            "x-nullable":true
        },
        "percent_capacity_remaining":{
            "readOnly":true,
            "title":"Percent capacity remaining",
            "type":"string"
        },
        "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"
        },
        "uuid":{
            "minLength":"1",
            "readOnly":true,
            "title":"Uuid",
            "type":"string",
            "x-nullable":true
        },
        "version":{
            "minLength":"1",
            "readOnly":true,
            "title":"Version",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "hostname"
    ],
    "type":"object"
}

ネストしたスキーマ: peers

型: array

一意のアイテムが必要: true

ソースを表示

配列: 文字列

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

先頭に戻る