vRouter または仮想ボーダールータ (VBR) のルートテーブルにカスタムルートエントリーを追加します。
使用上の注意
- CreateRouteEntry は非同期操作です。リクエストが送信されると、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。DescribeRouteEntryList を呼び出して、タスクのステータスをクエリできます。
- ルートエントリーが Creating 状態の場合、ルートエントリーは追加中です。
- ルートエントリーが Created 状態の場合、ルートエントリーは追加済みです。
- 特定の期間内に CreateRouteEntry を繰り返し呼び出すことはできません。
- ルートテーブルには、最大 200 のカスタムルートエントリーを含めることができます。
- カスタムルートエントリーの宛先 CIDR ブロック (DestinationCidrBlock) は、VPC 内の vSwitch の CIDR ブロックと同じにすることはできません。vSwitch の CIDR ブロックを含めることはできますが、vSwitch の CIDR ブロックに含まれることはできません。
- カスタムルートエントリーの宛先 CIDR ブロック (DestinationCidrBlock) は、100.64.0.0/10 を指すことも、100.64.0.0/10 に含まれることもできません。
- 同じルートテーブル内のルートエントリーの宛先 CIDR ブロック (DestinationCidrBlock) は異なっている必要があります。
- 宛先 CIDR ブロック (DestinationCidrBlock) を指定するときにマスク長を含めない場合、宛先 CIDR ブロックはマスク長が 32 ビットのホスト IP アドレスと見なされます。
- 複数カスタムルートエントリーが同じネクストホップ (NextHopId) を指すことができます。
- カスタムルートエントリーのネクストホップ (NextHopId) とルートテーブルは、同じ VPC に属している必要があります。
- NextHopList を指定することで、等コストマルチパス (ECMP) ルーティングを設定できます。
- 標準 (非 ECMP) カスタムルートエントリーを追加する場合は、DestinationCidrBlock、NextHopType、および NextHopId を指定する必要があります。NextHopList は指定できません。
- ECMP ルートエントリーを追加する場合は、DestinationCidrBlock と NextHopList を指定する必要があります。NextHopType または NextHopId は指定できません。
- ルートテーブルには、最大 200 のカスタムルートエントリーを含めることができます。
- NextHopList はサポートされていません。
- カスタムルートエントリーの宛先 CIDR ブロック (DestinationCidrBlock) は、100.64.0.0/10 を指すことも、100.64.0.0/10 に含まれることもできません。
- 同じルートテーブル内のルートエントリーの宛先 CIDR ブロック (DestinationCidrBlock) は異なっている必要があります。
- 宛先 CIDR ブロック (DestinationCidrBlock) を指定するときにマスク長を含めない場合、宛先 CIDR ブロックはマスク長が 32 ビットのホスト IP アドレスと見なされます。
- 複数カスタムルートエントリーが同じネクストホップ (NextHopId) を指すことができます。
- カスタムルートエントリーのネクストホップ (NextHopId) は、VBR に関連付けられたルーターインターフェースである必要があります。
- VBR は アクティブ 状態である必要があり、VBR に関連付けられた Express Connect 回線は 有効 状態である必要があります。 Express Connect 回線に支払い遅延がないことを確認してください。
- 標準 (非 ECMP) ルートエントリーのみを追加できます。DestinationCidrBlock、NextHopType、および NextHopId を指定する必要があります。NextHopList は指定できません。
デバッグ
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
Action | String | Yes | CreateRouteEntry | 実行する操作。値を CreateRouteEntry に設定します。 |
RegionId | String | No | cn-hangzhou | ルートテーブルのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。 |
RouteTableId | String | Yes | vtb-bp145q7glnuzd**** | カスタムルートエントリーを追加するルートテーブルの ID。 |
DestinationCidrBlock | String | Yes | 192.168.0.0/24 | カスタムルートエントリーの宛先 CIDR ブロック。IPv4 と IPv6 の両方の CIDR ブロックがサポートされています。宛先 CIDR ブロックが次の要件を満たしていることを確認してください。
|
NextHopId | String | No | i-j6c2fp57q8rr4jlu**** | カスタムルートエントリーのネクストホップの ID。 |
ClientToken | String | No | 02fb3da4-130e-11e9-8e44-001**** | リクエストのべき等性を確保するために使用されるクライアントトークン。 クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。 説明 このパラメーターを指定しない場合、システムは リクエスト ID を クライアントトークン として自動的に使用します。リクエスト ID はリクエストごとに異なる場合があります。 |
RouteEntryName | String | No | test | 追加するカスタムルートエントリーの名前。 名前は 1 ~ 128 文字である必要があります。名前は |
Description | String | No | test | カスタムルートエントリーの説明。 説明は 1 ~ 256 文字である必要があります。説明は |
NextHopType | String | No | RouterInterface | カスタムルートエントリーのネクストホップのタイプ。有効な値:
|
NextHopList.N.NextHopId | String | No | ri-2zeo3xzyf3cd8r4**** | ECMP ルートエントリーのネクストホップの ID。 |
NextHopList.N.Weight | Integer | No | 10 | ECMP ルートエントリーのネクストホップの重み。 |
NextHopList.N.NextHopType | String | No | RouterInterface | ECMP ルートエントリーのネクストホップのタイプ。値を RouterInterface に設定します。 |
レスポンスパラメーター
パラメーター | タイプ | 例 | 説明 |
RouteEntryId | String | rte-sn6vjkioxte1gz83z**** | カスタムルートエントリーの ID。 |
RequestId | String | 0ED8D006-F706-4D23-88ED-E11ED28DCAC0 | リクエスト ID。 |
例
リクエストの例
http(s)://[Endpoint]/?Action=CreateRouteEntry
&RegionId=cn-hangzhou
&RouteTableId=vtb-bp145q7glnuzd****
&DestinationCidrBlock=192.168.0.0/24
&NextHopId=i-j6c2fp57q8rr4jlu****
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&RouteEntryName=test
&Description=test
&NextHopType=RouterInterface
&NextHopList=[{"NextHopId":"ri-2zeo3xzyf3cd8r4****","Weight":10,"NextHopType":"RouterInterface"}]
&共通リクエストパラメーター
正常なレスポンスの例
XML
形式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateRouteEntryResponse>
<RouteEntryId>rte-sn6vjkioxte1gz83z****</RouteEntryId>
<RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
</CreateRouteEntryResponse>
JSON
形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RouteEntryId" : "rte-sn6vjkioxte1gz83z****",
"RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}
エラーコード
HttpCode | エラーコード | エラーメッセージ | 説明 |
400 | IllegalParam.CidrBlock | The specified CidrBlock is illegal. | CidrBlock に無効な値が設定されています。 |
400 | QuotaExceeded | Route entry quota exceeded in this route table. | ルートテーブル内のルートエントリーの数が上限に達しました。 |
400 | MissingParameter | Miss mandatory parameter. | 1 つ以上の必須パラメーターが設定されていません。この操作を呼び出す前に、すべての必須パラメーターを設定したかどうかを確認してください。 |
400 | InvalidCidrBlock.Malformed | Specified CIDR block is not valid. | 指定された CIDR ブロックの形式が無効です。 |
400 | InvalidCIDRBlock.Duplicate | Specified CIDR block is already exists. | 指定された CIDR ブロックはルートテーブルに既に存在します。 |
400 | IncorrectVpcStatus | Current VPC status does not support this operation. | VPC が現在の状態の場合、この操作を実行できません。 |
400 | IncorrectInstanceStatus | Current instance status does not support this operation. | インスタンスが現在の状態である間は、この操作を実行できません。 |
400 | IncorrectRouteEntryStatus | Some route entry status blocked this operation. | 現在のルートテーブル内の 1 つ以上のルートエントリーが Pending または Modifying 状態です。 |
400 | IncorrectVSwitchStatus | The current virtual switch status does not support this operation. | vSwitch は Pending 状態であるため、削除できません。 |
400 | InvalidCidrBlock | Specified CIDR block is not valid. | 次のいずれかの理由で返されるエラーメッセージ:1. 10.0.0.0/8 CIDR ブロックを使用する権限がありません。アカウントが CIDR ブロックを使用するためのホワイトリストに含まれているかどうかを確認してください。2. 追加されたカスタムルートエントリーの宛先 CIDR ブロックは、VPC 内の vSwitch の CIDR ブロックのサブセットにすることはできません。3. CIDR ブロックは 100.64.0.0/10 にすることはできません。 |
400 | InvalidNextHopType | Specified parameter "NextHopType" is not valid | 指定されたネクストホップタイプが無効です。 |
400 | InvalidNextHop.NotFound | Specified next hop does not exist. | 指定されたネクストホップは存在しません。 |
400 | InvalidVRouter.NotFound | vRouter not exists. | 指定された vRouter は存在しません。指定された vRouter が有効かどうかを確認してください。 |
400 | InvalidVPC.NotFound | vpc not exists. | 指定された VPC は存在しません。指定された VPC が有効かどうかを確認してください。 |
400 | InvalidNexthopTypeAndList.BothNull | both nexthopType and nextHopList are null. | NextHopType と NextHopList が指定されていません。 |
400 | InvalidNexthopTypeAndList.BothNotNull | both nexthopType and nextHopList are not null. | NextHopType と NextHopList の両方を空にすることはできません。 |
400 | InvalidRouterInterface | invalid router interface. | 指定されたルーターインターフェースは存在しません。 |
400 | InvalidOppositeRouterType | nexthop list cannot only contain router interface whose opposite router interface is on vbr. | 指定されたネクストホップが無効です。ネクストホップとして指定するルーターインターフェースのピアルーターは VBR である必要があります。 |
400 | InvalidNexthopListSize | nexthop size is illegal. Must be between 2 and 4. | ネクストホップとして 2 ~ 4 つのルーターインターフェースを指定する必要があります。 |
400 | InvalidEntryRuleQuota.NotFound | Route entry quota rule not exists. | ルートエントリーのクォータルールが存在しません。 |
400 | Forbidden.CheckEntryRuleQuota | Route entry quota rule check error. | ルートエントリーのクォータを確認中にエラーが発生しました。 |
400 | InvalidVBRStatus | invalid virtual border router status. | VBR が無効な状態です。 |
400 | InvalidPhysicalConnectionBusinessStatus | invalid physical connection business status. | Express Connect 回線が無効な状態です。 |
400 | IncorrectHaVipStatus | This operation is denied because satus of the specified HaVip is neither Available nor InUse. | 指定された HAVIP が Available または InUse 状態の場合、操作を実行できません。 |
400 | CountLimitExceed.HaVipRouteEntry | There can be 5 route entry to HaVip at most in one route table. | HAVIP を指すルートエントリーの数が上限に達しました。 |
400 | InvalidRouteEntry.Duplicate | The route entry already exist. | 指定されたルートエントリーは既に存在します。 |
400 | IncorrectRouteEntryStatus | Specified routeEntry status error. | 現在のルートテーブル内の 1 つ以上のルートエントリーが Pending または Modifying 状態です。 |
400 | IncorrectRouteEntryStatus | VBR has NotStable route entry. | 現在の VBR 内の 1 つ以上のルートエントリーが Pending または Modifying 状態です。 |
400 | InvalidParam | The Ecmp routerEntry with router interfaces local vgw vip not match. | ルートエントリーがルーターインターフェースのゲートウェイ IP アドレスと一致しません。 |
400 | INVALID_WEIGHT_PARAM | Specified value of weight invalid | 指定された重みが無効です。 |
400 | FORBIDDEN_USE_VPC_AS_INTERNET_GATEWAY | The Specified CIDR must be in vpc CIDR. | 指定された CIDR ブロックは、VPC CIDR ブロックのサブセットである必要があります。 |
400 | INVALID_VPC_ID | The Specified VpcId not match. | VPC が見つかりません。 |
400 | InvalidRouteEntrySize | The Specified routerEntry size not legal. | ECMP ルーティングを設定する場合は、ネクストホップとして 2 ~ 4 つのルーターインターフェースを指定する必要があります。 |
400 | TaskConflict | The operation is too frequent, please wait a moment and try again. | リクエストが頻繁すぎます。後でもう一度お試しください。 |
400 | InvalidRouteEntry | Specified routeEntry not exist. | 指定されたルートエントリーは存在しません。 |
400 | RouteConflict.AlreadyExist | Route conflict exists in routing table. | ルートテーブルにルートの競合が存在します。 |
400 | InvalidRouteEntryName.Malformed | Specified RouteEntry name is not valid. | ルートエントリーの名前が無効です。 |
400 | InvalidNexthop.DirectEni | The direct Eni cannot be nexthop. | EIP 可視モードの ENI をネクストホップとして指定することはできません。 |
400 | QuotaExceeded.VpnRouteEntry | Vpn route entry quota exceeded. | ルートエントリーを作成できませんでした。VPN ゲートウェイルートテーブル内のルートエントリーの数が上限に達しているかどうかを確認してください。 |
400 | InvalidAttachment.NotFound | The attachment is not found. | 指定された転送ルータは存在しません。 |
400 | OperationFailed.ActiveNetworkInterfaceNotFound | No active network interface is found on the attachment. | 指定された転送ルータで利用可能な ENI がありません。 |
400 | InvalidNetworkInterface.NotFound | The network interface is not found on the attachment. | 指定された転送ルータに関連付けられている ENI がありません。 |
400 | OperationFailed.QueryAttachmentInfo | Failed to query attachment information. | 転送ルータをクエリできませんでした。 |
400 | IllegalParam.AttachmentId | The attachment is invalid. | 指定された転送ルータが無効です。 |
400 | OperationFailed.NotSupportIPV6 | The specified next hop does not support IPv6. | 指定されたネクストホップは IPv6 をサポートしていません。 |
400 | IncorrectStatus.Ipv6Address | The IPv6 address of the specified next hop is being assigned or deleted. | ネクストホップに IPv6 アドレスが割り当てられているか、削除されています。 |
400 | OperationUnsupported.Ipv6EntryOnPrimaryNetworkInterface | You cannot create IPv6 route entries on a primary network interface. | ネクストホップがプライマリ ENI である IPv6 ルートエントリーを作成することはできません。 |
400 | OperationUnsupported.SpecifyIpOnIpv6Entry | You cannot specify the private IP address when you create IPv6 route entries. | 宛先 CIDR ブロックとしてプライベート IPv6 アドレスを指定することはできません。 |
400 | OperationUnsupported.MutipleIpv6Address | You cannot specify a next hop that has bound multiple IPv6 addresses. | 複数の IPv6 アドレスが割り当てられているネクストホップを指定することはできません。 |
400 | OperationDenied.Ipv6EntryOnCustomTable | You cannot create any IPv6 route entry on a custom route table. | カスタムルートテーブルに IPv6 ルートエントリーを追加することはできません。 |
400 | OperationDenied.CloudBoxVbrEntryAllowedInCustomRouteTable | The operation is not allowed because only the custom routing table can add a routing entry with the next hop pointing to the cloud box type VBR. | ルートエントリーのネクストホップが CloudBox に接続された VBR を指している場合にのみ、カスタムルートテーブルにルートエントリーを追加できます。 |
400 | OperationDenied.RouteTableAssociateNotCloudBoxVSwitch | The operation is not allowed because of the routing table is bound to a non-cloud box type vswitch, and routing entries pointing to the cloud box VBR cannot be added. | ルートテーブルが関連付けられている vSwitch は CloudBox インスタンスに接続されていません。そのため、CloudBox インスタンスに接続された VBR を指すルートエントリーを追加することはできません。 |
400 | OperationDenied.VbrMisMatchCloudBox | The operation is not allowed because the routing table is bound to a cloud box vswitch, and routing entries pointing to other cloud box VBRs cannot be added. | VBR とルートテーブルに関連付けられている vSwitch は、異なる CloudBox インスタンスに接続されています。 |
400 | OperationDenied.VbrIdle | The operation is not allowed because the next hop of the added routing entry is a VBR type RI at the opposite end, which cannot be in an idle state. | ネクストホップとして指定するルーターインターフェースはアイドル状態です。ネクストホップルーターインターフェースのピアルーターが VBR の場合、ネクストホップルーターインターフェースはアイドル状態であってはなりません。 |
400 | OperationDenied.RouterInterfaceToDifferentVpc | The operation is not allowed because the router interface is connected to different VPCs. | ECMP ルーティングを設定するときにネクストホップとして指定するルーターインターフェースは、同じ VPC に属していません。 |
400 | OperationDenied.RouterInterfaceFromDifferentZones | The operation is not allowed because the router interface resides in different zones. | ルーターインターフェースは異なるゾーンに属しています。 |
400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | 送信データ転送課金が無効になっています。 |
400 | ResourceNotFound.VpcPeer | The specified resource of %s is not found. | VPC ピアリング接続が見つかりません。 |
400 | OperationDenied.RouteTableTypeNotPermitted | The operation is not allowed because the type of route table is not permitted. | 指定されたタイプのルートテーブルにルートエントリーを追加することはできません。 |
400 | OperationDenied.GatewayRouteTableNotPermitted | The operation is not allowed to create a route pointing to this nextHop type on gateway route table. | ゲートウェイルートテーブルは、指定されたインスタンスタイプを指すルートエントリーをサポートしていません。 |
400 | UnsupportedFeature.VpcPeerIpv6 | IPv6 route entries for VPC peering connections cannot be created in this region. | ルーターインターフェースのピアは VPC であり、このリージョンにネクストホップタイプが IPv6 アドレスであるルートを作成することはできません。 |
400 | OperationDenied.VpcIpv6NotEnabled | IPv6 has not been enabled for the VPC. | VPC は IPv6 をサポートしておらず、操作は拒否されます。 |
400 | IncorrectStatus.Ipv4Gateway | The status of Ipv4Gateway is incorrect. | IPv4 ゲートウェイが不安定です。 |
400 | ResourceNotFound.PrefixList | The specified resource of prefixList is not found. | プレフィックスリストが存在しません。 |
400 | UnsupportedFeature.CreatePrefixListEcmpRouteEntry | The feature of creating ecmp route entry with prefixList is not supported. | プレフィックスリストを使用して ECMP ルートを作成することはできません。 |
400 | OperationDenied.RouterInterfaceIpv6NotEnabled | Routerinterface does not support IPv6. | ルーターインターフェースが IPv6 をサポートしていないため、操作に失敗しました。 |
400 | OperationDenied.NextHopTypeNotPermitted | The operation is not allowed because the nextHop type is invalid. | このタイプのネクストホップを持つルートを作成することはできません。 |
400 | ResourceAlreadyAssociated.PrefixList | The operation failed because the specified prefixList route entry already exists. | 指定されたプレフィックスlistru-toエントリが既に存在するため、操作に失敗しました。 |
400 | OperationFailed.CidrConflictWithPrefixList | The specified CIDR block already exists in a prefixList route entry. | ルートは既存のプレフィックスlistru-toと競合しています。 |
400 | ResourceNotFound.Ipv4Gateway | Specified Ipv4Gateway does not exist. | 指定された IPv4 ゲートウェイが見つかりません。 |
400 | Mismatch.HaVipIdAndRouteTableId | The HaVip and RouteTable are mismatched. | 指定された HAVIP とルートテーブルは同じ VPC に属していません。 |
400 | OperationFailed.OperationLocked | The operation failed because the nextHop instance is in the O&M lock state. | ネクストホップインスタンスが O&M ロック状態であるため、操作に失敗しました。 |
400 | Mismatch.Ipv4GatewayIdAndRouteTableId | The specified IPv4Gateway and RouteTable are not matched. | IPv4 ゲートウェイとルートテーブルが同じ VPC に属していないため、操作に失敗しました。 |
400 | OperationUnsupported.DestinationCidrBlockOverlapWithVSwitch | The destination IPv6 network segment specified in the route entry overlaps with the vSwitch network segment. | ルートで指定された宛先 IPv6 ネットワークセグメントは、vSwitch ネットワークセグメントと重複しています。 |
403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | 指定されたリソースは、操作をサポートしていない状態です。 |
404 | InvalidInstanId.NotFound | Specified instance does not exist. | 指定されたインスタンスは存在しません。インスタンス ID が有効かどうかを確認してください。 |
404 | InvalidNextHopId.NotFound | Specified next hop does not exist. | 指定されたネクストホップは存在しません。 |
404 | InvalidRouteTableId.NotFound | Specified route table does not exist. | ルートテーブルが見つかりません。 |
404 | InvalidHaVipId.NotFound | The specified HaVip does not exist in the specified VPC. | 指定された HAVIP は VPC に存在しません。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部エラーが発生しました。 |
エラーコードの一覧については、「サービスエラーコード」をご参照ください。