Cloud Enterprise Network (CEN) インスタンスのルーティングポリシーを照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DescribeCenRouteMaps

実行する操作です。 値をDescribeCenRouteMapsに設定します。

PageNumber Integer 任意 1

返されるページ数。 既定値：1

PageSize Integer 任意 10

各ページで返されるエントリ数。 デフォルト値: 10

CenId String 必須 cen-wx12mmlt17ld82 ****

CEN インスタンスの ID。

RouteMapId String 任意 cenrmap-y40mxdvf7joc12 ****

ルーティングポリシーの ID。

CenRegionId String 任意 cn-hangzhou

ルーティングポリシーが適用される地域の ID。

DescribeChildInstanceRegionsを呼び出して、最新のリージョンリストを照会できます。

TransmitDirection String 任意 RegionOut

ルーティングポリシーが適用される方向。 設定可能な値は以下のとおりです。

  • RegionIn: ルートは、CENインスタンスによって接続されているリージョンのゲートウェイにアドバタイズされます。

    たとえば、ルートは、現在のリージョンまたは他のリージョンにデプロイされたネットワークインスタンスから、現在のリージョンにデプロイされたゲートウェイに通知されます。

  • RegionOut: ルートは、CENインスタンスによって接続されているリージョンのゲートウェイからアドバタイズされます。

    たとえば、ルートは、現在のリージョンにデプロイされたゲートウェイから、現在のリージョンにデプロイされたネットワークインスタンス、または他のリージョンにデプロイされたゲートウェイに通知されます。

TransitRouterRouteTableId String 任意 vtb-gw8nx3515m1mbd1z1 ****

ルーティングポリシーが関連付けられているトランジットルーターのルートテーブルID。

レスポンスパラメーター

パラメーター データ型 例 説明
PageSize Integer 10

1 ページあたりで返されるエントリ数。

RequestId String 24CE1987-D1D1-5324-9BAD-2750B60E6ABB

リクエストの ID です。

PageNumber Integer 1

返されたページの数を示します。

TotalCount Integer 1

返されたエントリの数。

RouteMaps RouteMapの配列

ルーティングポリシーに関する情報。

ルートマップ
RouteMapId String cenrmap-y40mxdvf7joc12 ****

ルーティングポリシーの ID。

Status String Active

ルーティングポリシーのステータス。 設定可能な値は以下のとおりです。

  • 作成中: ルーティングポリシーが作成中です。
  • 有効: ルーティングポリシーが使用可能です。
  • Deleting: ルーティングポリシーは削除中です。
TransmitDirection String RegionOut

ルーティングポリシーが適用される方向。

SourceInstanceIdsReverseMatch ブール 偽

移行元ネットワークインスタンスIDを除外するかどうかを示します。

  • false (デフォルト): ソースネットワークインスタンスIDがSourceInstanceIds.Nで指定されたリストにある場合、ルートは一致します。
  • true: ソースネットワークインスタンスIDがSourceInstanceIds.Nで指定されたリストにない場合、ルートは一致します。
CenRegionId String cn-hangzhou

ルーティングポリシーが適用されるリージョンのID。

CenId String cen-wx12mmlt17ld82 ****

CEN インスタンスの ID。

Priority Integer 5000

ルーティングポリシーの優先度。 数字が小さいほど、優先度が高くなります。

TransitRouterRouteTableId String vtb-gw8nx3515m1mbd1z1 ****

ルーティングポリシーが関連付けられているトランジットルーターのルートテーブルID。

CommunityOperateMode String Additive

ルートのコミュニティで実行されるアクション。

  • Additive: コミュニティをルートに追加します。
  • Replace:ルートの元のコミュニティに置き換わります。

このパラメーターは、ルートが一致条件を満たしたときに実行されるアクションを示します。

MapResult String 拒否

一致した条件に合致する経路に対して実行されるアクション。

  • 許可: ルートは許可されています。
  • 拒否: ルートは拒否されます。
CommunityMatchMode String Include

