listInstancePrivateNetworks
List instance Private Networks
Details
- Method:
GET - Path:
/instances/{instance-id}/private-networks - Operation ID:
list-instance-private-networks
Parameters
{
"per_page": {
"description": "Number of items requested per page. Default is 100 and Max is 500.",
"required": false,
"location": "query",
"type": "integer"
},
"cursor": {
"description": "Cursor for paging. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination).",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"type": "object",
"properties": {
"private_networks": {
"type": "array",
"items": {
"title": "private-networks",
"type": "object",
"x-tags": [
"private-networks"
],
"description": "Private Network information.",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for the Private Network."
},
"mac_address": {
"type": "string",
"description": "The assigned MAC address."
},
"ip_address": {
"type": "string",
"description": "The assigned IP address."
}
},
"x-examples": {
"example-1": {}
},
"deprecated": true
}
},
"meta": {
"title": "meta",
"type": "object",
"x-examples": {
"meta response": {
"meta": {
"total": 31,
"links": {
"next": "WxYzExampleNext",
"prev": ""
}
}
}
},
"description": "The meta information object. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination) for more information.",
"properties": {
"total": {
"type": "integer",
"description": "Total objects available in the list. This value may be greater than the number of objects returned if `per_page` is set."
},
"links": {
"type": "object",
"description": "Cursor values for pagination.",
"properties": {
"next": {
"type": "string",
"description": "Cursor value for the next page."
},
"prev": {
"type": "string",
"description": "Cursor value for the previous page."
}
}
}
}
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('vultr')
# Call this tool
result = await agent.call_tool('listInstancePrivateNetworks', {
# Add required parameters here
})