CreateRouteEntries - Virtual Private Cloud - Alibaba Cloud ドキュメントセンター

VPC ルーターのルートテーブルに、カスタムルートをバッチで追加します。

操作説明

CreateRouteEntries は非同期操作です。リクエストを送信すると、システムからリクエスト ID が返されますが、操作はバックグラウンドで実行中です。DescribeRouteEntryList を呼び出してルートのステータスを照会できます。
- ルートが Creating 状態の場合、ルートは作成中です。
- ルートが Created 状態の場合、ルートは作成済みです。
CreateRouteEntries では、同じ VPC に対してカスタムルートを追加する同時バッチオペレーションはサポートされていません。

VPC ルーターのルートテーブルにカスタムルートを追加する際は、次の点に注意してください：

ルートテーブルには、最大 200 個のカスタムルートを含めることができます。
カスタムルートの送信先 CIDR ブロック (DstCidrBlock) を、VPC 内の vSwitch の CIDR ブロックと同じにしたり、重複させたり、またはそのサブセットにしたりすることはできません。
カスタムルートの送信先 CIDR ブロック (DstCidrBlock) は、100.64.0.0/10 または 100.64.0.0/10 のサブセットにすることはできません。
同じルートテーブル内のルートの送信先 CIDR ブロック (DstCidrBlock) を同一にすることはできません。
送信先 CIDR ブロック (DstCidrBlock) として指定された IP アドレスは、32 ビットのサブネットマスクで処理されます。
複数のカスタムルートが同じネクストホップ (NextHop) を指すことができます。
カスタムルートのネクストホップ (NextHop) は、ルートテーブルと同じ VPC 内にある必要があります。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:CreateRouteEntries

create

*RouteEntry

acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	ルートテーブルが属するリージョンの ID です。 DescribeRegions API を呼び出すことで、最新のリージョンリストを取得できます。	cn-hangzhou
RegionId	string	必須	The ID of the region where the route table is located. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
RouteEntries	array<object>	必須	ルート情報のリストです。最大 50 個のルートエントリを指定できます。
	object	任意	ルート情報のリストです。
DstCidrBlock	string	必須	カスタムルートの宛先 CIDR ブロックです。IPv4 と IPv6 両方の CIDR ブロックに対応しています。宛先 CIDR ブロックは、次の要件を満たす必要があります：宛先 CIDR ブロックは、100.64.0.0/10 またはそのサブセットであってはなりません。同じルートテーブル内の異なるルートの宛先 CIDR ブロックは、重複させることができません。	192.168.0.0/24
RouteTableId	string	必須	カスタムルートを追加するルートテーブルの ID です。	vtb-bp145q7glnuzd****
IpVersion	integer	任意	IP プロトコルのバージョンです。有効な値： 4 ： IPv4。 6 ： IPv6。	4
NextHop	string	必須	カスタムルートのネクストホップインスタンスの ID です。説明 NextHopType を Ecr に設定した場合、DescribeExpressConnectRouterAssociation API を呼び出して AssociationId を取得し、それをネクストホップ ID として使用します。	i-j6c2fp57q8rr4jlu****
NextHopType	string	必須	カスタムルートのネクストホップのタイプです。有効な値： Instance (デフォルト) ： ECS インスタンス。 HaVip ：高可用性仮想 IP アドレス (HAVIP)。 RouterInterface ：ルーターインターフェイス。 NetworkInterface ： Elastic Network Interface (ENI)。 VpnGateway ： VPN ゲートウェイ。 IPv6Gateway ： IPv6 ゲートウェイ。 NatGateway ： NAT ゲートウェイ。 Attachment ：トランジットルーター。 VpcPeer ： VPC ピアリング接続。 Ipv4Gateway ： IPv4 ゲートウェイ。 GatewayEndpoint ：ゲートウェイエンドポイント。 CenBasic ： CEN はトランジットルーターをサポートしていません。 Ecr ： Express Connect Router (ECR)。 GatewayLoadBalancerEndpoint ： Gateway Load Balancer エンドポイント (GWLBe)。	RouterInterface
Name	string	任意	追加するカスタムルートの名前です。名前は 1～128 文字で、`http://` または `https://` で始めることはできません。	test
Description	string	任意	カスタムルートの説明です。説明は 1～256 文字で、`http://` または `https://` で始めることはできません。	test
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true ：リクエストが有効かどうかをチェックするリクエストを送信します。システムは、アクセスキーが有効か、RAM ユーザーに権限があるか、および必須パラメーターが指定されているかを確認します。リクエストがチェックに失敗した場合、エラーメッセージが返されます。リクエストがチェックに合格した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト) ：通常のリクエストを送信します。リクエストがチェックに合格すると、2xx HTTP ステータスコードが返され、ルートが作成されます。

レスポンスフィールド

フィールド	型	説明	例
	object	応答データです。
SuccessCount	integer	追加に成功したカスタムルートの数です。	2
FailedCount	integer	追加に失敗したカスタムルートの数です。	2
RequestId	string	リクエスト ID です。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
FailedRouteEntries	array<object>	追加に失敗したカスタムルートの詳細です。
	object	追加に失敗したカスタムルートの詳細です。
DstCidrBlock	string	追加に失敗したカスタムルートの送信先 CIDR ブロックです。	192.168.0.0/24
NextHop	string	追加に失敗したカスタムルートのネクストホップ ID です。	i-j6c2fp57q8rr4jlu****
FailedCode	string	エラーコードです。	VPC_ROUTE_ENTRY_CIDR_BLOCK_DUPLICATE
FailedMessage	string	エラーメッセージです。	Specified CIDR block is already exists, entry.cidrBlock=xxxx
RouteEntryIds	array	追加に成功したカスタムルートの ID の配列です。
	string	追加に成功したカスタムルートの ID です。	rte-sn6vjkioxte1gz83z****

例

成功レスポンス

JSONJSON

{
  "SuccessCount": 2,
  "FailedCount": 2,
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "FailedRouteEntries": [
    {
      "DstCidrBlock": "192.168.0.0/24",
      "NextHop": "i-j6c2fp57q8rr4jlu****",
      "FailedCode": "VPC_ROUTE_ENTRY_CIDR_BLOCK_DUPLICATE",
      "FailedMessage": "Specified CIDR block is already exists, entry.cidrBlock=xxxx"
    }
  ],
  "RouteEntryIds": [
    "rte-sn6vjkioxte1gz83z****"
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	InvalidCIDRBlock.Duplicate	Specified CIDR block is already exists.
400	MissingParam.RouteTableId	The parameter RouteTableId is missing.

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

変更履歴

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