すべてのプロダクト
Search

このプロダクト

    Cloud Enterprise Network:DescribePublishedRouteEntries

    ドキュメントセンター

    Cloud Enterprise Network:DescribePublishedRouteEntries

    最終更新日:Aug 07, 2025

    DescribePublishedRouteEntries 操作を呼び出すことで、Cloud Enterprise Network (CEN) インスタンス内のネットワークインスタンスにアドバタイズされたルートに関する情報を照会できます。ネットワークインスタンスには、仮想プライベートクラウド (VPC) と仮想ボーダールータ (VBR) が含まれます。返される情報には、各ルートの公開ステータス、ネクストホップのインスタンスタイプ、ルートを公開または撤回できるかどうかが含まれます。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cen:DescribePublishedRouteEntries

    get

    *CenInstance

    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

    *virtualborderrouter

    acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}

    *VPC

    acs:vpc:*:{#accountId}:vpc/{#vpcId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    タイプ

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    ページ番号です。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数です。デフォルト値: 10。有効な値: 1 から 500。

    10
    CenId

    string

    必須

    CEN インスタンスの ID です。

    cen-7qthudw0ll6jm****
    ChildInstanceId

    string

    必須

    ネットワークインスタンスの ID です。

    vpc-bp18sth14qii3pnv****
    ChildInstanceType

    string

    必須

    ネットワークインスタンスのタイプです。有効な値:

    • VPC: 仮想プライベートクラウド。

    • VBR: 仮想ボーダールータ。

    • CCN: Cloud Connect Network。

    VPC
    ChildInstanceRegionId

    string

    必須

    ネットワークインスタンスがデプロイされているリージョンの ID です。

    詳細については、「子インスタンスリージョンの照会 (DescribeChildInstanceRegions)」をご参照ください。

    cn-hangzhou
    ChildInstanceRouteTableId

    string

    任意

    ネットワークインスタンスのルートテーブルの ID です。

    vtb-bp174d1gje79u1g4****
    DestinationCidrBlock

    string

    任意

    クエリ対象のルートの宛先 CIDR ブロック。

    172.16.0.0/16

    レスポンスパラメーター

    パラメーター

    タイプ

    説明

    例

    object

    PageSize

    integer

    1 ページあたりのエントリ数。

    10
    RequestId

    string

    リクエスト ID。

    FF1A7B2A-677F-4F71-96EA-6002B329F437
    PageNumber

    integer

    ページ番号。

    1
    TotalCount

    integer

    返されたエントリの総数。

    2
    PublishedRouteEntries

    object

    PublishedRouteEntry

    array<object>

    ルートエントリのリスト。

    object

    NextHopId

    string

    ネクストホップに関連付けられているインスタンスの ID。

    ecs-bp18sth14qii3pn****
    PublishStatus

    string

    CEN インスタンスにおけるルートの公開ステータス:

    • 公開済み: ルートは公開されています。

    • 未公開: ルートは公開されていません。

    Published
    ChildInstanceRouteTableId

    string

    ネットワークインスタンスのルートテーブルの ID。

    vtb-il7qut3mjgtlcbpk2****
    NextHopType

    string

    ネクストホップに関連付けられているインスタンスのタイプ。

    • Instance: ECS インスタンス。

    • HaVip: 高可用性仮想 IP アドレス (HAVIP)。

    • RouterInterface: ルーターインターフェース。

    • NetworkInterface: 弾性ネットワークインターフェース (ENI)。

    • VpnGateway: VPN ゲートウェイ。

    • IPv6Gateway: IPv6 ゲートウェイ。

    • Ipv4Gateway: IPv4 ゲートウェイ。

    • NatGateway: NAT ゲートウェイ。

    • Attachment: ネットワークインスタンス接続。

    • service: Alibaba Cloud サービス。

    • VBR: 仮想ボーダールータ。

    • CCN: Cloud Connect Network インスタンス。

    • VPC: 仮想プライベートクラウド。

    • local: ルートはネットワークインスタンスのシステムルートであり、ネクストホップはありません。

    • TR: トランジットルーター。

    • BlackHole: ルートはブラックホールルートであり、ネクストホップはありません。

    • EcRouterInterface: Express Connect ルーターインターフェース。

    • HealthCheck: ヘルスチェック。

    • AS: CCN インスタンスのアクセスゲートウェイ。

    • classicLink: クラシックネットワークインスタンス。

    • GatewayEndpoint: ゲートウェイエンドポイント。

    • CPE: VBR に接続されたデータセンター。

    Instance
    OperationalMode

    boolean

    ルートを CEN インスタンスに公開または CEN インスタンスから撤回できるかどうかを示します。

    • true: ルートを公開または撤回できます。

    • false: ルートを公開または撤回できません。

    true
    DestinationCidrBlock

    string

    ルートの宛先 CIDR ブロック。

    172.16.0.0/16
    RouteType

    string

    ルートのタイプ。

    • CEN: CEN インスタンスから学習したルート。

    • System: システムルート。

    • Custom: カスタムルート。

    System
    Conflicts

    object

    Conflict

    array<object>

    競合するルートのリスト。

    object

    Status

    string

    ルート競合の原因。

    • conflict: ルートは、同じ宛先 CIDR ブロックを持つ別のルートと競合しています。

    • overflow: 別のネットワークインスタンスのルートテーブル内のルート数が制限に達しました。

    conflict
    DestinationCidrBlock

    string

    競合するルートの宛先 CIDR ブロック。

    192.168.20.0/24
    InstanceId

    string

    ルートが競合するピアネットワークインスタンスの ID。

    ccn-0q3b7oviikmm9h****
    InstanceType

    string

    ルートが競合するピアネットワークインスタンスのタイプ。

    • VPC: 仮想プライベートクラウド。

    • VBR: 仮想ボーダールータ。

    • CCN: Cloud Connect Network インスタンス。

    CCN
    RegionId

    string

    ルートが競合するピアネットワークインスタンスがデプロイされているリージョンの ID。

    ccn-cn-shanghai

    例

    成功レスポンス

    JSONJSON

    {
  "PageSize": 10,
  "RequestId": "FF1A7B2A-677F-4F71-96EA-6002B329F437",
  "PageNumber": 1,
  "TotalCount": 2,
  "PublishedRouteEntries": {
    "PublishedRouteEntry": [
      {
        "NextHopId": " ecs-bp18sth14qii3pn****",
        "PublishStatus": "Published",
        "ChildInstanceRouteTableId": "vtb-il7qut3mjgtlcbpk2****",
        "NextHopType": "Instance",
        "OperationalMode": true,
        "DestinationCidrBlock": "172.16.0.0/16",
        "RouteType": "System",
        "Conflicts": {
          "Conflict": [
            {
              "Status": "conflict",
              "DestinationCidrBlock": "192.168.20.0/24",
              "InstanceId": "ccn-0q3b7oviikmm9h****",
              "InstanceType": "CCN",
              "RegionId": "ccn-cn-shanghai"
            }
          ]
        }
      }
    ]
  }
}

    エラーレスポンス

    JSONJSON

    {
  "TotalCount": 2, 
  "PublishRouteEntries": {
    "PublishRouteEntries": [
      {
        "DestinationCidrBlock": "100.64.0.0/10", 
        "NextHopId": "", 
        "NextHopType": "service", 
        "ChildInstanceRouteTableId": "vtb-il7qut3mjgtlcbpk2ie31", 
        "PublishStatus": "NonPublished", 
        "RouteConflicts": {
          "RouteConflicts": []
        }, 
        "RouteType": "System"
      }, 
      {
        "DestinationCidrBlock": "192.168.10.0/24", 
        "NextHopId": "", 
        "NextHopType": "local", 
        "ChildInstanceRouteTableId": "vtb-il7qut3mjgtlcbpk2ie31", 
        "PublishStatus": "Published", 
        "RouteConflicts": {
          "RouteConflicts": []
        }, 
        "RouteType": "System"
      }
    ]
  }, 
  "PageNumber": 1, 
  "RequestId": "FF1A7B2A-677F-4F71-96EA-6002B329F437", 
  "PageSize": 10
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 ParameterIllegal.CenInstanceId The parameter of CEN instance id is illegal.
    400 ParameterIllegal.ChildInstanceRegionId The parameter of child instance region id is illegal.
    400 VRC_ERROR VRC error
    400 ParameterIllegal.ChildInstanceType The parameter of child instance type is illegal.
    400 ParameterIllegal The parameter is illegal.
    400 InvalidParameter Invalid parameter.
    400 Unauthorized The AccessKeyId is unauthorized.
    500 InternalError Internal error.
    404 Instance.NotExist The instance is not exist.
    409 InvalidOperation.ChildInstanceStatus The child-instance is not in a valid state for the operation.
    409 InvalidOperation.CenInstanceStatus The CEN instance is not in a valid state for the operation.

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

    変更履歴

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