移動先

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

インスタンス・グループの更新

patch

/api/v2/instance_groups/{id}/

このリソースに対してPUTまたはPATCHリクエストを行って、このインスタンス・グループを更新します。次のフィールドを変更できます。

• name: このインスタンス・グループの名前。(文字列、必須)

• max_concurrent_jobs: グループで実行される同時実行ジョブの最大数。ゼロに設定した場合、最大数は強制されません。(整数、デフォルト=0)

• max_forks: グループで同時実行される分岐の最大数。ゼロに設定した場合、最大数は強制されません。(整数、デフォルト=0)

• is_container_group: このグループのインスタンスがコンテナ化されているかどうかを示します。コンテナ化されているグループには、指定されたOpenshiftまたはKubernetesクラスタがあります。(ブール、デフォルト=``)

• credential: (id、デフォルト=``)
• policy_instance_percentage: 新しいインスタンスがオンラインになると、このグループに自動的に割り当てられるすべてのインスタンスの最小パーセント。(整数、デフォルト=0)
• policy_instance_minimum: 新しいインスタンスがオンラインになると、このグループに自動的に割り当てられるインスタンスの静的最小数。(整数、デフォルト=0)
• policy_instance_list: このグループに割り当てられる完全一致インスタンスのリスト(json、デフォルト=``)
• pod_spec_override: (文字列、デフォルト="")

PATCHリクエストの場合は、変更中のフィールドのみを含めます。

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

本文()

ルート・スキーマ : InstanceGroup

型: object

ソースを表示

• capacity: 文字列
  タイトル: Capacity

  読取り専用: true
• consumed_capacity: 文字列
  タイトル: Consumed capacity

  読取り専用: true
• created: 文字列
  タイトル: Created

  読取り専用: true
• credential: 整数
  タイトル: Credential
• id: 整数
  タイトル: ID

  読取り専用: true
• instances: 文字列
  タイトル: Instances

  読取り専用: true
• is_container_group: ブール
  タイトル: Is container group

  このグループのインスタンスがコンテナ化されているかどうかを示します。コンテナ化されているグループには、指定されたOpenshiftまたはKubernetesクラスタがあります。
• jobs_running: 文字列
  タイトル: Jobs running

  読取り専用: true
• jobs_total: 整数
  タイトル: Jobs total

  読取り専用: true

  このインスタンス・グループを対象とするすべてのジョブの数
• max_concurrent_jobs: 整数
  タイトル: Max Concurrent Jobs

  最小値: 0

  グループで実行される同時実行ジョブの最大数。ゼロに設定した場合、最大数は強制されません。
• max_forks: 整数
  タイトル: Max Forks

  最小値: 0

  グループで同時実行される分岐の最大数。ゼロに設定した場合、最大数は強制されません。
• modified: 文字列
  タイトル: Modified

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

  最小長: 1

  最大長: 250
• percent_capacity_remaining: 文字列
  タイトル: Percent capacity remaining

  読取り専用: true
• pod_spec_override: 文字列
  タイトル: Pod spec override
• policy_instance_list: 配列 policy_instance_list
  このグループに割り当てられる完全一致インスタンスのリスト
• policy_instance_minimum: 整数
  タイトル: Policy Instance Minimum

  最小値: 0

  新しいインスタンスがオンラインになると、このグループに自動的に割り当てられるインスタンスの静的最小数。
• policy_instance_percentage: 整数
  タイトル: Policy Instance Percentage

  最小値: 0

  最大値: 100

  新しいインスタンスがオンラインになると、このグループに自動的に割り当てられるすべてのインスタンスの最小パーセント。
• related: 文字列
  タイトル: Related

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

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

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

  読取り専用: true

