• Cloud Container Engine

cce
  1. Help Center
  2. Cloud Container Engine
  3. API Reference
  4. Cluster and Host Management (Proprietary APIs)
  5. Updating Container Cluster Information

Updating Container Cluster Information

Function

This API is used to update container cluster information.

URI

PUT /api/v1/clusters/{clusteruuid}

Table 1 describes the parameter of this API.

Table 1 Parameter description

Parameter

Mandatory

Description

clusteruuid

Yes

UUID of the container cluster.

Request

Request parameter:

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter

Mandatory

Type

Description

kind

Yes

String

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated.

apiVersion

Yes

String

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

spec

Yes

Table 3

-

Table 3 Data structure of the spec field

Parameter

Mandatory

Type

Description

description

No

String

Brief description of the container cluster.

The description must be 0 to 200 characters in length.

publicip_id

No

String

Unique ID of the EIP bound to the container cluster.

This parameter is only used to bind an EIP to a cluster that is not bound with any EIP before. If an EIP has been bound to a cluster, you cannot use this parameter to unbind or update the EIP.

NOTE:
  • If you need to unbind the EIP that has been bound to a cluster, call the VPC API. For detailed operations, see Help Center > Virtual Private Cloud > API Reference > Elastic IP Address > Updating Elastic IP Address Information.
  • If you need to update the EIP for a cluster, unbind the EIP from the cluster, and then use this parameter to bind a new EIP to the cluster.

Example request:

{
    "kind": "cluster",
    "apiVersion": "v1",
    "spec": {
        "description": "this is test",
        "publicip_id": "81bc17cb-d4ef-4454-9fd5-dc1d11b24a7c"
    }
}

Response

N/A

Status Code

Table 4 describes the status code of this API.

Table 4 Status code

Status Code

Description

200

The description of the container cluster is updated successfully.

For the description about status codes, see section Status Codes.