コミュニティに基づいて経路をマッチングするために使用するマッチ方法。

  • 含める: あいまい一致。 ルートのコミュニティが一致条件で指定されたコミュニティと重複する場合、ルートは一致します。
  • Complete: 完全一致。 ルートは、ルートのコミュニティが一致条件で指定されたコミュニティと同じである場合にのみ一致します。
説明 String desctest

ルーティングポリシーの説明。

AsPathMatchMode String Include

ASパスに基づいてルートを照合するために使用される照合方法。

  • 含める: あいまい一致。 ルートのASパスが一致条件で指定されたASパスと重複する場合、ルートは一致します。
  • Complete: 完全一致。 ルートのASパスが一致条件で指定されたasパスと同じ場合にのみ、ルートが一致します。
Preference Integer 20

ルートの新しい優先度。

数字が小さいほど、優先度が高くなります。

このパラメーターは、ルートが一致条件を満たしたときに実行されるアクションを示します。

DestinationInstanceIdsReverseMatch ブール 偽

宛先ネットワークインスタンスIDを除外するかどうかを示します。

  • false (デフォルト): 宛先ネットワークインスタンスIDがDestinationInstanceIds.Nで指定されたリストにある場合、ルートは一致します。
  • true: 宛先ネットワークインスタンスIDがDestinationInstanceIds.Nで指定されたリストにない場合、ルートは一致します。
CidrMatchMode String Include

プレフィックスに基づいてルートを照合するために使用されるmatchメソッド。 設定可能な値は以下のとおりです。

  • 含める: あいまい一致。 ルートプレフィックスが一致条件に含まれている場合、ルートは一致します。

    たとえば、一致条件を10.10.0.0/16に設定し、ファジー一致が有効になっている場合、プレフィックスが10.10.1.0/24のルートは一致します。

  • Complete: 完全一致。 ルートプレフィックスが一致条件で指定されたプレフィックスと同じ場合にのみ、ルートが一致します。

    たとえば、一致条件を10.10.0.0/16に設定し、完全一致が有効になっている場合、プレフィックスが10.10.0.0/16の場合にのみルートが一致します。

NextPriority Integer 33

現在のルーティングポリシーに関連付けるルーティングポリシーの優先度。

MatchAddressType String IPv4

一致条件と照合するIPアドレスのタイプ。 設定可能な値は以下のとおりです。

  • IPv4: IPv4アドレス
  • IPv6: IPv6アドレス
  • 値が返されない場合、IPv4アドレスとIPv6アドレスの両方が一致条件と一致します。
SourceRegionIds 文字列の配列 cn-hangzhou

ルートが属するソースリージョンのID。

SourceChildInstanceTypes 文字列の配列 VPC

ルートが属するソースネットワークインスタンスのタイプ。

  • VPC: 仮想プライベートクラウド (VPC)
  • VBR: 仮想ボーダールーター (VBR)
  • CCN: Cloud Connect Network (CCN) インスタンス
  • VPN: IPsec-VPN接続
DestinationRouteTableIds 文字列の配列 vtb-adefrgtr144vf ****

ルートが属する宛先ルートテーブルのID。 最大32のルートテーブルIDを入力できます。

説明 宛先ルートテーブルIDは、現在のリージョンのゲートウェイから現在のリージョンのルートテーブルにルートが通知されるシナリオにルーティングポリシーが適用されている場合にのみ有効です。
SourceInstanceIds 文字列の配列 vpc-adeg3544fdf34vf ****

ルートが属するソースネットワークインスタンスのID。

DestinationCidrBlocks Array of String 10.10.10.0/24

ルートのプレフィックス。

SourceRouteTableIds 文字列の配列 vtb-adfr233vf34rvd4 ****

ルートが属するソースルートテーブルのID。

MatchCommunitySet 文字列の配列 65501:1

ルートの比較に基づくコミュニティセット。

PrependAsPath 文字列の配列 65501

リージョナルゲートウェイがルートを受信またはアドバタイズするときに、アクションステートメントを使用して先頭に追加されるASパス。

このパラメーターは、ルートが一致条件を満たしたときに実行されるアクションを示します。

RouteTypes 文字列の配列 システム

