すべてのプロダクト
Search

このプロダクト

    ApsaraDB for ClickHouse:DescribeDBClusterNetInfoItems

    ドキュメントセンター

    ApsaraDB for ClickHouse:DescribeDBClusterNetInfoItems

    最終更新日:Dec 05, 2025

    指定された ApsaraDB for ClickHouse クラスターのネットワーク情報を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    clickhouse:DescribeDBClusterNetInfoItems

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    cc-bp1qx68m06981****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    NetInfoItems

    object

    NetInfoItem

    array<object>

    ネットワーク情報のリスト。

    object

    ネットワーク情報のリスト。

    VpcId

    string

    VPC ID。

    説明

    エンドポイントのネットワークタイプが `Public` の場合、このパラメーターは空になります。

    vpc-bp175iuvg8nxqraf2****
    VSwitchId

    string

    vSwitch ID。

    説明

    エンドポイントのネットワークタイプが `Public` の場合、このパラメーターは空になります。

    vsw-bp1gzt31twhlo0sa5****
    ConnectionString

    string

    データベースエンドポイント。

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

    string

    Java Database Connectivity (JDBC) ポート番号。

    3306
    NetType

    string

    エンドポイントのネットワークタイプ。有効な値：

    • Public：パブリックネットワーク。

    • VPC：VPC。

    VPC
    HttpPort

    string

    HTTP ポート番号。

    8123
    IPAddress

    string

    IP アドレス。

    10.255.234.251
    HttpsPort

    string

    HTTPS ポート番号。

    8443
    MySQLPort

    string

    MySQL ポート番号。

    9004
    ClusterNetworkType

    string

    ネットワークタイプ。VPC のみがサポートされています。

    VPC
    RequestId

    string

    リクエスト ID。

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

    boolean

    VPC で Server Load Balancer (SLB) が有効になっているかどうかを示します。有効な値：

    • true：有効。

    • false：無効。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

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

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。