DescribeCenRouteMaps によるルーティングポリシー設定のクエリ - CEN - Alibaba Cloud - Cloud Enterprise Network

ルートマップの構成情報を照会します。

操作説明

今すぐお試しください

この 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:DescribeCenRouteMaps

get

*CenInstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	リストのページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリにおける 1 ページあたりのエントリ数。デフォルト値: 10。	10
CenId	string	必須	Cloud Enterprise Network (CEN) インスタンスの ID。	cen-wx12mmlt17ld82****
RouteMapId	string	任意	ルートマップの ID。	cenrmap-y40mxdvf7joc12****
CenRegionId	string	任意	ルートマップが適用されるリージョンの ID。 DescribeChildInstanceRegions 操作を呼び出してリージョン ID をクエリできます。	cn-hangzhou
TransmitDirection	string	任意	ルートマップが適用される方向。有効な値: RegionIn: ルートが CEN インスタンスのリージョナルゲートウェイにアドバタイズされます。例えば、ローカルリージョンのネットワークインスタンスからローカルのリージョナルゲートウェイへルートがアドバタイズされる場合や、他のリージョンのリージョナルゲートウェイからローカルのリージョナルゲートウェイへルートがアドバタイズされる場合などです。 RegionOut: ルートが CEN インスタンスのリージョナルゲートウェイからアドバタイズされます。例えば、ローカルのリージョナルゲートウェイからローカルリージョンのネットワークインスタンスへルートがアドバタイズされる場合や、ローカルのリージョナルゲートウェイから他のリージョンのリージョナルゲートウェイへルートがアドバタイズされる場合などです。	RegionOut
TransitRouterRouteTableId	string	任意	ルートマップに関連付けられたトランジットルーターのルートテーブルの ID。	vtb-gw8nx3515m1mbd1z1****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
PageSize	integer	ページングクエリにおける 1 ページあたりのエントリ数。このパラメーターはページングに使用されます。	10
RequestId	string	リクエスト ID。	24CE1987-D1D1-5324-9BAD-2750B60E6ABB
PageNumber	integer	リストのページ番号。	1
TotalCount	integer	エントリの総数。	1
RouteMaps	object
RouteMap	array<object>	ルートマップ情報のリスト。
	array<object>	ルートマップ情報。
RouteMapId	string	ルートマップの ID。	cenrmap-y40mxdvf7joc12****
Status	string	ルートマップのステータス。 Creating: ルートマップを作成中です。 Active: ルートマップは利用可能です。 Deleting: ルートマップを削除中です。	Active
TransmitDirection	string	ルートマップが適用される方向。	RegionOut
SourceInstanceIdsReverseMatch	boolean	ソースインスタンス ID リストに逆再生モードが使用されているかどうかを示します。 false: 逆再生モードは使用されていません。ルートのソースインスタンス ID が SourceInstanceIds.N に含まれている場合、ルートは条件に一致します。 true: 逆再生モードが使用されています。ルートのソースインスタンス ID が SourceInstanceIds.N に含まれていない場合、ルートは条件に一致します。	false
CenRegionId	string	ルートマップが適用されるリージョンの ID。	cn-hangzhou
CenId	string	Cloud Enterprise Network (CEN) インスタンスの ID。	cen-wx12mmlt17ld82****
Priority	integer	ルートマップの優先度。値が小さいほど優先度が高くなります。	5000
TransitRouterRouteTableId	string	ルートマップに関連付けられたトランジットルーターのルートテーブルの ID。	vtb-gw8nx3515m1mbd1z1****
CommunityOperateMode	string	Community 属性に対して実行する操作。有効な値: Additive: ルートに Community 属性を追加します。 Replace: ルートの既存の Community 属性を置き換えます。このパラメーターは、ルートが一致条件に合致した後に実行する操作を指定します。	Additive
MapResult	string	すべての一致条件に合致するルートに対して実行する操作。有効な値: Permit: 一致したルートの通過を許可します。 Deny: 一致したルートを拒否します。	Deny
CommunityMatchMode	string	Community 属性の一致モード。有効な値: Include: あいまい一致。ルートの Community 属性が一致条件で指定された Community 属性と重複する場合、ルートは条件に一致します。 Complete: 完全に一致。ルートの Community 属性が一致条件で指定された Community 属性と同じである場合にのみ、ルートは条件に一致します。	Include
Description	string	ルートマップの説明。	desctest
AsPathMatchMode	string	AS パスリストの一致モード。有効な値: Include: あいまい一致。ルートの AS パスが一致条件で指定された AS パスと重複する場合、ルートは条件に一致します。 Complete: 完全に一致。ルートの AS パスが一致条件で指定された AS パスと同じである場合にのみ、ルートは条件に一致します。	Include
Preference	integer	変更済みのルートの優先度。値が小さいほど優先度が高くなります。このパラメーターは、ルートが一致条件に合致した後に実行する操作を指定します。	20
DestinationInstanceIdsReverseMatch	boolean	宛先インスタンス ID リストに逆再生モードが使用されているかどうかを示します。 false: 逆再生モードは使用されていません。ルートの宛先インスタンス ID が DestinationInstanceIds.N に含まれている場合、ルートは条件に一致します。 true: 逆再生モードが使用されています。ルートの宛先インスタンス ID が DestinationInstanceIds.N に含まれていない場合、ルートは条件に一致します。	false
CidrMatchMode	string	プレフィックスリストの一致モード。有効な値: Include: あいまい一致。一致条件のルートプレフィックスが、一致対象のルートのルートプレフィックスを含む場合、ルートは条件に一致します。例えば、一致条件を 10.10.0.0/16 に設定した場合、プレフィックスが 10.10.1.0/24 のルートは条件に一致します。 Complete: 完全に一致。一致条件のルートプレフィックスが、一致対象のルートのルートプレフィックスと同じである場合にのみ、ルートは条件に一致します。例えば、一致条件を 10.10.0.0/16 に設定した場合、プレフィックスが 10.10.0.0/16 のルートのみが条件に一致します。	Include
NextPriority	integer	次に関連付けられるルートマップの優先度。	33
MatchAddressType	string	ルートが一致する必要のある IP アドレスタイプ。有効な値: IPv4: IPv4 ルートのみと一致します。 IPv6: IPv6 ルートのみと一致します。この値が返されない場合、IPv4 と IPv6 の両方のルートが一致対象となります。	IPv4
SourceRegionIds	object
SourceRegionId	array	ルートが一致する必要のあるソースリージョン ID のリスト。
	string	ルートが一致する必要のあるソースリージョン ID のリスト。	cn-hangzhou
