Jump to

• Request
• Response
• Examples

Get a list of all resource pool configurations

get

/api/pools/

Retrieves a list of all resource pool configurations, including the number of hosts in the resource pool and memory usage of the resource pool.

Note: This endpoint is deprecated and will no longer be available in the future release.

Request

There are no request parameters for this operation.

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"
    },
    "type":"array"
}

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 retreive a list of all the resource pool configurations in your current Oracle Container Cloud Service instance. You perform this task by submitting a GET 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 -k 
     -X "GET" 
     -H "Authorization: Bearer adec7efcc71e9979" "https://rest_server_url/api/pools/"

Example of Response Header

[
  {
    "id": "default",
    "name": "default",
    "description": "",
    "total_hosts": 1,
    "active_hosts": 1,
    "tags": null,
    "resources": {
      "memory_max": 7477,
      "memory_used": 224,
      "memory_percent": 3,
      "cpu_percent": 0
    }
  },
  {
    "id": "development",
    "name": "Development",
    "description": "Development pool will contain dev hosts and assets",
    "total_hosts": 0,
    "active_hosts": 0,
    "tags": null,
    "resources": {
      "memory_max": 0,
      "memory_used": 0,
      "memory_percent": 0,
      "cpu_percent": 0
    }
  },
  {
    "id": "production",
    "name": "Production",
    "description": "Production pool will contain production hosts and assets",
    "total_hosts": 0,
    "active_hosts": 0,
    "tags": null,
    "resources": {
      "memory_max": 0,
      "memory_used": 0,
      "memory_percent": 0,
      "cpu_percent": 0
    }
  }
]

Back to Top