{
    "properties":{
        "capacity":{
            "readOnly":true,
            "title":"Capacity",
            "type":"string"
        },
        "consumed_capacity":{
            "readOnly":true,
            "title":"Consumed capacity",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "instances":{
            "readOnly":true,
            "title":"Instances",
            "type":"string"
        },
        "is_container_group":{
            "description":"Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.",
            "title":"Is container group",
            "type":"boolean"
        },
        "jobs_running":{
            "readOnly":true,
            "title":"Jobs running",
            "type":"string"
        },
        "jobs_total":{
            "description":"Count of all jobs that target this instance group",
            "readOnly":true,
            "title":"Jobs total",
            "type":"integer"
        },
        "max_concurrent_jobs":{
            "description":"Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.",
            "minimum":"0",
            "title":"Max Concurrent Jobs",
            "type":"integer"
        },
        "max_forks":{
            "description":"Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.",
            "minimum":"0",
            "title":"Max Forks",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"250",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "percent_capacity_remaining":{
            "readOnly":true,
            "title":"Percent capacity remaining",
            "type":"string"
        },
        "pod_spec_override":{
            "title":"Pod spec override",
            "type":"string",
            "x-nullable":true
        },
        "policy_instance_list":{
            "description":"List of exact-match Instances that will be assigned to this group",
            "items":{
                "minLength":"1",
                "type":"string"
            },
            "type":"array"
        },
        "policy_instance_minimum":{
            "description":"Static minimum number of Instances that will be automatically assign to this group when new instances come online.",
            "minimum":"0",
            "title":"Policy Instance Minimum",
            "type":"integer"
        },
        "policy_instance_percentage":{
            "description":"Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.",
            "maximum":"100",
            "minimum":"0",
            "title":"Policy Instance Percentage",
            "type":"integer"
        },
        "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"
    ],
    "type":"object"
}

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

型: array

このグループに割り当てられる完全一致インスタンスのリスト

ソースを表示

• 配列: 文字列
  最小長: 1

{
    "description":"List of exact-match Instances that will be assigned to this group",
    "items":{
        "minLength":"1",
        "type":"string"
    },
    "type":"array"
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : InstanceGroup

型: object

ソースを表示

• capacity: 文字列
  タイトル: Capacity

  読取り専用: true
• consumed_capacity: 文字列
  タイトル: Consumed capacity

  読取り専用: true
• created: 文字列
  タイトル: Created

  読取り専用: true
• credential: 整数
  タイトル: Credential
• id: 整数
  タイトル: ID

  読取り専用: true
• instances: 文字列
  タイトル: Instances

  読取り専用: true
• is_container_group: ブール
  タイトル: Is container group

  このグループのインスタンスがコンテナ化されているかどうかを示します。コンテナ化されているグループには、指定されたOpenshiftまたはKubernetesクラスタがあります。
• jobs_running: 文字列
  タイトル: Jobs running

  読取り専用: true
• jobs_total: 整数
  タイトル: Jobs total

  読取り専用: true

  このインスタンス・グループを対象とするすべてのジョブの数
• max_concurrent_jobs: 整数
  タイトル: Max Concurrent Jobs

  最小値: 0

  グループで実行される同時実行ジョブの最大数。ゼロに設定した場合、最大数は強制されません。
• max_forks: 整数
  タイトル: Max Forks

  最小値: 0

  グループで同時実行される分岐の最大数。ゼロに設定した場合、最大数は強制されません。
• modified: 文字列
  タイトル: Modified

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

  最小長: 1

  最大長: 250
• percent_capacity_remaining: 文字列
  タイトル: Percent capacity remaining

  読取り専用: true
• pod_spec_override: 文字列
  タイトル: Pod spec override
• policy_instance_list: 配列 policy_instance_list
  このグループに割り当てられる完全一致インスタンスのリスト
• policy_instance_minimum: 整数
  タイトル: Policy Instance Minimum

  最小値: 0

  新しいインスタンスがオンラインになると、このグループに自動的に割り当てられるインスタンスの静的最小数。
• policy_instance_percentage: 整数
  タイトル: Policy Instance Percentage

  最小値: 0

  最大値: 100

  新しいインスタンスがオンラインになると、このグループに自動的に割り当てられるすべてのインスタンスの最小パーセント。
• related: 文字列
  タイトル: Related

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

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

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

  読取り専用: true

{
    "properties":{
        "capacity":{
            "readOnly":true,
            "title":"Capacity",
            "type":"string"
        },
        "consumed_capacity":{
            "readOnly":true,
            "title":"Consumed capacity",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "instances":{
            "readOnly":true,
            "title":"Instances",
            "type":"string"
        },
        "is_container_group":{
            "description":"Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.",
            "title":"Is container group",
            "type":"boolean"
        },
        "jobs_running":{
            "readOnly":true,
            "title":"Jobs running",
            "type":"string"
        },
        "jobs_total":{
            "description":"Count of all jobs that target this instance group",
            "readOnly":true,
            "title":"Jobs total",
            "type":"integer"
        },
        "max_concurrent_jobs":{
            "description":"Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.",
            "minimum":"0",
            "title":"Max Concurrent Jobs",
            "type":"integer"
        },
        "max_forks":{
            "description":"Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.",
            "minimum":"0",
            "title":"Max Forks",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"250",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "percent_capacity_remaining":{
            "readOnly":true,
            "title":"Percent capacity remaining",
            "type":"string"
        },
        "pod_spec_override":{
            "title":"Pod spec override",
            "type":"string",
            "x-nullable":true
        },
        "policy_instance_list":{
            "description":"List of exact-match Instances that will be assigned to this group",
            "items":{
                "minLength":"1",
                "type":"string"
            },
            "type":"array"
        },
        "policy_instance_minimum":{
            "description":"Static minimum number of Instances that will be automatically assign to this group when new instances come online.",
            "minimum":"0",
            "title":"Policy Instance Minimum",
            "type":"integer"
        },
        "policy_instance_percentage":{
            "description":"Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.",
            "maximum":"100",
            "minimum":"0",
            "title":"Policy Instance Percentage",
            "type":"integer"
        },
        "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"
    ],
    "type":"object"
}

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

型: array

このグループに割り当てられる完全一致インスタンスのリスト

ソースを表示

• 配列: 文字列
  最小長: 1

{
    "description":"List of exact-match Instances that will be assigned to this group",
    "items":{
        "minLength":"1",
        "type":"string"
    },
    "type":"array"
}

先頭に戻る