移動先

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

実行環境の更新

patch

/api/v2/execution_environments/{id}/

このリソースに対してPUTまたはPATCHリクエストを行って、この実行環境を更新します。次のフィールドを変更できます。

• name: この実行環境の名前。(文字列、必須)
• description: この実行環境のオプションの説明。(文字列、デフォルト="")
• organization: この実行環境へのアクセス権を決定するために使用される組織。(id、デフォルト=``)

• image: コンテナ・レジストリ、イメージ名、バージョン・タグが含まれる、完全なイメージの場所。(文字列、必須)

• credential: (id、デフォルト=``)

• pull: 実行前にイメージをプルするかどうか。(選択)
  • "": --------- (デフォルト)
  • always: 実行前に常にコンテナをプルします。
  • missing: 実行前にイメージが存在しない場合にのみイメージをプルします。
  • never: 実行前に決してコンテナをプルしません。

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

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

本文()

ルート・スキーマ : ExecutionEnvironment

型: object

ソースを表示

• created: 文字列
  タイトル: Created

  読取り専用: true
• credential: 整数
  タイトル: Credential
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• image(必須): 文字列
  タイトル: Image location

  最小長: 1

  最大長: 1024

  コンテナ・レジストリ、イメージ名、バージョン・タグが含まれる、完全なイメージの場所。(文字列)
• managed: 文字列
  タイトル: Managed

  読取り専用: true
• modified: 文字列
  タイトル: Modified

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

  最小長: 1

  最大長: 512
• organization: 整数
  タイトル: Organization

  この実行環境へのアクセス権を決定するために使用される組織。
• pull: 文字列
  タイトル: Pull

  指定できる値: [ "always", "missing", "never" ]

  実行前にイメージをプルするかどうか。
• related: 文字列
  タイトル: Related

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

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

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

  読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "image":{
            "description":"The full image location, including the container registry, image name, and version tag.",
            "maxLength":"1024",
            "minLength":"1",
            "title":"Image location",
            "type":"string",
            "x-nullable":true
        },
        "managed":{
            "readOnly":true,
            "title":"Managed",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this execution environment.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "pull":{
            "description":"Pull image before running?",
            "enum":[
                "always",
                "missing",
                "never"
            ],
            "title":"Pull",
            "type":"string",
            "x-nullable":true
        },
        "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",
        "image"
    ],
    "type":"object"
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : ExecutionEnvironment

型: object

ソースを表示

• created: 文字列
  タイトル: Created

  読取り専用: true
• credential: 整数
  タイトル: Credential
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• image(必須): 文字列
  タイトル: Image location

  最小長: 1

  最大長: 1024

  コンテナ・レジストリ、イメージ名、バージョン・タグが含まれる、完全なイメージの場所。(文字列)
• managed: 文字列
  タイトル: Managed

  読取り専用: true
• modified: 文字列
  タイトル: Modified

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

  最小長: 1

  最大長: 512
• organization: 整数
  タイトル: Organization

  この実行環境へのアクセス権を決定するために使用される組織。
• pull: 文字列
  タイトル: Pull

  指定できる値: [ "always", "missing", "never" ]

  実行前にイメージをプルするかどうか。
• related: 文字列
  タイトル: Related

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

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

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

  読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "image":{
            "description":"The full image location, including the container registry, image name, and version tag.",
            "maxLength":"1024",
            "minLength":"1",
            "title":"Image location",
            "type":"string",
            "x-nullable":true
        },
        "managed":{
            "readOnly":true,
            "title":"Managed",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this execution environment.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "pull":{
            "description":"Pull image before running?",
            "enum":[
                "always",
                "missing",
                "never"
            ],
            "title":"Pull",
            "type":"string",
            "x-nullable":true
        },
        "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",
        "image"
    ],
    "type":"object"
}

先頭に戻る