すべてのプロダクト
Search

このプロダクト

    :ListTransitRouterCidrAllocation

    ドキュメントセンター

    :ListTransitRouterCidrAllocation

    最終更新日:Apr 03, 2024

    トランジットルーターのCIDRブロック内のIPアドレスの割り当て方法を照会します。

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

    リクエストパラメーター

    項目

    データ型

    必須／任意

    例:

    説明　

    操作

    String

    必須

    ListTransitRouterCidrAllocation

    実行する操作です。 値をListTransitRouterCidrAllocationに設定します。

    ClientToken

    String

    任意

    123e4567-e89b-12d3-a456-426 ****

    リクエストのべき等性を保証するために使用されるクライアントトークン。

    クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 ClientTokenにはASCII文字のみを含めることができます。

    説明

    このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 各APIリクエストのRequestIdの値は異なる場合があります。

    TransitRouterId

    String

    必須

    tr-p0w3x8c9em72a40nw ****

    トランジットルーターのID。

    RegionId

    String

    必須

    cn-hangzhou

    トランジットルーターがデプロイされているリージョンのID。

    DescribeChildInstanceRegionsを呼び出して、最新のリージョンリストを照会できます。

    TransitRouterCidrId

    String

    任意

    cidr-0zv0q9crqpntzz ****

    CIDRブロックのID。

    ListTransitRouterCidrを呼び出して、CIDRブロックのIDを照会できます。

    CidrBlock

    String

    任意

    192.168.10.0/28

    ネットワークインスタンスに割り当てられているCIDRブロック。

    Cidr

    String

    任意

    192.168.10.0/24

    トランジットルーターのCIDRブロック。

    DedicatedOwnerId

    String

    任意

    [VPN] >

    排他的に使用するCIDRブロック。

    値をVPNに設定します。これは、VPN接続用に予約されているCIDRブロックを指定します。

    AttachmentId

    String

    任意

    tr-attach-2nalp6yksc805w ****

    ネットワークインスタンス接続のID。

    AttachmentName

    String

    任意

    nametest

    ネットワークインスタンス接続の名前。

    DryRun

    Boolean

    いいえ

    false

    リクエストのみを事前チェックするかどうかを指定します。 有効な値：

    • true: リクエストを事前にチェックしますが、トランジットルーターのCIDRブロック内のIPアドレスがどのように割り当てられているかは照会しません。 システムは、必要なパラメーター、リクエスト形式、およびサービス制限をチェックします。 リクエストが事前チェックに合格しなかった場合、エラーメッセージが返されます。 リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。

    • false (デフォルト): リクエストを送信します。 リクエストが事前チェックに合格した後、割り当てられたIPアドレスが照会されます。

    MaxResults

    Integer

    いいえ

    20

    返された各ページのエントリ数を示します。

    • MaxResultsを設定しない場合は、結果をバッチでクエリする必要がないことを示します。 MaxResultsの値は、エントリの総数を示します。

    • MaxResultsに値が指定されている場合、結果をバッチでクエリする必要があることを示します。 有効な値: 1〜100。 MaxResultsを20に設定することを推奨します。

      応答のMaxResultsの値は、現在のバッチのエントリ数を示します。

    NextToken

    String

    任意

    FFmyTO70tTpLG6I3FmYAXGKPd ****

    クエリの開始点を決定するトークン。 有効な値：

    • これが最初のクエリである場合、または後続のクエリを送信しない場合は、このパラメーターを無視します。

    • 後続のクエリを送信する場合は、前回の呼び出しから返されたNextTokenの値に値を設定します。

    レスポンスパラメーター

    項目

    データ型

    例:

    説明　

    NextToken

    String

    FFmyTO70tTpLG6I3FmYAXGKPd ****

    クエリの開始点を決定するトークン。 有効な値：

    • NextTokenが返されなかった場合は、追加の結果が存在しないことを示します。

    • 前のクエリでNextTokenが返された場合は、値を指定して次の結果セットを取得します。

    RequestId

    String

    0876E54E-3E36-5C31-89F0-9EE8A9266F9A

    リクエストの ID です。

    TotalCount

    Integer

    1

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

    MaxResults

    Integer

    1

    返された各ページのエントリ数を示します。

    • MaxResultsに値が指定されていない場合、クエリ結果は1つのバッチで返されます。 MaxResultsの値は、エントリの総数を示します。

    • MaxResultsに値が指定されている場合、クエリ結果はバッチで返されます。 応答のMaxResultsの値は、現在のバッチのエントリ数を示します。

    TransitRouterCidrAllocations

    TransitRouterCidrAllocationの配列

    割り当てられたCIDRブロックに関する情報。

    TransitRouterCidrId

    String

    cidr-0zv0q9crqpntzz ****

    トランジットルーターCIDRブロックのID。

    AllocatedCidrBlock

    String

    192.168.10.0/28

    ネットワークインスタンスに割り当てられたCIDRブロック。

    AttachmentId

    String

    tr-attach-2nalp6yksc805w ****

    ネットワークインスタンス接続のID。

    Cidr

    String

    192.168.10.0/24

    トランジットルーターCIDRブロックのID。

    AttachmentName

    String

    nametest

    ネットワークインスタンス接続の名前。

    例

    リクエストの例

    http(s)://[Endpoint]/?Action=ListTransitRouterCidrAllocation
&ClientToken=123e4567-e89b-12d3-a456-426 ****
&TransitRouterId=tr-p0w3x8c9em72a40nw ****
&RegionId=cn-hangzhou
&TransitRouterCidrId=cidr-0zv0q9crqpntzz ****
&CidrBlock=192.168.10.0/28
&Cidr=192.168.10.0/24
&AttachmentId=tr-attach-2nalp6yksc805w ****
&AttachmentName=nametest
&DryRun=false
&MaxResults=20
&<共通リクエストパラメーター>

    正常に処理された場合のレスポンス例

    XML 形式

    HTTP/1.1 200 OK
Content-Type:application/xml

<ListTransitRouterCidrAllocationResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd ****</NextToken>
    <RequestId>0876E54E-3E36-5C31-89F0-9EE8A9266F9A</RequestId>
    <TotalCount> 1 </ TotalCount>
    <MaxResults>1</MaxResults>
    <TransitRouterCidrAllocations>
        <TransitRouterCidrId>cidr-0zv0q9crqpntzz ****</TransitRouterCidrId>
        <AllocatedCidrBlock>192.168.10.0/28</AllocatedCidrBlock>
        <AttachmentId>tr-attach-2nalp6yksc805w ****</AttachmentId>
        <Cidr>192.168.10.0/24</Cidr>
        <AttachmentName>nametest</AttachmentName>
    </TransitRouterCidrAllocations>
</ListTransitRouterCidrAllocationResponse>

    JSON 形式

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0876E54E-3E36-5C31-89F0-9EE8A9266F9A" 、
  "TotalCount" : 1、
  "MaxResults" : 1、
  "TransitRouterCidrAllocations" : [ {
    "TransitRouterCidrId" : "cidr-0zv0q9crqpntzz ****" 、
    "AllocatedCidrBlock" : "192.168.10.0/28" 、
    "AttachmentId" : "tr-attach-2nalp6yksc805w ****" 、
    "Cidr" : "192.168.10.0/24" 、
    "AttachmentName" : "nametest"
  } ]
}

    エラーコード

    エラーコードリストについては、「API エラーセンター」をご参照ください。