Jump to

• Request
• Response
• Examples

Run a Container from an Image

post

/api/v2/images/{repo_id:.*}/hosts/{host_id}/run

Use this endpoint to run a container from a specific image on a specific host. You identify the image by its registry repository name and optionally by its container tag. Note that the optional container tag must be preceded by a colon (:); for example, oraclelinux:6.6

Request

Supported Media Types

• application/json

Path Parameters

• host_id: string
  host_id
• repo_id:.*: string
  repo_id:.*

Body ()

Body parameters

Root Schema : schema

Type: object

Show Source

• command: string
• content: string
• editorTemp: object editorTemp
• errors: null
• new_record: boolean
• struct: object struct

{
    "properties":{
        "command":{
            "type":"string"
        },
        "content":{
            "type":"string"
        },
        "editorTemp":{
            "properties":{
            },
            "type":"object"
        },
        "errors":{
            "type":"null"
        },
        "new_record":{
            "type":"boolean"
        },
        "struct":{
            "properties":{
                "image":{
                    "type":"string"
                }
            },
            "required":[
                "image"
            ],
            "type":"object"
        }
    },
    "required":[
        "command",
        "content",
        "editorTemp",
        "errors",
        "new_record",
        "struct"
    ],
    "type":"object"
}

Nested Schema : editorTemp

Type: object

Show Source

{
    "properties":{
    },
    "type":"object"
}

Nested Schema : struct

Type: object

Show Source

• image: string

{
    "properties":{
        "image":{
            "type":"string"
        }
    },
    "required":[
        "image"
    ],
    "type":"object"
}

Security

• Authorization: apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• application/json

200 Response

200 Response

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

{
    "items":{
        "properties":{
            "task_id":{
                "type":"string"
            }
        },
        "required":[
            "task_id"
        ],
        "type":"object"
    }
}

Nested Schema : items

Type: object

Show Source

• task_id: string

{
    "properties":{
        "task_id":{
            "type":"string"
        }
    },
    "required":[
        "task_id"
    ],
    "type":"object"
}

Default Response

Error Payload

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to run a container from a specific image. You perform this task by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the manager node for the Oracle Cloud Container instance. See Send Requests for the appropriate URL structure to use for Oracle Public Cloud.

cURL Command

curl -sk 
     -X "POST" 
     -H "Authorization: Bearer b39f09c71c297f1d" 
     "https://rest_server_url/api/v2/images/oraclelinux:6.6/hosts/host_id/run" 
     -d '{"content":"version: 2\nservices:\n  unnamed:\n    image: \"oraclelinux:6.6\"\n"}'

In this example, oraclelinux is the repository in the registry and 6.6 is the optional container tag. If you do not include the tag, then Oracle Container Cloud Service assumes the value of the tag is latest.

Example of Response Body

{
  "task_id": "602784b9-143c-4109-92d9-f66ff1010d07"
}

Back to Top