Jump to

• Request
• Response
• Examples

Get resource pool details

get

/api/pools/{poolID}

Retrieves the details of a specific resource pool. You specify the pool using the poolID parameter.

Request

Path Parameters

• poolID: string
  poolID

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

Nested Schema : items

Type: object

Show Source

• active_hosts: string
• description: string
• id: string
• name: string
• resources: object resources
• total_hosts: string

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

Nested Schema : resources

Type: object

Show Source

• cpu_percent: string
• memory_max: string
• memory_percent: string
• memory_used: string

{
    "properties":{
        "cpu_percent":{
            "type":"string"
        },
        "memory_max":{
            "type":"string"
        },
        "memory_percent":{
            "type":"string"
        },
        "memory_used":{
            "type":"string"
        }
    },
    "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 retrieve the details about a specific resource pool. 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 -sk 
     -X "GET" 
     -H "Authorization: Bearer b39f09c71c297f1d" 
     "https://rest_server_url/api/pools/default"

In this example, default is the name of the resource pool.

Example of Response Body

{
  "id": "default",
  "name": "default",
  "total_hosts": "1",
  "active_hosts": "1",
  "resources": {
    "memory_max": "7477",
    "memory_used": "224",
    "memory_percent": "3"
  }
}

Back to Top