全部产品
Search

搜索本产品

    云数据库 ClickHouse：DescribeDBClusterNetInfoItems - 查看网络信息

    文档中心

    云数据库 ClickHouse：DescribeDBClusterNetInfoItems - 查看网络信息

    更新时间：Oct 23, 2024

    查询指定云数据库ClickHouse集群的网络信息。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    clickhouse:DescribeDBClusterNetInfoItemsget
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    DBClusterIdstring是

    集群 ID。

    		cc-bp1qx68m06981****

    返回参数

    名称类型描述示例值
    object
    NetInfoItemsarray<object>

    网络信息列表。

    NetInfoItemobject

    网络信息列表。

    VpcIdstring

    VPC ID。

    说明 连接地址的网络类型为 Public 时，返回值为空。
    		vpc-bp175iuvg8nxqraf2****
    VSwitchIdstring

    交换机 ID。

    说明 连接地址的网络类型为 Public 时，返回值为空。
    		vsw-bp1gzt31twhlo0sa5****
    ConnectionStringstring

    数据库连接地址。

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

    JDBC 端口号。

    		3306
    NetTypestring

    连接地址的网络类型，取值：

    • Public：公网。
    • VPC：VPC。
    		VPC
    HttpPortstring

    HTTP 端口号。

    		8123
    IPAddressstring

    IP 地址。

    		10.255.234.251
    HttpsPortstring

    HTTPS 端口号。

    		8443
    MySQLPortstring

    MySQL 端口号。

    		9004
    ClusterNetworkTypestring

    网络类型，目前只支持 VPC。

    		VPC
    RequestIdstring

    请求 ID。

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

    VPC 中是否开启了 SLB。取值说明：

    • true：开启。
    • false：不开启。
    		true

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2022-12-16OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情