查询指定云数据库ClickHouse集群的网络信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| clickhouse:DescribeDBClusterNetInfoItems | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 | cc-bp1qx68m06981**** |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-12-16 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |