インスタンス・グループのインスタンスの作成

post

/api/v2/instance_groups/{id}/instances/

次のインスタンス・フィールドを指定してこのリソースに対してPOSTリクエストを行って、このインスタンス・グループに関連付けられる新しいインスタンスを作成します。

hostname: (文字列、必須)
capacity_adjustment: (10進、デフォルト=1)
enabled: (ブール、デフォルト=True)
managed_by_policy: (ブール、デフォルト=True)
node_type: このノードがメッシュで果たす役割。(選択)
- control: コントロール・プレーン・ノード
- execution: 実行プレーン・ノード(デフォルト)
- hybrid: コントローラと実行
- hop: メッセージ受渡しノード(実行機能なし)
node_state: このインスタンスの現在のライフ・サイクル・ステージを示します。(選択)
- provisioning: プロビジョニング
- provision-fail: プロビジョニング失敗
- installed: インストール済(デフォルト)
- ready: 準備完了
- unavailable: 使用不可
- deprovisioning: プロビジョニング解除
- deprovision-fail: プロビジョニング解除失敗
listener_port: レセプタが受信接続をリスニングするポート。(整数、デフォルト=None)
peers: (フィールド、デフォルト=None)
peers_from_control_nodes: Trueの場合、コントロール・プレーン・クラスタ・ノードは自動的にピアリングする必要があります。(ブール、デフォルト=False)

インスタンス・グループのインスタンスの追加:

このインスタンス・グループに既存のインスタンスを関連付けるには、idフィールドのみを指定してこのリソースに対してPOSTリクエストを行います。

このインスタンス・グループからのインスタンスの削除:

idおよびdisassociateフィールドを指定してこのリソースに対してPOSTリクエストを行うと、インスタンスは削除されずに、このインスタンス・グループからインスタンスが削除されます。

リクエスト

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

application/json

パス・パラメータ

id(必須): 文字列

ルート・スキーマ : Instance

型: object

ソースを表示

capacity: 整数

タイトル: Capacity

読取り専用: true

最小値: 0
capacity_adjustment: 文字列(10進)

タイトル: Capacity adjustment

デフォルト値: 1.00
consumed_capacity: 文字列

タイトル: Consumed capacity

読取り専用: true
cpu: 文字列(10進)

タイトル: Cpu

読取り専用: true
cpu_capacity: 整数

タイトル: Cpu capacity

読取り専用: true
created: 文字列

タイトル: Created

読取り専用: true
enabled: ブール

タイトル: Enabled

デフォルト値: true
errors: 文字列

タイトル: Errors

読取り専用: true

最小長: 1

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

タイトル: Health check pending

読取り専用: true
health_check_started: 文字列(日付-時間)

タイトル: Health check started

読取り専用: true

このインスタンスで最後にヘルス・チェックが開始されたとき。
hostname(必須): 文字列

タイトル: Hostname

最小長: 1

最大長: 250
id: 整数

タイトル: ID

読取り専用: true
ip_address: 文字列

タイトル: Ip address

読取り専用: true

最小長: 1
jobs_running: 整数

タイトル: Jobs running

読取り専用: true

このインスタンスの対象となる実行状態または待機状態のジョブの数
jobs_total: 整数

タイトル: Jobs total

読取り専用: true

このインスタンスを対象とするすべてのジョブの数
last_health_check: 文字列(日付-時間)

タイトル: Last health check

読取り専用: true

CPU、メモリー、容量のリフレッシュのために、このインスタンスで最後にヘルス・チェックが実行されたとき。
last_seen: 文字列(日付-時間)

タイトル: Last seen

読取り専用: true

インスタンスが最後にメイン・クラスタ・ノードに対するハートビート・タスクを実行したとき。実行ノードのレセプタ・メッシュへの最後に確認された接続。
listener_port: 整数

タイトル: Listener port

最小値: 0

最大値: 65535

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

タイトル: Managed by policy

デフォルト値: true
mem_capacity: 整数

タイトル: Mem capacity

読取り専用: true
memory: 整数

タイトル: Memory

読取り専用: true

このインスタンスの合計システム・メモリー(バイト単位)。
modified: 文字列

タイトル: Modified