SourceChildInstanceTypes	object
SourceChildInstanceType	array	ルートが一致する必要のあるソースインスタンスタイプのリスト。有効な値: VPC: 仮想非公開クラウド (VPC) インスタンス。 VBR: 仮想罫線ルーター (VBR) インスタンス。 CCN: Cloud Connect Network (CCN) インスタンス。 VPN: IPsec 接続。
	string	ルートが一致する必要のあるソースインスタンスタイプのリスト。有効な値: VPC: 仮想非公開クラウド (VPC) インスタンス。 VBR: 仮想罫線ルーター (VBR) インスタンス。 CCN: Cloud Connect Network (CCN) インスタンス。 VPN: IPsec 接続。	VPC
DestinationRouteTableIds	object
DestinationRouteTableId	array	ルートが一致する必要のある送信先ルートテーブル ID のリスト。最大値 32 個のルートテーブル ID がサポートされています。説明送信先ルートテーブル ID リストは、ルートマップがリージョナルゲートウェイからのアウトバウンド方向に適用され、かつ送信先ルートテーブル ID がローカルリージョンのネットワークインスタンスに属する場合にのみ効果が有効になります。
	string	ルートが一致する必要のある送信先ルートテーブル ID のリスト。最大値 32 個のルートテーブル ID がサポートされています。説明送信先ルートテーブル ID リストは、ルートマップがリージョナルゲートウェイからのアウトバウンド方向に適用され、かつ送信先ルートテーブル ID がローカルリージョンのネットワークインスタンスに属する場合にのみ効果が有効になります。	vtb-adefrgtr144vf****
SourceInstanceIds	object
SourceInstanceId	array	ルートが一致する必要のあるソースインスタンス ID のリスト。
	string	ルートが一致する必要のあるソースインスタンス ID のリスト。	vpc-adeg3544fdf34vf****
DestinationCidrBlocks	object
DestinationCidrBlock	array	ルートが一致する必要のあるプレフィックスリスト。 IPv4 および IPv6 の両方の形式がサポートされています。
	string	ルートが一致する必要のあるプレフィックスリスト。 IPv4 および IPv6 の両方の形式がサポートされています。	10.10.10.0/24
DestinationRegionIds	object
DestinationRegionId	array	ルートマップのターゲットリージョン ID のリスト。
	string	ルートマップのターゲットリージョン ID のリスト。	cn-beijing
SourceRouteTableIds	object
SourceRouteTableId	array	ルートが一致する必要のあるソースルートテーブル ID のリスト。
	string	ルートが一致する必要のあるソースルートテーブル ID のリスト。	vtb-adfr233vf34rvd4****
MatchCommunitySet	object
MatchCommunity	array	ルートが一致する必要のある Community セット。
	string	ルートが一致する必要のある Community セット。	65501:1
PrependAsPath	object
AsPath	array	リージョナルゲートウェイがルートエントリを受信または公開する際にプリペンドされる AS パス。このパラメーターは、ルートが一致条件に合致した後に実行する操作を指定します。
	string	リージョナルゲートウェイがルートエントリを受信または公開する際にプリペンドされる AS パス。このパラメーターは、ルートが一致条件に合致した後に実行する操作を指定します。	65501
RouteTypes	object
RouteType	array	ルートが一致する必要のあるルーティングタイプのリスト。有効な値: System: システムによって自動的に生成されるシステムルート。 Custom: ユーザーによって手動で追加されるカスタムルート。 BGP: BGP ルーティングプロトコルを通じて伝播される BGP ルート。
	string	ルートが一致する必要のあるルーティングタイプのリスト。有効な値: System: システムによって自動的に生成されるシステムルート。 Custom: ユーザーによって手動で追加されるカスタムルート。 BGP: BGP ルーティングプロトコルを通じて伝播される BGP ルート。	System
