すべてのプロダクト
Search
ドキュメントセンター

VPN Gateway:CreateCustomerGateway

最終更新日:Aug 10, 2026

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

今すぐお試しください

この 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:CreateCustomerGateway

create

*CustomerGateway。

acs:vpc:{#regionId}:{#accountId}:customergateway/*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

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

DescribeRegions 操作を呼び出して、リージョン ID をクエリできます。

cn-shanghai

ClientToken

string

任意

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

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

説明

このパラメーターを指定しない場合、システムは API リクエストの RequestIdClientToken として自動的に使用します。RequestId は API 呼び出しごとに異なる場合があります。

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

IpAddress

string

必須

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

  • パブリックネットワークタイプを使用する IPsec-VPN 接続を作成する場合は、パブリック IP アドレスを入力します。

  • プライベートネットワークタイプを使用する IPsec-VPN 接続を作成する場合は、プライベート IP アドレスを入力します。

以下の IP アドレスはサポートされていません。これらの IP アドレスを使用すると、IPsec-VPN 接続を確立できません。

  • 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

任意

IPsec-VPN 接続で BGP 動的ルートプロトコルを有効にする予定がある場合は、オンプレミスデータセンターのゲートウェイデバイスの自律システム番号 (ASN) を割り当てる必要があります。有効な値: 1~4294967295。値 45104 はサポートされていません。

Asn は 4 バイトの数値です。2 セグメントフォーマット (最初の 16 ビット.最後の 16 ビット) で数値を入力できます。各セグメントは 10 進数フォーマットで入力します。

たとえば、123.456 と入力した場合、ASN は 123 × 65536 + 456 = 8061384 となります。

説明
  • Alibaba Cloud との BGP 接続を確立するには、非公開 ASN を使用してください。非公開 ASN の有効値の詳細については、関連ドキュメントを参照してください。

  • 45104 は、Internet Assigned Numbers Authority (IANA) によって Alibaba Cloud Computing Co., Ltd. に割り当てられた固有の ID です。グローバルインターネットルーティングおよびデータ転送における Alibaba Cloud の ID として使用されます。

65530

AuthKey

string

任意

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

キーの長さは 1~64 文字で、ASCII 文字のみを含めることができます。スペース、中国語の文字、半角疑問符 (?) はサポートされていません。

AuthKey****

Tags

array<object>

任意

カスタマーゲートウェイに追加するタグのリスト。

一度に最大 20 個のタグをカスタマーゲートウェイに追加できます。

object

任意

タグ情報。

Key

string

任意

タグキー。このパラメーターを指定する場合、値は空文字列にできません。

タグキーの長さは最大 64 文字で、aliyun または acs: で始まることはできません。http:// または https:// を含めることはできません。

一度に最大 20 個のタグキーを指定できます。

TagKey

Value

string

任意

タグ値。

タグ値の長さは最大 128 文字で、空文字列にすることができます。aliyun または acs: で始まることはできず、http:// または https:// を含めることはできません。

各タグキーは 1 つのタグ値に対応します。一度に最大 20 個のタグ値を指定できます。

TagValue

ResourceGroupId

string

任意

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

  • ListResourceGroups 操作を呼び出して、リソースグループ ID をクエリできます。

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

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 フォーマットで、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) からの経過時間をミリ秒単位で表します。

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. 指定された BGP 認証キーが無効です。
400 InvalidIpAddress.AlreadyExist Specified IpAddress is already exist. IP アドレスはすでに存在します。同じユーザーは同じリージョンで重複する IP アドレスを使用できません。
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. 指定された ASN は仕様に準拠していません。
400 OperationDenied.MissingAsn The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified. カスタマーゲートウェイの BGP 認証キーを指定する場合、自律システム番号も指定する必要があります。
400 InvalidParameter.TagValue The specified parameter TagValue is invalid. 指定された TagValue パラメーターが無効です。
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. 指定された TagKey パラメーターが無効です。
400 Duplicated.TagKey The specified parameter TagKey is duplicated. 指定された TagKey パラメーターが重複しています。
400 OperationFailed.NoRamPermission Vpn Service has no permission to operate your IDaaS instances. VPN サービスにお客様の IDaaS インスタンスを操作する権限がありません。
400 CreateVpnUserGatewayQuotaFull.QuotaFull The number of created VPN customer gateways exceeds the quota. VPN カスタマーゲートウェイの数がクォータ制限を超えています。
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. EIP が現在の呼び出し元に属していません。この EIP を操作する権限があるかどうかを確認してください。
409 OperationConflict The operation against this instance is too frequent, please try again later. リクエストの競合が発生しました。後でもう一度お試しください。

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

変更履歴

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