すべてのプロダクト
Search
ドキュメントセンター

Cloud Enterprise Network:DescribeCenRouteMaps

最終更新日:Aug 07, 2025

DescribeCenRouteMaps 操作を呼び出して、ルーティング ポリシーの構成を照会できます。

操作説明

今すぐお試しください

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

任意

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

10

CenId

string

必須

クラウド相互接続ネットワーク (CEN) インスタンスの ID。

cen-wx12mmlt17ld82****

RouteMapId

string

任意

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

cenrmap-y40mxdvf7joc12****

CenRegionId

string

任意

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

子インスタンスリージョンの照会 (DescribeChildInstanceRegions) 操作を呼び出して、リージョン ID を照会できます。

cn-hangzhou

TransmitDirection

string

任意

ルーティング ポリシーが適用される方向。有効な値:

  • RegionIn: インバウンド。ルーティング ポリシーは、リージョンのゲートウェイにアドバタイズされるルートに適用されます。

たとえば、現在のリージョンのネットワーク インスタンスから現在のリージョンのゲートウェイにルートがアドバタイズされる場合、または他のリージョンからのルートが現在のリージョンのゲートウェイにアドバタイズされる場合。

  • RegionOut: アウトバウンド。ルーティング ポリシーは、リージョンのゲートウェイからアドバタイズされるルートに適用されます。

たとえば、現在のリージョンのゲートウェイから現在のリージョンのネットワーク インスタンス、または他のリージョンのゲートウェイにルートがアドバタイズされる場合。

RegionOut

TransitRouterRouteTableId

string

任意

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

vtb-gw8nx3515m1mbd1z1****

レスポンスパラメーター

パラメーター

タイプ

説明

object

レスポンス。

PageSize

integer

ページごとに返されるエントリの数。

10

RequestId

string

リクエスト ID。

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

PageNumber

integer

ページ番号。

1

TotalCount

integer

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

1

RouteMaps

object

RouteMap

array<object>

ルーティング ポリシーのリスト。

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

CEN インスタンスの ID。

cen-wx12mmlt17ld82****

Priority

integer

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

5000

TransitRouterRouteTableId

string

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

vtb-gw8nx3515m1mbd1z1****

CommunityOperateMode

string

コミュニティに対して実行されるアクション。

  • Additive: コミュニティをルートに追加します。

  • Replace: ルートの元のコミュニティを置き換えます。

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

Additive

MapResult

string

すべての一致条件が満たされた後に実行されるアクション。

  • Permit: 一致するルートを許可します。

  • Deny: 一致するルートを拒否します。

Deny

CommunityMatchMode

string

コミュニティの一致モード。

  • Include: あいまい一致。ルートのコミュニティが一致条件のコミュニティと重複する場合、一致は成功です。

  • Complete: 完全一致。ルートのコミュニティが一致条件のコミュニティと同じである場合にのみ、一致は成功です。

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: クラウド相互接続ネットワーク (CCN)。

  • VPN: IPsec 接続。

string

一致させるソース インスタンス タイプのリスト。

  • VPC: VPC。

  • VBR: VBR。

  • CCN: CCN。

  • VPN: IPsec 接続。

VPC

DestinationRouteTableIds

object

DestinationRouteTableId

array

一致させる宛先ルートテーブル ID のリスト。最大 32 個のルートテーブル ID を入力できます。

説明

このパラメータは、ルーティング ポリシーがリージョン ゲートウェイのアウトバウンド方向に適用され、宛先ルートテーブルが現在のリージョンのネットワーク インスタンスに属している場合にのみ有効になります。

string

一致させる宛先ルートテーブル ID のリスト。最大 32 個のルートテーブル 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

一致させるコミュニティ。

string

一致させるコミュニティ。

65501:1

PrependAsPath

object

AsPath

array

リージョン ゲートウェイがルートを受信またはアドバタイズするときに付加される AS パス。

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

string

リージョン ゲートウェイがルートを受信またはアドバタイズするときに付加される AS パス。

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

65501

RouteTypes

object

RouteType

array

一致させるルート タイプのリスト。

  • System: システムによって自動的に生成されるシステム ルート。

  • Custom: 手動で追加されるカスタム ルート。

  • BGP: ボーダー ゲートウェイ プロトコル (BGP) を介してアドバタイズされるルート。

string

一致させるルート タイプのリスト。

  • System: システムによって自動的に生成されるシステム ルート。

  • Custom: 手動で追加されるカスタム ルート。

  • BGP: BGP を介してアドバタイズされるルート。

System

DestinationChildInstanceTypes

object

DestinationChildInstanceType

array

一致させる宛先インスタンス タイプのリスト。

  • VPC: VPC。

  • VBR: VBR。

  • CCN: CCN。

  • VPN: IPsec 接続。

説明

このパラメータは、ルーティング ポリシーがリージョン ゲートウェイのアウトバウンド方向に適用され、宛先インスタンスが現在のリージョンにある場合にのみ有効になります。

string

一致させる宛先インスタンス タイプのリスト。

  • VPC: VPC。

  • VBR: VBR。

  • CCN: CCN。

  • VPN: IPsec 接続。

説明

このパラメータは、ルーティング ポリシーがリージョン ゲートウェイのアウトバウンド方向に適用され、宛先インスタンスが現在のリージョンにある場合にのみ有効になります。

VPC

DestinationInstanceIds

object

DestinationInstanceId

array

一致させる宛先インスタンス ID のリスト。

説明

このパラメータは、ルーティング ポリシーがリージョン ゲートウェイのアウトバウンド方向に適用され、宛先インスタンスが現在のリージョンにある場合にのみ有効になります。

string

一致させる宛先インスタンス ID のリスト。

説明

このパラメータは、ルーティング ポリシーがリージョン ゲートウェイのアウトバウンド方向に適用され、宛先インスタンスが現在のリージョンにある場合にのみ有効になります。

vpc-afrfs434465fdf****

MatchAsns

object

MatchAsn

array

一致させる AS パスのリスト。

string

一致させる AS パスのリスト。

65501

OperateCommunitySet

object

OperateCommunity

array

操作対象のコミュニティ。

string

操作対象のコミュニティ。

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.

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

変更履歴

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