読取り専用: true
node_state: 文字列

タイトル: Node state

デフォルト値: installed

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

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

タイトル: Node type

デフォルト値: execution

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

このノードがメッシュで果たす役割。
peers: 配列 peers

一意のアイテムが必要: true
peers_from_control_nodes: ブール

タイトル: Peers from control nodes

Trueの場合、コントロール・プレーン・クラスタ・ノードは自動的にピアリングする必要があります。
percent_capacity_remaining: 文字列

タイトル: Percent capacity remaining

読取り専用: true
related: 文字列

タイトル: Related

読取り専用: true
summary_fields: 文字列

タイトル: Summary fields

読取り専用: true
type: 文字列

タイトル: Type

読取り専用: true
url: 文字列

タイトル: Url

読取り専用: true
uuid: 文字列

タイトル: Uuid

読取り専用: true

最小長: 1
version: 文字列

タイトル: 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
}

先頭に戻る

レスポンス

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

application/json

201レスポンス

ルート・スキーマ : Instance

型: object

ソースを表示

capacity: 整数

タイトル: Capacity

読取り専用: true

最小値: 0
capacity_adjustment: 文字列(10進)

タイトル: Capacity adjustment

デフォルト値: 1.00
consumed_capacity: 文字列

タイトル: Consumed capacity

読取り専用: true
cpu: 文字列(10進)

タイトル: Cpu

読取り専用: true
cpu_capacity: 整数

タイトル: Cpu capacity

読取り専用: true
created: 文字列

タイトル: Created

読取り専用: true
enabled: ブール

タイトル: Enabled

デフォルト値: true
errors: 文字列

タイトル: Errors

読取り専用: true

最小長: 1

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

タイトル: Health check pending

読取り専用: true
health_check_started: 文字列(日付-時間)

タイトル: Health check started

読取り専用: true

このインスタンスで最後にヘルス・チェックが開始されたとき。
hostname(必須): 文字列

タイトル: Hostname

最小長: 1

最大長: 250
id: 整数

タイトル: ID

読取り専用: true
ip_address: 文字列

タイトル: Ip address

読取り専用: true

最小長: 1
jobs_running: 整数

タイトル: Jobs running

読取り専用: true

このインスタンスの対象となる実行状態または待機状態のジョブの数
jobs_total: 整数

タイトル: Jobs total

読取り専用: true

このインスタンスを対象とするすべてのジョブの数
last_health_check: 文字列(日付-時間)

タイトル: Last health check

読取り専用: true

CPU、メモリー、容量のリフレッシュのために、このインスタンスで最後にヘルス・チェックが実行されたとき。
last_seen: 文字列(日付-時間)

タイトル: Last seen

読取り専用: true

インスタンスが最後にメイン・クラスタ・ノードに対するハートビート・タスクを実行したとき。実行ノードのレセプタ・メッシュへの最後に確認された接続。
listener_port: 整数

タイトル: Listener port

最小値: 0

最大値: 65535

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

タイトル: Managed by policy

デフォルト値: true
mem_capacity: 整数

タイトル: Mem capacity

読取り専用: true
memory: 整数

タイトル: Memory

読取り専用: true

このインスタンスの合計システム・メモリー(バイト単位)。
modified: 文字列

タイトル: Modified

読取り専用: true
node_state: 文字列

タイトル: Node state

デフォルト値: installed

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

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

タイトル: Node type

デフォルト値: execution

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

このノードがメッシュで果たす役割。
peers: 配列 peers

一意のアイテムが必要: true
peers_from_control_nodes: ブール

タイトル: Peers from control nodes

Trueの場合、コントロール・プレーン・クラスタ・ノードは自動的にピアリングする必要があります。
percent_capacity_remaining: 文字列

タイトル: Percent capacity remaining

読取り専用: true
related: 文字列

タイトル: Related

読取り専用: true
summary_fields: 文字列

タイトル: Summary fields

読取り専用: true
type: 文字列

タイトル: Type

読取り専用: true
url: 文字列

タイトル: Url

読取り専用: true
uuid: 文字列

タイトル: Uuid

読取り専用: true

最小長: 1
version: 文字列

タイトル: 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
}

先頭に戻る