すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeNetworkChannel

    ドキュメントセンター

    PolarDB:DescribeNetworkChannel

    最終更新日:Sep 24, 2026

    ネットワークチャンネルを照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeNetworkChannel

    get

    *DBCluster。

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-************
    DBClusterId

    string

    必須

    ソースインスタンス名。

    pc-*************
    ChannelName

    string

    任意

    チャンネル名。

    ch4
    VpcId

    string

    任意

    アクセスエンドポイントが存在する VPC の ID。

    vpc-bp1qpo0kug3a20qqe****
    RegionId

    string

    任意

    リージョン ID。

    cn-hangzhou
    ClientToken

    string

    任意

    リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントがトークンを生成し、リクエスト間で一意になるようにします。トークンは大文字と小文字が区別され、最大 64 文字の ASCII 文字を使用できます。

    6000170000591aed949d0f54a343f1a4233c1e7d1c5******

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    ChannelInfos

    array<object>

    ネットワークチャンネルのリスト。

    object

    ネットワークチャンネルデータ。

    ChannelName

    string

    チャンネル名。

    ch4
    DBClusterId

    string

    ソースインスタンス名。

    pc-*************

    EniId

    string

    ネットワークチャンネルのリバースアクセスリンクで使用されるエラスティックネットワークインターフェース (ENI) の ID。接続にはネットワークインターフェースコントローラー (NIC) が使用されます。

    eni-2z******
    Notes

    string

    備考。

    テスト更新
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    TargetDBClusterId

    string

    ターゲットインスタンス名。

    pc-*************

    TargetIp

    string

    ターゲットインスタンスの IP アドレス。

    33.*.*.240
    TargetPort

    string

    ターゲットインスタンスのポート。

    3389
    TargetType

    string

    ターゲットインスタンスタイプ。

    polardb_for_postgresql
    VpcId

    string

    アクセスエンドポイントが存在する VPC の ID。

    vpc-2ze13g2c6j7j2jl*******
    RequestId

    string

    リクエストの ID。

    925B84D9-CA72-432C-95CF-738C22******

    例

    成功レスポンス

    JSONJSON

    {
  "ChannelInfos": [
    {
      "ChannelName": "ch4",
      "DBClusterId": "pc-*************\n",
      "EniId": "eni-2z******",
      "Notes": "test update",
      "RegionId": "cn-hangzhou",
      "TargetDBClusterId": "pc-*************\n",
      "TargetIp": "33.*.*.240",
      "TargetPort": "3389",
      "TargetType": "polardb_for_postgresql",
      "VpcId": "vpc-2ze13g2c6j7j2jl*******"
    }
  ],
  "RequestId": "925B84D9-CA72-432C-95CF-738C22******"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. 指定された DBClusterId が現在のレコードに存在しません。

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

    変更履歴

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