List All IP Pools
List ip pools with intent and status
Request
URI
GET
https://{api_host}/tca/caas/api/v3/orgs/{orgId}/clusters/{clusterId}/ippools
COPY
Path Parameters
string
orgId
Required
organization id for multiple tenant case
string
clusterId
Required
management cluster id
Query Parameters
string
name
Optional
search ippool by name
integer
page
Optional
return ippool with pagination
integer
pageSize
Optional
search ippool with pagination
Responses
200
OK
{
"items": [
{
"metadata": {
"creationTenantId": "string",
"creationTimestamp": "2023-02-06T08:25:44Z",
"creationUser": "string",
"deletionTimestamp": "2023-02-06T08:25:44Z",
"generation": 0,
"managementClusterName": "string",
"name": "string",
"uid": "string",
"updateTimestamp": "2023-02-06T08:25:44Z"
},
"spec": {
"addresses": [
"string"
],
"gateway": "string",
"prefix": 0
},
"status": {
"conditions": [
{
"lastTransitionTime": "2023-02-06T08:25:44.1441Z",
"message": "string",
"reason": "string",
"status": "True",
"type": "string"
}
],
"errorCode": "string",
"ipAddresses": {
"free": 0,
"outOfRange": 0,
"total": 0,
"used": 0
},
"observedGeneration": 0,
"phase": "string",
"usedAddresses": [
{
"addressInfo": [
{
"key": "string",
"value": "string"
}
]
}
]
}
}
],
"metadata": {
"first": false,
"last": false,
"page": 0,
"pageSize": 0,
"total": 0,
"totalPages": 0
}
}
array of
object
items
Optional
items
object
metadata
Optional
metadata
400
Bad Request
{
"details": [
{}
],
"errorCode": "string",
"errorMessage": "string"
}
array of
details
details
Optional
details
string
errorCode
Optional
Code represent codes in response
string
errorMessage
Optional
Message represent detail message
500
Internal Server Error
{
"details": [
{}
],
"errorCode": "string",
"errorMessage": "string"
}
array of
details
details
Optional
details
string
errorCode
Optional
Code represent codes in response
string
errorMessage
Optional
Message represent detail message