すべてのプロダクト
Search

このプロダクト

    VPN Gateway:CreateCustomerGateway

    ドキュメントセンター

    VPN Gateway:CreateCustomerGateway

    最終更新日:Apr 27, 2026

    カスタマーゲートウェイを作成します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    カスタマーゲートウェイのリージョン ID です。

    最新のリージョン一覧を取得するには、DescribeRegions 操作を呼び出してください。

    cn-shanghai
    ClientToken

    string

    任意

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

    クライアント側でトークンを生成できますが、異なるリクエスト間で一意であることを保証する必要があります。トークンは ASCII 文字のみを含み、長さは 64 文字を超えてはなりません。

    説明

    このパラメーターを指定しない場合、システムは自動的に リクエスト ID を クライアントトークン として使用します。リクエスト ID は各リクエストごとに異なる場合があります。

    02fb3da4-130e-11e9-8e44****
    IpAddress

    string

    必須

    データセンター内のゲートウェイデバイスの静的 IP アドレスです。

    • パブリック IPsec 接続を作成する場合は、パブリック IP アドレスを入力してください。

    • プライベート IPsec 接続を作成する場合は、プライベート IP アドレスを入力してください。

    以下の IP アドレスは使用できません。これらのアドレスを使用すると、IPsec 接続を確立できません。

    • 100.64.0.0~100.127.255.255

    • 127.0.0.0~127.255.255.255

    • 169.254.0.0~169.254.255.255

    • 224.0.0.0~239.255.255.255

    • 255.0.0.0~255.255.255.255

    101.12.XX.XX
    Name

    string

    任意

    カスタマーゲートウェイの名前です。

    名前の長さは 1～100 文字で、http:// または https:// で開始してはなりません。

    nametest
    Description

    string

    任意

    カスタマーゲートウェイの説明です。

    説明の長さは 1～100 文字で、http:// または https:// で開始してはなりません。

    desctest
    Asn

    string

    任意

    お客様のデータセンターにあるゲートウェイデバイスの自律システム番号 (ASN) です。IPsec 接続でボーダーゲートウェイプロトコル (BGP) を使用する場合は、このパラメーターが必要です。有効値：1～4294967295。45104 はサポートされていません。

    Asn は 4 バイトの数値です。2 つのセグメントに分割し、上位 16 ビットと下位 16 ビットをピリオド (.) で区切って入力できます。各セグメントは 10 進数で入力してください。

    たとえば、123.456 と入力した場合、ASN は 8061384 になります。この ASN は次の数式で計算されます：123 × 65536 + 456 = 8061384。

    説明

    • BGP 接続を Alibaba Cloud と確立する際は、非公開 ASN の使用を推奨します。非公開 ASN の範囲については、関連ドキュメントをご参照ください。

    • 45104 は IANA によって Alibaba Cloud に割り当てられた一意の識別子です。インターネット経由でのルート選択およびデータ伝送時に Alibaba Cloud を識別するために使用されます。

    65530
    AuthKey

    string

    任意

    データセンター内のゲートウェイデバイスの BGP ルーティングプロトコルの認証キーです。

    キーの長さは 1～64 文字で、ASCII 文字のみを含み、スペースや疑問符 (?) を含んではなりません。

    AuthKey****
    Tags

    array<object>

    任意

    タグ値です。

    タグ値は空文字列でもよく、長さは 128 文字を超えてはなりません。aliyun または acs: で開始してはならず、http:// または https:// を含んではなりません。

    各タグキーには 1 つのタグ値が対応します。1 回の呼び出しで最大 20 個のタグ値を指定できます。

    object

    任意

    Key

    string

    任意

    タグキーです。タグキーは空文字列であってはなりません。

    長さは最大 64 文字で、http:// または https:// を含んではなりません。aliyun または acs: で開始してはなりません。

    1 回の呼び出しで最大 20 個のタグキーを指定できます。

    TagKey
    Value

    string

    任意

    タグ値です。

    タグ値は空文字列でもよく、長さは 128 文字を超えてはなりません。aliyun または acs: で開始してはならず、http:// または https:// を含んではなりません。

    各タグキーには 1 つのタグ値が対応します。1 回の呼び出しで最大 20 個のタグ値を指定できます。

    TagValue
    ResourceGroupId

    string

    任意

    カスタマーゲートウェイが属するリソースグループの ID です。

    • ListResourceGroups 操作を呼び出して、リソースグループの一覧を照会できます。

    • リソースグループを指定しない場合、作成されたカスタマーゲートウェイはデフォルトのリソースグループに属します。

    rg-aek2qo2h4jy****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーターです。

    RequestId

    string

    リクエスト ID です。

    D32B3C26-6C6C-4988-93E9-D2A6444CE6AE
    IpAddress

    string

    オンプレミスデータセンター内のゲートウェイデバイスの静的 IP アドレスです。

    101.12.XX.XX
    Description

    string

    カスタマーゲートウェイの説明です。

    desctest
    CustomerGatewayId

    string

    カスタマーゲートウェイの ID です。

    cgw-bp1jrawp82av6bws9****
    CreateTime

    integer

    カスタマーゲートウェイが作成された際に生成されたタイムスタンプです。単位：ミリ秒。

    この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。

    1493363486000
    Name

    string

    カスタマーゲートウェイの名前です。

    nametest

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D32B3C26-6C6C-4988-93E9-D2A6444CE6AE",
  "IpAddress": "101.12.XX.XX",
  "Description": "desctest",
  "CustomerGatewayId": "cgw-bp1jrawp82av6bws9****",
  "CreateTime": 1493363486000,
  "Name": "nametest"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidAuthkey.Malformed The specified BGP authentication key (%s) is malformed.
    400 InvalidIpAddress.AlreadyExist Specified IpAddress is already exist.
    400 InvalidIpAddress.WrongFormat Specified IpAddress is invalid.
    400 InvalidName The name is not valid
    400 InvalidDescription The description is not valid
    400 Resource.QuotaFull The quota of resource is full
    400 IllegalParam.Asn The specified Asn is invalid.
    400 OperationDenied.MissingAsn The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified.
    400 InvalidParameter.TagValue The specified parameter TagValue is invalid.
    400 SizeLimitExceeded.TagNum The maximum number of tags is exceeded.
    400 Forbidden.TagKey.Duplicated The specified tag key already exists.
    400 InvalidParameter.TagKey The specified parameter TagKey is invalid.
    400 Duplicated.TagKey The specified parameter TagKey is duplicated.
    400 OperationFailed.NoRamPermission Vpn Service has no permission to operate your IDaaS instances.
    400 CreateVpnUserGatewayQuotaFull.QuotaFull The number of created VPN customer gateways exceeds the quota.
    403 Forbidden.SubUser User not authorized to operate on the specified resource as your account is created by another user.
    403 Forbidden User not authorized to operate on the specified resource.
    409 OperationConflict The operation against this instance is too frequent, please try again later.

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

    変更履歴

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