vRouter または仮想ボーダールーター (VBR) にカスタムルートエントリを作成します。
操作説明
- CreateRouteEntry 操作は非同期です。リクエストを送信すると、システムはインスタンス ID を返しますが、カスタムルートエントリはまだ作成されていません。システムはバックグラウンドでノードの実行を続けます。 DescribeRouteEntryList を呼び出してルートのステータスをクエリできます:
ルートが Creating 状態の場合、ルートは作成中です。
ルートが Created 状態の場合、ルートは作成済みです。
CreateRouteEntry 操作は、同じ VPC または同じ VBR でのカスタムルートエントリの同時作成をサポートしていません。
CreateRouteEntry 操作は、同時実行シナリオで TaskConflict エラーコードを返す場合があります。必要に応じて操作をリトライしてください。
この操作を使用して vRouter のルートテーブルにカスタムルートエントリを追加する際の注意事項:
追加するルートがプレフィックスリストルートの場合、ルーティングクォータは既存のルートとプレフィックスリストルートの最大値エントリ数の合計に基づいて計算されます。合計はルーティングクォータを超えることはできません。
-
ルートテーブルには最大 200 個のカスタムルートエントリを含めることができます。
-
カスタムルートエントリの送信先 CIDR ブロック (DestinationCidrBlock) は、VPC 内の vSwitch CIDR ブロックと同じにすることはできません。送信先 CIDR ブロックは vSwitch CIDR ブロックを含むことができますが、vSwitch CIDR ブロックに含まれることはできません。
-
カスタムルートエントリの送信先 CIDR ブロック (DestinationCidrBlock) は、クラウドサービスシステムルート CIDR ブロック
100.64.0.0/10よりも詳細な CIDR ブロックにすることができますが、同じ CIDR ブロックにすることはできません。。重要 送信先 CIDR ブロック100.64.0.0/10のシステムルートは、VPC 内のクラウドサービス間の通信に使用されます。より詳細なルートを設定する際は注意してください。誤った設定により、クラウドサービスにアクセスできなくなる場合があります。 -
同じルートテーブル内のルートエントリの送信先 CIDR ブロック (DestinationCidrBlock) は一意である必要があります。
-
指定された送信先 CIDR ブロック (DestinationCidrBlock) が IP アドレスの場合、32 ビットマスクの CIDR ブロックとして扱われます。
-
複数のカスタムルートエントリが同じネクストホップ (NextHopId) をポイントできます。
-
カスタムルートエントリのネクストホップ (NextHopId) は、ルートテーブルと同じ VPC 内にある必要があります。
-
NextHopList パラメータ設定を使用して ECMP ルーティングを設定できます:
-
非 ECMP カスタムルートを追加するには、DestinationCidrBlock、NextHopType、および NextHopId パラメーターを指定します。NextHopList パラメーターは指定しないでください。
-
ECMP ルートを追加するには、DestinationCidrBlock および NextHopList パラメーターを指定します。NextHopType または NextHopId パラメーターは指定しないでください。
-
この操作を使用して仮想ボーダールーター (VBR) のルートテーブルにカスタムルートエントリを追加する際の注意事項:。
-
ルートテーブルには最大 200 個のカスタムルートエントリを含めることができます。
-
NextHopList パラメーターはサポートされていません。
-
カスタムルートエントリの送信先 CIDR ブロック (DestinationCidrBlock) は、クラウドサービスシステムルート CIDR ブロック
100.64.0.0/10よりも詳細な CIDR ブロックにすることができますが、同じ CIDR ブロックにすることはできません。重要 送信先 CIDR ブロック100.64.0.0/10のシステムルートは、VPC 内のクラウドサービス間の通信に使用されます。より詳細なルートを設定する際は注意してください。誤った設定により、クラウドサービスにアクセスできなくなる場合があります。 -
同じルートテーブル内のルートエントリの送信先 CIDR ブロック (DestinationCidrBlock) は一意である必要があります。
-
指定された送信先 CIDR ブロック (DestinationCidrBlock) が IP アドレスの場合、32 ビットマスクの CIDR ブロックとして扱われます。
-
複数のカスタムルートエントリが同じネクストホップ (NextHopId) をポイントできます。
-
カスタムルートエントリのネクストホップ (NextHopId) は、VBR に関連付けられた vRouter インターフェイスである必要があります。
-
VBR が Active 状態で、対応する Express Connect 回線が Enabled 状態であり、回線が支払い遅延ロック中でない場合にのみ、VBR にルートエントリを作成できます。
-
非 ECMP ルートエントリのみがサポートされています。DestinationCidrBlock、NextHopType、および NextHopId パラメーターを指定します。NextHopList パラメーターは指定しないでください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
vpc:CreateRouteEntry |
create |
*RouteTable
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
ルートテーブルのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。 |
cn-hangzhou |
| RouteTableId |
string |
必須 |
カスタムルートエントリを追加するルートテーブルの ID。 |
vtb-bp145q7glnuzd**** |
| DestinationCidrBlock |
string |
必須 |
カスタムルートエントリの送信先 CIDR ブロック。IPv4 CIDR ブロック、IPv6 CIDR ブロック、プレフィックスリストの送信先 CIDR ブロック、およびプレフィックスリストのインスタンス ID がサポートされています。以下の要件を満たす必要があります:
|
192.168.0.0/24 |
| NextHopId |
string |
任意 |
カスタムルートエントリのネクストホップインスタンスの ID。 説明
NextHopType を ECR に設定した場合、 DescribeExpressConnectRouterAssociation 操作を呼び出して、ネクストホップ ID として AssociationId を取得できます。 -。 |
i-j6c2fp57q8rr4jlu**** |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。 クライアントからパラメーター値を生成します。異なるリクエスト間で値が一意であることを確認してください。ClientToken 値には ASCII 文字のみを含めることができます。 説明
このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として使用します。RequestId は API リクエストごとに異なる場合があります。 |
02fb3da4-130e-11e9-8e44-001**** |
| RouteEntryName |
string |
任意 |
追加するカスタムルートエントリの名前。 名前は 1~128 文字で、 |
test |
| Description |
string |
任意 |
カスタムルートエントリの説明。 説明は 1~256 文字で、 |
test |
| NextHopType |
string |
任意 |
カスタムルートエントリのネクストホップのタイプ。有効な値:
列挙値:
|
RouterInterface |
| NextHopList |
array<object> |
任意 |
ネクストホップの情報。フォーマットについては以下を参照してください。 |
|
|
object |
任意 |
ネクストホップの情報。フォーマットについては以下を参照してください。 |
||
| NextHopId |
string |
任意 |
ECMP ルートのネクストホップインスタンスの ID。 |
ri-2zeo3xzyf3cd8r4**** |
| Weight |
integer |
任意 |
ECMP ルートのネクストホップの重み。 |
10 |
| NextHopType |
string |
任意 |
ECMP ルートのネクストホップのタイプ。有効な値: RouterInterface (ルーターインターフェイス)。 |
RouterInterface |
| DryRun |
boolean |
任意 |
ドライランを実行するかどうかを指定します。有効な値:
|
false |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
カスタムルートエントリの ID。 |
||
| RouteEntryId |
string |
カスタムルートエントリの ID。 |
rte-sn6vjkioxte1gz83z**** |
| RequestId |
string |
リクエスト ID。 |
0ED8D006-F706-4D23-88ED-E11ED28DCAC0 |
例
成功レスポンス
JSONJSON
{
"RouteEntryId": "rte-sn6vjkioxte1gz83z****",
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IllegalParam.CidrBlock | The specified CidrBlock is illegal. | |
| 400 | QuotaExceeded | Route entry quota exceeded in this route table. | |
| 400 | MissingParameter | Miss mandatory parameter. | |
| 400 | InvalidCidrBlock.Malformed | Specified CIDR block is not valid. | |
| 400 | InvalidCIDRBlock.Duplicate | Specified CIDR block is already exists. | |
| 400 | IncorrectVpcStatus | Current VPC status does not support this operation. | |
| 400 | IncorrectInstanceStatus | Current instance status does not support this operation. | |
| 400 | IncorrectRouteEntryStatus | Some route entry status blocked this operation. | |
| 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のルーティングネットワークセグメントのホワイトリストにないので、このネットワークセグメントを使用できません。2.追加したカスタムルーティング先ネットワークセグメントは、同じVPCの下のすべてのスイッチに属するネットワークセグメントからはできません。3.100.64.0.0/10はクラウドサービスアドレスなので、このネットワークセグメントをクラウドIDCに追加することはできません。4.100.64.0.0/10を除いて、100.64.0.0/11、100.960.0/11などの明細ルーティングネットワークセグメントはクラウドIDCでは使用できない。 |
| 400 | InvalidNextHop.NotFound | Specified next hop does not exist. | |
| 400 | InvalidVRouter.NotFound | vRouter not exists. | |
| 400 | InvalidVPC.NotFound | vpc not exists. | |
| 400 | InvalidNexthopTypeAndList.BothNull | both nexthopType and nextHopList are null. | |
| 400 | InvalidNexthopTypeAndList.BothNotNull | both nexthopType and nextHopList are not null. | |
| 400 | InvalidRouterInterface | invalid router interface. | |
| 400 | InvalidOppositeRouterType | nexthop list cannot only contain router interface whose opposite router interface is on vbr. | |
| 400 | InvalidNexthopListSize | nexthop size is illegal. Must be between 2 and 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. | |
| 400 | InvalidPhysicalConnectionBusinessStatus | invalid physical connection business status. | |
| 400 | InvalidRouterType | Cannot specify nexthop list in vbr's route table. | |
| 400 | IncorrectHaVipStatus | This operation is denied because satus of the specified HaVip is neither Available nor InUse. | |
| 400 | CountLimitExceed.HaVipRouteEntry | The count of route entry to HaVip in one route table is exceeded. | |
| 400 | InvalidRouteEntry.Duplicate | The route entry already exist. | |
| 400 | InvalidParam | The Ecmp routerEntry with router interfaces local vgw vip not match. | |
| 400 | INVALID_WEIGHT_PARAM | Specified value of weight invalid | |
| 400 | FORBIDDEN_USE_VPC_AS_INTERNET_GATEWAY | The Specified CIDR must be in vpc CIDR. | |
| 400 | InvalidNexthop | The Specified nexthop illegal. | |
| 400 | INVALID_VPC_ID | The Specified VpcId not match. | |
| 400 | InvalidRouteEntrySize | The Specified routerEntry size not legal. | |
| 400 | TaskConflict | The operation is too frequent, please wait a moment and try again. | |
| 400 | InvalidRouteEntry | Specified routeEntry not exist. | |
| 400 | InvalidDestinationCidrBlock | The specified destinationCidrBlock must not included in black list cidr. | |
| 400 | Forbidden.VRouterNotFound | Specified virtual switch is not found during access authentication. | |
| 400 | DefaultValidate.Error | validte fail. | |
| 400 | Region.NotSupport | The specified region does not currently support nextHopType for networkInterface | |
| 400 | OperationFailed.NotifyCenCreate | Failed to notify cen when create route entry. | |
| 400 | Forbidden.PrivateIpNotFound | Private ip address not exist. | |
| 400 | OperationUnsupported.InactiveMode | Vpc multi scope route only support active standby. | |
| 400 | InvalidRouteEntryName.Malformed | Specified RouteEntry name is not valid. | |
| 400 | IncorrectStatus.MultiScopeRiRouteEntry | MultiScope ri status must not in idle. | |
| 400 | OperationUnsupported.MoreThanOneVpnOrHavip | MultiScope can not support more than one vpn/havip. | |
| 400 | OperationUnsupported.EcmpRiTypeOrNumber | Emcp entry not supported if vpc-vbr or vbr-vlan ri does not exist. | |
| 400 | Duplicated.VpcNextHop | Route entry nexthop duplicate. | |
| 400 | OperationUnsupported.SubRouteTableECMP | Vpc subRouteTable don't support ecmp or multiScope. | |
| 400 | InvalidNexthop.NotFound | VRouterEntry nexthop does not exist. | |
| 400 | IllegalParam.NextHopId | Instance not exists or not vpc vm. | |
| 400 | QuotaExceeded.HaVipRouteEntry | Vpc havip route entry quota exceed. | |
| 400 | InvalidNexthop.DirectEni | The direct Eni cannot be nexthop. | |
| 400 | OperationFailed.InvalidNexthop | vpc multi scope route must has a enable nexthop. | |
| 400 | OperationFailed.NotifyCenDelete | Failed to notify cen when delete route entry. | |
| 400 | InvalidNatGateway.NotFound | Natgateway not exist. | |
| 400 | OperationFailed.CxpRouteExist | Cxp route alreay existed. | |
| 400 | OperationFailed.GetEniInfo | Failed to get networkInterface info. | |
| 400 | OperationUnsupported.InvalidRouterInterfaceType | Only vpc vbr interface support ecmp route. | |
| 400 | InvalidHaVip.NotFound | The specified HaVip does not exist in the specified region. | |
| 400 | OperationFailed.MultiScopeType | The specified nexthop type is not support in multiScope. | |
| 400 | OperationFailed.DistibuteLock | Distibute lock fail. | |
| 400 | QuotaExceeded.VpnRouteEntry | Vpn route entry quota exceeded. | |
| 400 | InvalidAttachment.NotFound | The attachment is not found. | |
| 400 | OperationFailed.ActiveNetworkInterfaceNotFound | No active network interface is found on the attachment. | |
| 400 | InvalidNetworkInterface.NotFound | The network interface is not found on the attachment. | |
| 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. | |
| 400 | IncorrectStatus.Ipv6Address | The IPv6 address of the specified next hop is being assigned or deleted. | |
| 400 | OperationUnsupported.Ipv6EntryOnPrimaryNetworkInterface | You cannot create IPv6 route entries on a primary network interface. | |
| 400 | OperationUnsupported.SpecifyIpOnIpv6Entry | You cannot specify the private IP address when you create IPv6 route entries. | |
| 400 | OperationUnsupported.MutipleIpv6Address | You cannot specify a next hop that has bound multiple IPv6 addresses. | |
| 400 | OperationDenied.Ipv6EntryOnCustomTable | You cannot create any IPv6 route entry on a custom route table. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 400 | OperationDenied.RouterInterfaceToDifferentVpc | The operation is not allowed because the router interface is connected to different VPCs. | |
| 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. | |
| 400 | IncorrectStatus.VpcPeer | The status of %s [%s] is incorrect. | |
| 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. | |
| 400 | OperationDenied.VpcIpv6NotEnabled | IPv6 has not been enabled for the VPC. | |
| 400 | IncorrectStatus.Ipv4Gateway | The status of Ipv4Gateway is incorrect. | |
| 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. | |
| 400 | OperationDenied.RouterInterfaceIpv6NotEnabled | Routerinterface does not support 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. | |
| 400 | OperationFailed.CidrConflictWithPrefixList | The specified CIDR block already exists in a prefixList route entry. | |
| 400 | ResourceNotFound.Ipv4Gateway | Specified Ipv4Gateway does not exist. | |
| 400 | Mismatch.HaVipIdAndRouteTableId | The HaVip and RouteTable are mismatched. | |
| 400 | OperationFailed.OperationLocked | The operation failed because the nextHop instance is in the O&M lock state. | |
| 400 | Mismatch.Ipv4GatewayIdAndRouteTableId | The specified IPv4Gateway and RouteTable are not matched. | |
| 400 | OperationUnsupported.DestinationCidrBlockOverlapWithVSwitch | The destination IPv6 network segment specified in the route entry overlaps with the vSwitch network segment. | |
| 400 | ResourceNotAssociated.Cen | The Vpc and Cen are not associated. | |
| 400 | IncorrectStatus.CenRelation | The status of Vpc in Cen is incorrect. | |
| 400 | OperationDenied.CenTypeInvalid | The operation is not allowed because of Cen type is invalid.. | |
| 400 | ResourceNotFound.Cen | The specified resource of Cen is not found. | |
| 400 | ResourceNotFound.NetworkInterface | The specified resource of network interface is not found. | |
| 400 | RouteConflict.AlreadyExist | Route conflict exists in routing table. | |
| 400 | IncorrectStatus.RouterInterface | The specified RouterInterface status is invalid. | |
| 400 | InvalidNexthop.UnsupportedEniBizType | The biz type of NetworkInterface is illegal. | |
| 400 | OperationDenied.RouterInterfaceIpv6 | RouterInterface does not support IPv6. | |
| 400 | InvalidNextHopType | Specified parameter "NextHopType" is not valid. | |
| 400 | OperationDenied.VbrAttachEcrInMiddleStatus | The operation is not allowed because of VBR attach or detach ECR in middle status. | |
| 400 | ResourceNotAssociated.Ecr | The ECR is not associated. | |
| 400 | UnsupportedFeature.RouterInterfaceIpv6 | The feature of ipv6 is not supported for the routerInterface. | |
| 400 | InvalidVpnInstanceId.NotFound | The specified VPN was not found. | |
| 400 | OperationFailed.ScopeActiveRouteEntryType | Operation failed because the type of the active route entry is not supported. | |
| 400 | OperationFailed.ScopeStandbyRouteEntryQuota | Operation failed because the quota for standby route entries in the scope has been exceeded. | |
| 400 | OperationFailed.ScopeActiveRouteEntryQuota | Operation failed because the quota for active route entries in the scope has been exceeded. | |
| 400 | OperationUnsupported.ScopeInvalidRouteType | The specified route type is unsupported. | |
| 400 | OperationFailed.EcmpInvalidRouterInterfaceOppositeType | Operation failed because the opposite type of the router interface is invalid for ECMP configuration. | |
| 400 | OperationUnsupported.Ipv6EcmpRouteEntry | The EcmpRouteEntry is not supported for IPv6. | |
| 400 | OperationUnsupported.Ipv6CidrBlock | The specified IPv6 CIDR block is unsupported. | |
| 400 | OperationUnsupported.Ipv6ForVBR | IPv6 route entry is not supported for VirtualBorderRouter. | |
| 400 | IncorrectStatus.RouteTableStatus | The status of the specified RouteTable is incorrect. | |
| 400 | OperationFailed.InvalidNextHopType | Operation failed because Ecmp routeEntry has more than one ri entry and can only support one non-ri entry. | |
| 400 | UnsupportedRegion | The feature is not supported in current region. | |
| 400 | UnsupportedFeature.VpcAdvancedFeature | The VPC does not support some advanced features. | |
| 400 | OperationDenied.CreateEcmpForPublishedRouteEntry | Operation denied because of can not create EcmpRouteEntry for published RouteEntry. | |
| 400 | OperationDenied.TrAttachmentIpv6Disabled | The operation is not allowed because tr attachment Ipv6 is disabled. | |
| 400 | Mismatch.EniIdAndRouteTableId | The operation is not allowed because eni and route table not in same vpc. | |
| 400 | InvalidDescription.Malformed | The Description is illegal. | |
| 400 | OperationFailed.InstanceDismatchCurrentVpc | The specified instance does not exist in current vpc. | |
| 400 | OperationDenied.RouterInterfaceStatusNotAllowed | The operation is not allowed because of RouterInterfaceStatusNotAllowed. | |
| 400 | OperationFailed.Ipv6AddressNotBind | The specified next hop has no IPv6 address. | |
| 400 | OperationUnsupported.MultipleIpv6Address | Operation unsupported because specific route next hop instance has multiple IPv6 address. | 操作不支持,因为指定的路由下一跳实例绑定了多个IPv6地址 |
| 500 | VPC.ERROR | error code 500,Internal server error. | |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | |
| 500 | IncorrectStatus.Ipv4Gateway | The status of Ipv4Gateway is incorrect. | |
| 403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | |
| 404 | InvalidParameter | Instance not exists or not vpc vm | |
| 404 | InvalidNatGatewayId.NotFound | Specified value of NatGatewayId is not found in our record. | |
| 404 | InvalidInstanId.NotFound | Specified instance does not exist. | |
| 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. | |
| 404 | InvalidNetworkInterface.NotFound | The specified networkInterface does not exist. | |
| 404 | InvalidVpc.NotFound | Specified vpc is not found in our record. | |
| 404 | InvalidIpv6Gateway.NotFound | Specified Ipv6Gateway does not exist. | |
| 404 | ResourceNotFound.GatewayLoadBalancerEndpoint | GatewayLoadBalancerEndpoint instance not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。