Update IP Pool

Update IP Pool

Modify ip pool in management cluster

Request
URI
PUT
https://{api_host}/tca/caas/api/v3/orgs/{orgId}/clusters/{clusterId}/ippools/{uid}
COPY
Path Parameters
string
orgId
Required

organization id for multiple tenant case

string
clusterId
Required

management cluster id

string
uid
Required

uid of the ip pool intent


Request Body
createIPPoolRequest of type(s) application/json
Optional
{
    "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"
                    }
                ]
            }
        ]
    }
}
Responses
200

OK

{
    "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"
                    }
                ]
            }
        ]
    }
}
object
metadata
Optional

metadata

object
spec
Optional

spec

status
Optional

For POST/PUT response body, status is invisible


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


404

Not Found

{
    "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