DestinationChildInstanceTypes	object
DestinationChildInstanceType	array	ルートが一致する必要のある宛先インスタンスタイプのリスト。有効な値: VPC: 仮想非公開クラウド (VPC) インスタンス。 VBR: 仮想罫線ルーター (VBR) インスタンス。 CCN: Cloud Connect Network (CCN) インスタンス。 VPN: IPsec 接続。説明宛先インスタンスタイプリストは、ルートマップがリージョナルゲートウェイからのアウトバウンド方向に適用され、かつ宛先インスタンスタイプがローカルリージョンに属する場合にのみ効果が有効になります。
	string	ルートが一致する必要のある宛先インスタンスタイプのリスト。有効な値: VPC: 仮想非公開クラウド (VPC) インスタンス。 VBR: 仮想罫線ルーター (VBR) インスタンス。 CCN: Cloud Connect Network (CCN) インスタンス。 VPN: IPsec 接続。説明宛先インスタンスタイプリストは、ルートマップがリージョナルゲートウェイからのアウトバウンド方向に適用され、かつ宛先インスタンスタイプがローカルリージョンに属する場合にのみ効果が有効になります。	VPC
DestinationInstanceIds	object
DestinationInstanceId	array	ルートが一致する必要のある宛先インスタンス ID のリスト。説明宛先インスタンス ID リストは、ルートマップがリージョナルゲートウェイからのアウトバウンド方向に適用され、かつ宛先インスタンス ID がローカルリージョンに属する場合にのみ効果が有効になります。
	string	ルートが一致する必要のある宛先インスタンス ID のリスト。説明宛先インスタンス ID リストは、ルートマップがリージョナルゲートウェイからのアウトバウンド方向に適用され、かつ宛先インスタンス ID がローカルリージョンに属する場合にのみ効果が有効になります。	vpc-afrfs434465fdf****
MatchAsns	object
MatchAsn	array	ルートが一致する必要のある AS パスリスト。
	string	ルートが一致する必要のある AS パスリスト。	65501
OperateCommunitySet	object
OperateCommunity	array	操作が実行される Community セット。
	string	操作が実行される Community セット。	65501:1

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "24CE1987-D1D1-5324-9BAD-2750B60E6ABB",
  "PageNumber": 1,
  "TotalCount": 1,
  "RouteMaps": {
    "RouteMap": [
      {
        "RouteMapId": "cenrmap-y40mxdvf7joc12****",
        "Status": "Active",
        "TransmitDirection": "RegionOut",
        "SourceInstanceIdsReverseMatch": false,
        "CenRegionId": "cn-hangzhou",
        "CenId": "cen-wx12mmlt17ld82****",
        "Priority": 5000,
        "TransitRouterRouteTableId": "vtb-gw8nx3515m1mbd1z1****",
        "CommunityOperateMode": "Additive",
        "MapResult": "Deny",
        "CommunityMatchMode": "Include",
        "Description": "desctest",
        "AsPathMatchMode": "Include",
        "Preference": 20,
        "DestinationInstanceIdsReverseMatch": false,
        "CidrMatchMode": "Include",
        "NextPriority": 33,
        "MatchAddressType": "IPv4",
        "SourceRegionIds": {
          "SourceRegionId": [
            "cn-hangzhou"
          ]
        },
        "SourceChildInstanceTypes": {
          "SourceChildInstanceType": [
            "VPC"
          ]
        },
        "DestinationRouteTableIds": {
          "DestinationRouteTableId": [
            "vtb-adefrgtr144vf****"
          ]
        },
        "SourceInstanceIds": {
          "SourceInstanceId": [
            "vpc-adeg3544fdf34vf****"
          ]
        },
        "DestinationCidrBlocks": {
          "DestinationCidrBlock": [
            "10.10.10.0/24"
          ]
        },
        "DestinationRegionIds": {
          "DestinationRegionId": [
            "cn-beijing"
          ]
        },
        "SourceRouteTableIds": {
          "SourceRouteTableId": [
            "vtb-adfr233vf34rvd4****"
          ]
        },
        "MatchCommunitySet": {
          "MatchCommunity": [
            "65501:1"
          ]
        },
        "PrependAsPath": {
          "AsPath": [
            "65501"
          ]
        },
        "RouteTypes": {
          "RouteType": [
            "System"
          ]
        },
        "DestinationChildInstanceTypes": {
          "DestinationChildInstanceType": [
            "VPC"
          ]
        },
        "DestinationInstanceIds": {
          "DestinationInstanceId": [
            "vpc-afrfs434465fdf****"
          ]
        },
        "MatchAsns": {
          "MatchAsn": [
            "65501"
          ]
        },
        "OperateCommunitySet": {
          "OperateCommunity": [
            "65501:1"
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	Invalid parameter.	パラメーターが無効です。
400	Unauthorized	The AccessKeyId is unauthorized.	アカウントにこの操作を実行する権限がありません。

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

変更履歴

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