ModifyDBInstanceConnectionString - ApsaraDB for ClickHouse

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

clickhouse:ModifyDBInstanceConnectionString

update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
DBInstanceId	string	Yes	The cluster ID.	cc-xxxxx
ConnectionString	string	No	The connection address.	cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com
ConnectionStringPrefix	string	No	The prefix of the endpoint for the database connection.	cc-****-clickhouse
DisablePorts	string	No	Disables the specified database ports. To disable multiple ports, separate them with commas (,). This parameter is supported only for clusters with a kernel version of 24.10.1.11098_1 or later. Important This parameter is not supported for clusters that were created with a kernel version earlier than 24.10.1.11098_1 and then upgraded to version 24.10.1.11098_1 or later.	9001,8123
DBInstanceNetType	string	No
ComputingGroupId	string	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	xxx-xxx-xxx
Data	object	The returned data.
DBInstanceID	integer	The cluster ID.	cc-xxxxx
ConnectionString	string	The connection address.	cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com
DBInstanceName	string	The cluster name.	cc-xxxxx
DisabledPorts	string	The disabled database ports.	9001,8123

Examples

Success response

JSON format

{
  "RequestId": "xxx-xxx-xxx",
  "Data": {
    "DBInstanceID": 0,
    "ConnectionString": "cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com",
    "DBInstanceName": "cc-xxxxx",
    "DisabledPorts": "9001,8123"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.