Jump to

• Request
• Response
• Examples

Update resource pool

put

/api/pools/{poolID}

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

Request

Supported Media Types

• application/json

Path Parameters

• poolID: string
  poolID

Body ()

Body parameters

Root Schema : schema

Type: object

Show Source

• active_hosts: integer
• ActiveCount: integer
• Description: string
• description: string
• id: string
• InactiveCount: integer
• name: string
• tags: array tags

{
    "properties":{
        "ActiveCount":{
            "type":"integer"
        },
        "Description":{
            "type":"string"
        },
        "InactiveCount":{
            "type":"integer"
        },
        "active_hosts":{
            "type":"integer"
        },
        "description":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "tags":{
            "items":{
            },
            "type":"array"
        }
    },
    "required":[
        "ActiveCount",
        "Description",
        "InactiveCount",
        "active_hosts",
        "description",
        "id",
        "name",
        "tags"
    ],
    "type":"object"
}

Nested Schema : tags

Type: array

Show Source

• Array of:

{
    "items":{
    },
    "type":"array"
}

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":{
            "Description":{
                "type":"string"
            },
            "ID":{
                "type":"string"
            },
            "Name":{
                "type":"string"
            },
            "Resources":{
                "properties":{
                },
                "type":"object"
            }
        },
        "required":[
            "Description",
            "ID",
            "Name",
            "Resources"
        ],
        "type":"object"
    }
}

Nested Schema : items

Type: object

Show Source

• Description: string
• ID: string
• Name: string
• Resources: object Resources

{
    "properties":{
        "Description":{
            "type":"string"
        },
        "ID":{
            "type":"string"
        },
        "Name":{
            "type":"string"
        },
        "Resources":{
            "properties":{
            },
            "type":"object"
        }
    },
    "required":[
        "Description",
        "ID",
        "Name",
        "Resources"
    ],
    "type":"object"
}

Nested Schema : Resources

Type: object

Show Source

{
    "properties":{
    },
    "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 update an existing Oracle Container Cloud Service resource pool by submitting a PUT request on 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 "PUT"
     -H "Authorization: Bearer 53e024fb32c05723"
     -H "Content-Type: application/json" "https://rest_server_url/api/pools/redis"
     -d '{"id":"mypool_id","name":"new_mypool_name","description":"New description"}'

Back to Top