すべてのプロダクト
Search

このプロダクト

    Microservices Engine:AddGateway

    ドキュメントセンター

    Microservices Engine:AddGateway

    最終更新日:Apr 18, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    mse:AddGateway

    create

    *Gateway

    acs:mse:{#regionId}:{#accountId}:instance/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Name

    string

    任意

    ゲートウェイの名前。

    test-ceshi
    Region

    string

    必須

    ゲートウェイがデプロイされるリージョン ID。

    cn-hangzhou
    Vpc

    string

    必須

    Virtual Private Cloud (VPC) の ID。

    vpc-bp15mncnrtm83uauxd1xb
    ZoneInfo

    array<object>

    必須

    ゾーン情報。 このパラメーターは、マルチ AZ デプロイに必要です。

    object

    任意

    ゾーン情報を含むオブジェクト。

    ZoneId

    string

    任意

    ゾーンの ID。

    cn-shenzhen-e
    VSwitchId

    string

    任意

    vSwitch の ID。

    vsw-bp*****
    VSwitchId

    string

    任意

    プライマリ vSwitch の ID。 このパラメーターは、シングルゾーンデプロイに必要です。

    vsw-bp1q8th57frl5khj2li43
    VSwitchId2

    string

    任意

    セカンダリ vSwitch の ID。 このパラメーターは、マルチ AZ デプロイに必要です。

    vsw-wz9bu6o5vsvitt5mrxo6s
    ChargeType

    string

    任意

    ゲートウェイの課金方法。 このパラメーターは、サーバーレス以外のインスタンスに必要です。

    列挙値:

    • PREPAY :

      サブスクリプション

    • POSTPAY :

      従量課金

    POSTPAY
    MserVersion

    string

    任意

    ゲートウェイのエディション。

    • mse_premium：Professional Edition

    • mse_pro：Standard Edition

    • mse_serverless：Serverless Edition

    mse_pro
    Spec

    string

    任意

    ゲートウェイのインスタンスタイプ。 このパラメーターは、サーバーレス以外のインスタンスに必要です。

    • MSE_GTW_16_32_200_c (16 コア 32 GB)

    • MSE_GTW_2_4_200_c (2 コア 4 GB)

    • MSE_GTW_4_8_200_c (4 コア 8 GB)

    • MSE_GTW_8_16_200_c (8 コア 16 GB)

    列挙値:

    • MSE_GTW_16_32_200_c :

      16 コア 32 GB

    • MSE_GTW_2_4_200_c :

      2 コア、4 GB

    • MSE_GTW_4_8_200_c :

      4 コア、8 GB

    • MSE_GTW_8_16_200_c :

      8 コア 16 GB

    MSE_GTW_2_4_200_c
    Replica

    integer

    任意

    ゲートウェイノードの数。 このパラメーターは、サーバーレス以外のインスタンスに必要です。

    2
    ManagedEntryNetworkType

    string

    任意

    ゲートウェイの Ingress タイプ。 このパラメーターは、Professional Edition インスタンスにのみ適用されます。

    • pubnet：パブリックネットワーク

    • privatenet：プライベートネットワーク

    • privatepubnet：パブリックおよびプライベートネットワーク

    pubnet
    NlbNetworkType

    string

    任意

    プロビジョニングされた Network Load Balancer (NLB) インスタンスのネットワークタイプ。

    • pubnet：パブリックネットワーク

    • privatenet：プライベートネットワーク

    • privatepubnet：パブリックおよびプライベートネットワーク

    説明

    サーバーレス以外のインスタンスの場合、Network Load Balancer (NLB) インスタンス、LCU 課金のクラシックロードバランサー (CLB) インスタンス、または仕様課金の CLB インスタンスのいずれか 1 つのロードバランサータイプのみをプロビジョニングできます。

    説明

    サーバーレスインスタンスの場合、NLB インスタンスまたは LCU 課金の CLB インスタンスのいずれかをプロビジョニングできます。

    pubnet
    ClbNetworkType

    string

    任意

    プロビジョニングされた LCU 課金のクラシックロードバランサー (CLB) インスタンスのネットワークタイプ。

    • pubnet：パブリックネットワーク

    • privatenet：プライベートネットワーク

    • privatepubnet：パブリックおよびプライベートネットワーク

    説明

    サーバーレス以外のインスタンスの場合、Network Load Balancer (NLB) インスタンス、LCU 課金のクラシックロードバランサー (CLB) インスタンス、または仕様課金の CLB インスタンスのいずれか 1 つのロードバランサータイプのみをプロビジョニングできます。

    説明

    サーバーレスインスタンスの場合、NLB インスタンスまたは LCU 課金の CLB インスタンスのいずれかをプロビジョニングできます。

    pubnet
    SlbSpec deprecated

    string

    任意

    内部向けクラシックロードバランサー (CLB) インスタンスの仕様。 このパラメーターは、サーバーレス以外のインスタンスに適用されます。

    • slb.s1.small

    • slb.s2.small

    • slb.s2.medium

    • slb.s3.small

    • slb.s3.medium

    • slb.s3.large

    説明

    サーバーレス以外のインスタンスの場合、Network Load Balancer (NLB) インスタンス、LCU 課金のクラシックロードバランサー (CLB) インスタンス、または仕様課金の CLB インスタンスのいずれか 1 つのロードバランサータイプのみをプロビジョニングできます。

    説明

    サーバーレスインスタンスの場合、NLB インスタンスまたは LCU 課金の CLB インスタンスのいずれかをプロビジョニングできます。

    slb.s2.small
    InternetSlbSpec deprecated

    string

    任意

    パブリック向けクラシックロードバランサー (CLB) インスタンスの仕様。 このパラメーターは、サーバーレス以外のインスタンスに適用されます。

    • slb.s1.small

    • slb.s2.small

    • slb.s2.medium

    • slb.s3.small

    • slb.s3.medium

    • slb.s3.large

    説明

    サーバーレス以外のインスタンスの場合、Network Load Balancer (NLB) インスタンス、LCU 課金のクラシックロードバランサー (CLB) インスタンス、または仕様課金の CLB インスタンスのいずれか 1 つのロードバランサータイプのみをプロビジョニングできます。

    説明

    サーバーレスインスタンスの場合、NLB インスタンスまたは LCU 課金の CLB インスタンスのいずれかをプロビジョニングできます。

    slb.s2.small
    EnterpriseSecurityGroup

    boolean

    任意

    エンタープライズセキュリティグループを使用するかどうかを指定します。

    false
    EnableHardwareAcceleration

    boolean

    任意

    ハードウェアアクセラレーションを有効にするかどうかを指定します。

    false
    EnableXtrace

    boolean

    任意

    トレーシング分析を有効にするかどうかを指定します。

    false
    XtraceRatio

    string

    任意

    トレーシング分析のサンプリングレート。 有効な値は 1 から 100 までの整数です。

    10
    EnableSls

    boolean

    任意

    Simple Log Service (SLS) へのログ配信を有効にするかどうかを指定します。

    false
    Tag

    array<object>

    任意

    ゲートウェイに追加するタグの配列。

    object

    任意

    タグオブジェクト。

    Key

    string

    任意

    タグのキー。

    key
    Value

    string

    任意

    タグの値。

    value
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-acfm34x43l*****
    RequestPars

    string

    任意

    拡張リクエストパラメーター (JSON 形式)。

    {}
    AcceptLanguage

    string

    任意

    レスポンスの言語。 このパラメーターを省略した場合、デフォルト値の en が使用されます。

    • zh：中国語

    • en：英語

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスデータ構造。

    RequestId

    string

    リクエスト ID。

    2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Message

    string

    レスポンスメッセージ。

    • リクエストが成功した場合、成功メッセージが返されます。

    • リクエストが失敗した場合、エラーメッセージが返されます。

    Succ
    Code

    integer

    レスポンスコード。

    200
    Success

    boolean

    リクエストが成功したかどうかを示します。 有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    Data

    object

    レスポンスデータ。

    GatewayUniqueId

    string

    一意のゲートウェイ ID。

    gw-5017305290e14cebbrvec4a5****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C",
  "HttpStatusCode": 200,
  "Message": "Succ",
  "Code": 200,
  "Success": true,
  "Data": {
    "GatewayUniqueId": "gw-5017305290e14cebbrvec4a5****"
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalRequest Invalid request:%s
    400 InvalidParameter Parameter error:%s
    500 InternalError Console error. Try again later:%s
    403 NoPermission You are not authorized to perform this operation:%s
    404 NotFound Not found:%s

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

    変更履歴

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