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

VPC の vRouter のルートテーブルに、複数のカスタムルートエントリをバッチで作成します。

操作説明

CreateRouteEntries は非同期オペレーションです。このオペレーションを呼び出すと、リクエスト ID とルートエントリーの ID が返されますが、ルートはまだ作成されていません。システムはバックグラウンドで作成タスクを実行しています。DescribeRouteEntryList を呼び出して、ルートの作成ステータスを照会できます：
- ルートの状態が 作成中 の場合、ルートは作成中です。
- ルートの状態が 作成済み の場合、ルートは作成されています。
CreateRouteEntries は、同一 VPC 内でのカスタムルートエントリーの同時バッチ作成をサポートしていません。

このオペレーションを使用して VPC 内の vRouter のルートテーブルにカスタムルートエントリーを追加する際は、次の点にご注意ください：

ルートテーブルには、最大 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 を呼び出して、リージョン ID を取得できます。	cn-hangzhou
RouteEntries	array<object>	必須	ルートエントリ情報のリストです。
	object	任意	ルートエントリ情報のリストです。
Description	string	任意	カスタムルートエントリの説明です。最大 50 件の説明を指定できます。説明は 1～256 文字で、 `http://` または `https://` で始めることはできません。	test
DstCidrBlock	string	必須	カスタムルートエントリの送信先 CIDR ブロックです。 IPv4 と IPv6 の送信先 CIDR ブロックに対応しています。最大 50 個の送信先 CIDR ブロックを指定できます。次の要件を満たす必要があります：宛先 CIDR ブロックは 100.64.0.0/10 を指すことはできません。また、100.64.0.0/10 に含まれることもできません。同一ルートテーブル内の異なるルートエントリの宛先 CIDR ブロックは一意である必要があります。	192.168.0.0/24
IpVersion	integer	任意	IP プロトコルのバージョンです。最大 50 個の IP プロトコルバージョンを指定できます。有効な値： 4：IPv4。 6：IPv6。	4
Name	string	任意	追加するカスタムルートエントリの名前です。最大 50 個の名前を指定できます。名前は 1～128 文字で、 `http://` または `https://` で始めることはできません。	test
NextHop	string	必須	カスタムルートエントリのネクストホップインスタンスの ID です。最大 50 個のインスタンス ID を指定できます。説明 NextHopType に Ecr を設定した場合、DescribeExpressConnectRouterAssociation API を呼び出して、ネクストホップ ID として AssociationId を取得できます。	i-j6c2fp57q8rr4jlu****
NextHopType	string	必須	カスタムルートエントリのネクストホップタイプです。最大 50 個のネクストホップタイプを指定できます。有効な値： Instance (デフォルト) ：ECS インスタンス。 HaVip：高可用性 (HA) 仮想 IP アドレス。 RouterInterface：vRouter インターフェイス。 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：ゲートウェイロードバランサーエンドポイント (GWLBe)。 RouteTargetGroup：ターゲットグループ。	RouterInterface
RouteTableId	string	必須	カスタムルートエントリを追加するルートテーブルの ID です。最大 50 個のルートテーブル ID を指定できます。	vtb-bp145q7glnuzd****
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true：ルートエントリを作成するリクエストを送信せずに、ドライランを実行します。システムは AccessKey ペア、Resource Access Management (RAM) ユーザーの権限、および必須パラメータを確認します。確認に失敗した場合は、該当するエラーが返されます。確認に成功した場合は、エラーコード `DryRunOperation` が返されます。 false (デフォルト) ：通常のリクエストを送信します。確認に成功した場合、2xx の HTTP ステータスコードが返され、指定されたルートエントリが作成されます。

レスポンスフィールド

フィールド	型	説明	例
	object	操作のレスポンスデータです。
FailedCount	integer	追加に失敗したルートエントリ数です。	2
FailedRouteEntries	array<object>	追加に失敗したルートエントリの詳細です。
	object	追加に失敗したルートエントリの詳細です。
DstCidrBlock	string	追加に失敗したカスタムルートエントリの宛先 CIDR ブロックです。	192.168.0.0/24
FailedCode	string	失敗時のエラーコードです。	VPC_ROUTE_ENTRY_CIDR_BLOCK_DUPLICATE
FailedMessage	string	失敗時のエラーメッセージです。	指定された CIDR ブロックは既に存在します。entry.cidrBlock=xxxx
NextHop	string	追加に失敗したカスタムルートエントリのネクストホップインスタンス ID です。	i-j6c2fp57q8rr4jlu****
RequestId	string	リクエスト ID です。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
RouteEntryIds	array	正常に追加されたカスタムルートエントリのインスタンス ID の配列です。
	string	正常に追加されたカスタムルートエントリのインスタンス ID です。	rte-sn6vjkioxte1gz83z****
SuccessCount	integer	正常に追加されたルートエントリ数です。	2

例

成功レスポンス

JSONJSON

{
  "FailedCount": 2,
  "FailedRouteEntries": [
    {
      "DstCidrBlock": "192.168.0.0/24",
      "FailedCode": "VPC_ROUTE_ENTRY_CIDR_BLOCK_DUPLICATE",
      "FailedMessage": "指定された CIDR ブロックは既に存在します。entry.cidrBlock=xxxx",
      "NextHop": "i-j6c2fp57q8rr4jlu****"
    }
  ],
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "RouteEntryIds": [
    "rte-sn6vjkioxte1gz83z****"
  ],
  "SuccessCount": 2
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun チェックに合格しました。
400	InvalidCIDRBlock.Duplicate	Specified CIDR block is already exists.
400	MissingParam.RouteTableId	The parameter RouteTableId is missing.	必須パラメーター RouteTableId が指定されていません。
400	IncorrectStatus.PrefixListRelation	The related prefix list relation is in an intermediate state and cannot perform the current operation.

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

変更履歴

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