比較される経路の種類。設定可能な値は以下のとおりです。

  • System: システムによって自動的に生成されるシステムルート。
  • Custom: 手動で追加されたカスタムルート。
  • BGP: Border Gateway Protocol (BGP) を介してアドバタイズされるルート。
DestinationChildInstanceTypes 文字列の配列 VPC

ルートが属する宛先ネットワークインスタンスのタイプ。

  • VPC: VPC
  • VBR：VBR
  • CCN: CCNインスタンス
  • VPN: IPsec-VPN connection
説明 宛先ネットワークインスタンスタイプは，現領域のゲートウェイから現領域のネットワークインスタンスに経路を広告するシナリオにルーティングポリシーを適用するときのみ有効です。
DestinationInstanceIds 文字列の配列 vpc-afrfs434465fdf ****

経路が属するデスティネーションネットワークインスタンスの ID。

説明 宛先ネットワークインスタンス ID は，現領域のゲートウェイから現領域のネットワークインスタンスに経路を広告するシナリオにルーティングポリシーを適用するときだけ有効です。
MatchAsns 文字列の配列 65501

ルートの比較に基づくASパス。

OperateCommunitySet Array of String 65501:1

アクションが実行されるコミュニティセット。

例

リクエストの例

http(s)://[Endpoint]/?Action=DescribeCenRouteMaps
&PageNumber=1
&PageSize=10
&CenId=cen-wx12mmlt17ld82 ****
&RouteMapId=cenrmap-y40mxdvf7joc12 ****
&CenRegionId=cn-hangzhou
&TransmitDirection=RegionOut
&TransitRouterRouteTableId=vtb-gw8nx3515m1mbd1z1 ****
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCenRouteMapsResponse>
    <TotalCount> 1 </ TotalCount>
    <RequestId>24CE1987-D1D1-5324-9BAD-2750B60E6ABB</RequestId>
    <のPageSize> 10 </がPageSize>
    <ページ番号> 1 </ PAGENUMBER>
    <RouteMaps>
        <RouteMap>
            <Status>Active</Status>
            <TransitRouterRouteTableId>vtb-gw8nx3515m1mbd1z1 ****</TransitRouterRouteTableId>
            <Priority>5000</Priority>
            <SourceChildInstanceTypes>
                <SourceChildInstanceType>VBR</SourceChildInstanceType>
                <SourceChildInstanceType>CCN</SourceChildInstanceType>
            </SourceChildInstanceTypes>
            <CenId>cen-wx12mmlt17ld82 ****</CenId>
            <TransmitDirection>RegionOut</TransmitDirection>
            <CenRegionId>cn-hangzhou</CenRegionId>
            <RouteMapId>cenrmap-y40mxdvf7joc12 ****</RouteMapId>
            <MapResult> 拒否 </MapResult>
            <DestinationChildInstanceTypes>
                <DestinationChildInstanceType>VBR</DestinationChildInstanceType>
                <DestinationChildInstanceType>CCN</DestinationChildInstanceType>
            </DestinationChildInstanceTypes>
        </RouteMap>
    </RouteMaps>
</DescribeCenRouteMapsResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1、
  "RequestId" : "24CE1987-D1D1-5324-9BAD-2750B60E6ABB" 、
  "PageSize" : 10,
  "PageNumber" : 1,
  "RouteMaps" : {
    "RouteMap" : [ {
      "ステータス" : "アクティブ" 、
      "TransitRouterRouteTableId" : "vtb-gw8nx3515m1mbd1z1 ****" 、
      "優先度" : 5000、
      "SourceChildInstanceTypes" : {
        "SourceChildInstanceType" : [ "VBR", "CCN"]
      },
      "CenId" : "cen-wx12mmlt17ld82 ****" 、
      "TransmitDirection" : "RegionOut" 、
      "CenRegionId" : "cn-hangzhou" 、
      "RouteMapId" : "cenrmap-y40mxdvf7joc12 ****" 、
      "MapResult" : "Deny" 、
      "DestinationChildInstanceTypes" : {
        "DestinationChildInstanceType" : [ "VBR", "CCN"]
      }
    } ]
  }
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。