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

Virtual Private Cloud:CreateVpcGatewayEndpoint

最終更新日:Apr 27, 2026

ゲートウェイエンドポイントを作成します。

操作説明

  • CreateVpcGatewayEndpoint は非同期操作です。リクエストを送信すると、システムは EndpointId を返してバックグラウンドでタスクを実行します。タスクのステータスを確認するには、ListVpcGatewayEndpoints 操作を呼び出してください。

    • ゲートウェイエンドポイントのステータスが Creating の場合、ゲートウェイエンドポイントは作成中です。

    • ゲートウェイエンドポイントのステータスが Created の場合、ゲートウェイエンドポイントは作成済みです。

  • 指定された時間内に、同一のエンドポイントサービスに対して CreateVpcGatewayEndpoint 操作を繰り返し呼び出すことはできません。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター

必須 / 任意

説明

VpcId

string

必須

ゲートウェイエンドポイントを作成する VPC の ID です。

VPC とゲートウェイエンドポイントは、同一リージョンにデプロイされている必要があります。

vpc-bp1gsk7h12ew7oegk****

ServiceName

string

必須

エンドポイントサービスの名前です。

com.aliyun.cn-hangzhou.oss

PolicyDocument

string

任意

クラウドサービスのアクセスポリシーです。

アクセスポリシーの構文および構造の詳細については、「ポリシーの構文と構造」をご参照ください。

{ "Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "*" ], "Action" : [ "*" ], "Principal" : [ "*" ] } ] }

EndpointName

string

任意

ゲートウェイエンドポイントの名前です。

名前の長さは 1~128 文字である必要があります。

test

EndpointDescription

string

任意

ゲートウェイエンドポイントの説明です。

説明の長さは 1~255 文字である必要があります。

test

ClientToken

string

任意

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

トークンはクライアント側で生成できますが、異なるリクエスト間で一意であることを保証する必要があります。トークンには ASCII 文字のみを使用できます。

説明

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

5A2CFF0E-5718-45B5-9D4D-70B3FF3898

DryRun

boolean

任意

実際のリクエストを実行せずにドライランのみを実行するかどうかを指定します。有効値は次のとおりです。

  • true:ドライランのみを実行します。システムは、パラメーター値の欠落、リクエスト構文の誤り、サービス制限など、潜在的な問題についてリクエストをチェックします。ドライランに失敗した場合はエラーメッセージが返されます。ドライランに成功した場合は、DryRunOperation エラーコードが返されます。

  • false (デフォルト):ドライランを実行し、実際のリクエストも実行します。ドライランに成功した場合は、2xx HTTP ステータスコードが返され、操作が実行されます。

false

ResourceGroupId

string

任意

ゲートウェイエンドポイントが属するリソースグループの ID です。

rg-acfmxazb4ph****

Tag

array<object>

任意

リソースのタグです。

object

任意

Key

string

任意

リソースに追加するタグ N のキーです。最大 20 個のタグキーを指定できます。タグキーは空文字列にできません。

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

FinanceDept

Value

string

任意

リソースに追加するタグ N の値です。最大 20 個のタグ値を指定できます。タグ値は空文字列にできます。

タグ値の長さは最大 128 文字です。http:// または https:// を含むことはできません。また、aliyun または acs: で開始することもできません。

FinanceJoshua

RegionId

string

必須

ゲートウェイエンドポイントのリージョン ID です。

最新のリージョンリストを照会するには、DescribeRegions 操作を呼び出してください。

cn-hangzhou

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID です。

62CFC815-E08A-5CF4-92D1-54273EC9E406

EndpointId

string

ゲートウェイエンドポイントの ID です。

vpce-bp1w1dmdqjpwul0v3****

ServiceName

string

エンドポイントサービスの名前です。

com.aliyun.cn-hangzhou.oss

EndpointName

string

ゲートウェイエンドポイントの名前です。

test

CreationTime

string

ゲートウェイエンドポイントの作成時刻です。時刻は ISO 8601 標準に従い、YYYY-MM-DDThh:mm:ssZ 形式で表されます。時刻は協定世界時 (UTC) で表示されます。

2021-08-27T01:58:37Z

ResourceGroupId

string

ゲートウェイエンドポイントが属するリソースグループの ID です。

rg-acfmxazb4ph****

成功レスポンス

JSONJSON

{
  "RequestId": "62CFC815-E08A-5CF4-92D1-54273EC9E406",
  "EndpointId": "vpce-bp1w1dmdqjpwul0v3****",
  "ServiceName": "com.aliyun.cn-hangzhou.oss",
  "EndpointName": "test",
  "CreationTime": "2021-08-27T01:58:37Z",
  "ResourceGroupId": "rg-acfmxazb4ph****"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 OperationFailed.ConcurrentOperation The operation is failed because of concurrent operation.
400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
400 IllegalParam.PolicyDocument The param of PolicyDocument is illegal.
400 IllegalParam.GatewayEndpointName The param of GatewayEndpointName is illegal.
400 IllegalParam.GatewayEndpointDescription The param of GatewayEndpointDescription is illegal.
400 ResourceAlreadyExist.GatewayEndpoint The specified resource gateway endpoint is already exist.
400 ResourceNotFound.ServiceName The specified resource service name is not found.
400 ResourceNotFound.VpcId The specified resource vpc is not found.
400 Forbidden.OperateShareResource The operation is failed because of shared vpc.
400 IncorrectStatus.Vpc The status of vpc [%s] is incorrect.
400 IncorrectStatus.CenStatus The status of vpc cenStatus [%s] is incorrect.
400 OperationFailed.VpcIpv6Disabled The operation is failed because of VpcIpv6Disabled.
400 UnsupportedFeature.GatewayEndpoint The feature of gatewayEndpoint is not supported for %s.
400 SystemBusy System is busy, please try again later.
400 Forbbiden User not authorized to operate on the specified resource.
400 OperationDenied.PolicyDocument The gatewayEndpoint does not support policy.
400 MissingParam.PolicyDocument The param of PolicyDocument is missing.
400 OperationDenied.NotAuthorized User not authorized to operate on the specified resource.
400 InvalidPolicy.WrongFormat Invalid input policy format.

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

変更履歴

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