Jump to

• Request
• Response
• Examples

Create a new resource pool

post

/api/pools/

When you create a new resource pool, you provide the properties of the new resource pool in the body of the request.

Request

Supported Media Types

• application/json

Body ()

Body parameters

Root Schema : schema

Type: object

Show Source

• description: string
• id: string
• name: string

{
    "properties":{
        "description":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "required":[
        "description",
        "id",
        "name"
    ],
    "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":{
            "active_hosts":{
                "type":"integer"
            },
            "description":{
                "type":"string"
            },
            "id":{
                "type":"string"
            },
            "name":{
                "type":"string"
            },
            "resources":{
                "properties":{
                    "cpu_percent":{
                        "type":"integer"
                    },
                    "memory_max":{
                        "type":"integer"
                    },
                    "memory_percent":{
                        "type":"integer"
                    },
                    "memory_used":{
                        "type":"integer"
                    }
                },
                "required":[
                    "cpu_percent",
                    "memory_max",
                    "memory_percent",
                    "memory_used"
                ],
                "type":"object"
            },
            "tags":{
                "type":"null"
            },
            "total_hosts":{
                "type":"integer"
            }
        },
        "required":[
            "active_hosts",
            "description",
            "id",
            "name",
            "resources",
            "tags",
            "total_hosts"
        ],
        "type":"object"
    }
}

Nested Schema : items

Type: object

Show Source

• active_hosts: integer
• description: string
• id: string
• name: string
• resources: object resources
• tags: null
• total_hosts: integer

{
    "properties":{
        "active_hosts":{
            "type":"integer"
        },
        "description":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "resources":{
            "properties":{
                "cpu_percent":{
                    "type":"integer"
                },
                "memory_max":{
                    "type":"integer"
                },
                "memory_percent":{
                    "type":"integer"
                },
                "memory_used":{
                    "type":"integer"
                }
            },
            "required":[
                "cpu_percent",
                "memory_max",
                "memory_percent",
                "memory_used"
            ],
            "type":"object"
        },
        "tags":{
            "type":"null"
        },
        "total_hosts":{
            "type":"integer"
        }
    },
    "required":[
        "active_hosts",
        "description",
        "id",
        "name",
        "resources",
        "tags",
        "total_hosts"
    ],
    "type":"object"
}

Nested Schema : resources

Type: object

Show Source

• cpu_percent: integer
• memory_max: integer
• memory_percent: integer
• memory_used: integer

{
    "properties":{
        "cpu_percent":{
            "type":"integer"
        },
        "memory_max":{
            "type":"integer"
        },
        "memory_percent":{
            "type":"integer"
        },
        "memory_used":{
            "type":"integer"
        }
    },
    "required":[
        "cpu_percent",
        "memory_max",
        "memory_percent",
        "memory_used"
    ],
    "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 create a new Oracle Container Cloud Service resource pool by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

curl -sk 
     -X "POST" 
     -H "Authorization: Bearer 53e024fb32c05723" 
     -H "Content-Type: application/json" "https://rest_server_url/api/pools/"
     -d '{"id":"mypool_id","name":"new_mypool_name","description":"description"}'

Back to Top