Updating a Professional Event Stream Cluster

Function

This API is used to update a professional event stream cluster.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v1/{project_id}/eventrouter/clusters/{cluster_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.
cluster_id	Yes	String	Cluster ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Cluster name. Start with a letter or digit, and only include letters, digits, periods (.), underscores (_), and hyphens (-). (Max. 128 characters)
description	No	String	Cluster description. The description can contain a maximum of 256 characters.
public_access_enabled	No	Boolean	Whether public access is enabled for the event stream cluster.
nat_id	No	String	ID of the NAT instance bound to the cluster when public access is enabled.
eip_id	No	String	ID of the EIP instance bound to the cluster when public access is enabled.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 5** Response body parameters
Parameter	Type	Description
cluster_id	String	Professional event stream cluster ID.
name	String	Cluster name. Start with a letter or digit, and only include letters, digits, periods (.), underscores (_), and hyphens (-). (Max. 128 characters)
description	String	Cluster description. The description can contain a maximum of 256 characters.
source_type	String	Source type.
sink_type	String	Target type.
subnet_id	String	Subnet ID.
vpc_id	String	VPC ID.
zone_names	String	AZ name.
status	String	Job status.
job_count	Number	Number of jobs in the current cluster.
flavor	String	Flavor.
charging_mode	String	Billing mode.
err_code	String	Error code.
err_message	String	Error cause.
created_time	String	UTC time when the event source is created.
updated_time	String	UTC time when the event source is updated.

Example Requests

Update the description of the professional event stream cluster cluster-xspx0v5v.

PUT https://{eg_endpoint}/v1/{project_id}/eventrouter/clusters/{cluster_id}

{
  "name" : "cluster-xspx0v5v",
  "description" : "xxx",
  "public_access_enabled" : true,
  "nat_id" : "c43e1888-6589-4b43-xxxxxxxxxxxx",
  "eip_id" : "e7d72bae-653e-4fb5-xxxxxxxxxxxx"
}

Example Responses

Status code: 200

Request succeeded.

{
  "cluster_id" : "fac59513-6c18-4266-bc81-5d412dfc1925",
  "name" : "cluster-ifpcv5u4",
  "description" : null,
  "source_type" : "KAFKA",
  "sink_type" : "KAFKA",
  "status" : "RUNNING",
  "job_count" : 1,
  "err_code" : null,
  "err_message" : null,
  "created_time" : "2024-05-16T11:46:07Z",
  "updated_time" : "2024-05-16T11:46:07Z",
  "vpc_id" : "199f632d-34e7-4915-b4d8-1bc4e2824867",
  "subnet_id" : "0d1799e1-116e-4551-92dc-02dd8a860072",
  "public_access_enabled" : true,
  "nat_id" : "c43e1888-6589-4b43-xxxxxxxxxxxx",
  "eip_id" : "e7d72bae-653e-4fb5-xxxxxxxxxxxx"
}