All Products
Search

This Product

    ApsaraDB for ClickHouse:DescribeDBClusterNetInfoItems

    Document Center

    ApsaraDB for ClickHouse:DescribeDBClusterNetInfoItems

    Last Updated:Dec 05, 2025

    Queries the network information for a specified ApsaraDB for ClickHouse cluster.

    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:DescribeDBClusterNetInfoItems

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    cc-bp1qx68m06981****

    Response elements

    Element

    Type

    Description

    Example

    object

    NetInfoItems

    object

    NetInfoItem

    array<object>

    A list of network information.

    object

    A list of network information.

    VpcId

    string

    The VPC ID.

    Note

    This parameter is empty if the network type of the endpoint is `Public`.

    vpc-bp175iuvg8nxqraf2****
    VSwitchId

    string

    The vSwitch ID.

    Note

    This parameter is empty if the network type of the endpoint is `Public`.

    vsw-bp1gzt31twhlo0sa5****
    ConnectionString

    string

    The database endpoint.

    cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com
    JdbcPort

    string

    The Java Database Connectivity (JDBC) port number.

    3306
    NetType

    string

    The network type of the endpoint. Valid values:

    • Public: the public network.

    • VPC: a VPC.

    VPC
    HttpPort

    string

    The HTTP port number.

    8123
    IPAddress

    string

    The IP address.

    10.255.234.251
    HttpsPort

    string

    The HTTPS port number.

    8443
    MySQLPort

    string

    The MySQL port number.

    9004
    ClusterNetworkType

    string

    The network type. Only VPC is supported.

    VPC
    RequestId

    string

    The request ID.

    9A23C87D-87DF-4DA0-A50E-CB13F4F7923D
    EnableSLB

    boolean

    Indicates whether Server Load Balancer (SLB) is enabled in the VPC. Valid values:

    • true: enabled.

    • false: disabled.

    true

    Examples

    Success response

    JSON format

    {
  "NetInfoItems": {
    "NetInfoItem": [
      {
        "VpcId": "vpc-bp175iuvg8nxqraf2****",
        "VSwitchId": "vsw-bp1gzt31twhlo0sa5****",
        "ConnectionString": "cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com",
        "JdbcPort": "3306",
        "NetType": "VPC",
        "HttpPort": "8123",
        "IPAddress": "10.255.234.251",
        "HttpsPort": "8443",
        "MySQLPort": "9004"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D",
  "EnableSLB": true
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The DBClusterId provided does not exist in our records.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.