すべてのプロダクト
Search

このプロダクト

    Microservices Engine:GetGateway

    ドキュメントセンター

    Microservices Engine:GetGateway

    最終更新日:Dec 16, 2025

    ゲートウェイが属する VPC や vSwitch などのゲートウェイの基本情報を取得します。

    今すぐお試しください

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

    get

    *Gateway

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GatewayUniqueId

    string

    任意

    ゲートウェイの一意の ID。

    gw-685f661467b54f48b7b7a76605ce****
    AcceptLanguage

    string

    任意

    応答の言語。有効な値：

    • zh：中国語

    • en：英語

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    RequestId

    string

    リクエスト ID。

    9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6
    HttpStatusCode

    integer

    返される HTTP ステータスコード。

    200
    Message

    string

    返されるメッセージ。

    The request is successfully processed.

    Code

    integer

    返される状態コード。値が 200 の場合は、リクエストが成功したことを示します。

    200
    Success

    boolean

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

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

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

    true
    Data

    object

    ゲートウェイに関する情報。

    Id

    integer

    ゲートウェイの ID。

    12
    Name

    string

    ゲートウェイの名前。

    DEFAULT
    GatewayUniqueId

    string

    ゲートウェイの一意の ID。

    gw-7ea3da97b96543e19f6c597cd4a9****
    Region

    string

    リージョン ID。

    cn-hangzhou
    PrimaryUser

    string

    ゲートウェイを作成したユーザーの Alibaba Cloud アカウント ID。

    1231254
    Status

    integer

    ゲートウェイのステータス。有効な値：

    • 0：ゲートウェイは作成中です。

    • 1：ゲートウェイの作成に失敗しました。

    • 2：ゲートウェイは実行中です。

    • 3：ゲートウェイは変更中です。

    • 4：ゲートウェイはスケールイン中です。

    • 6：ゲートウェイはスケールアウト中です。

    • 8：ゲートウェイは削除中です。

    • 10：ゲートウェイは再起動中です。

    • 11：ゲートウェイは再構築中です。

    • 12：ゲートウェイは更新中です。

    • 13：ゲートウェイの更新に失敗しました。

    0
    Vpc

    string

    VPC の ID。

    vpc-bp1328cm01m6uel42b5zb
    Vswitch

    string

    vSwitch の ID。

    vsw-bp18zeqxx6mpuq843z4n5
    SecurityGroup

    string

    セキュリティグループの ID。

    sg-bp11ufzqn6mmb8dtzz82
    Spec

    string

    ゲートウェイの仕様。

    MSE_GTW_16_32_200_c
    Replica

    integer

    ゲートウェイレプリカの数。

    2
    GmtCreate

    string

    ゲートウェイが作成された時刻。時刻は GMT で表示されます。この時刻は、ゲートウェイが存在するリージョンのローカル時刻です。

    2022-01-07T10:07:57.000+0000
    GmtModified

    string

    ゲートウェイが最後に変更された時刻。

    2022-01-07T10:07:57.000+0000
    XtraceDetails

    object

    トレース分析の詳細。

    Sample

    integer

    トレース分析のサンプリングレート。

    10
    TraceOn

    boolean

    トレース分析を使用したサンプリングが有効になっているかどうかを示します。

    true
    Vswitch2

    string

    セカンダリ vSwitch の ID。

    vpc-bp1j6ivhav15ve7q54kq2
    InstanceId

    string

    インスタンスの ID。

    mse-cn-st21ri2****
    ChargeType

    string

    サブスクリプションや従量課金などの課金方法。

    POSTPAY
    EndDate

    string

    ゲートウェイの有効期限が切れる時刻。

    2021-08-01 00:00:00
    StatusDesc

    string

    ステータスの説明。

    Restarting

    LogConfigDetails

    object

    ログ設定。

    LogEnabled

    boolean

    Log Service が有効化されているかどうかを示します。

    true
    ProjectName

    string

    プロジェクトの名前。

    k8s-log-c173117256e934a96b7fefdf2ef8a8057
    LogStoreName

    string

    Logstore の名前。

    mse_access_log
    MseTag

    string

    リソースのタグ。

    {"TagKey":"TagValue"}
    ResourceGroupId

    string

    リソースグループの ID。

    rg-acfm34x43l*****
    TotalReplica

    integer

    自動的にスケールアウトされたレプリカ数を含む、レプリカの総数。

    3
    Elastic

    boolean

    自動スケールアウトが有効になっているかどうかを示します。

    true
    ElasticReplica

    integer

    自動的にスケールアウトされたレプリカの数。

    1
    ElasticType

    string

    自動スケールアウトのタイプ。有効な値：

    • CronHPA：コンテナ定時スケーリング

    CronHPA
    ElasticPolicy

    object

    自動スケールアウトポリシー。

    MaxReplica

    integer

    自動的にスケールアウトされるインスタンスの最大数。このパラメーターは、水平スケールアウトに使用されます。

    5
    ElasticType

    string

    自動スケールアウトのタイプ。有効な値：

    • CronHPA：コンテナ定時スケーリング

    CronHPA
    TimePolicyList

    array<object>

    時間によるスケールアウトのポリシー。

    object

    DesiredReplica

    integer

    期待されるレプリカ数。

    2
    StartTime

    string

    自動スケールアウトの開始時刻。

    16:00
    EndTime

    string

    自動スケールアウトの終了時刻。

    18:00

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 12,
    "Name": "DEFAULT",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597cd4a9****",
    "Region": "cn-hangzhou",
    "PrimaryUser": "1231254",
    "Status": 0,
    "Vpc": "vpc-bp1328cm01m6uel42b5zb",
    "Vswitch": "vsw-bp18zeqxx6mpuq843z4n5",
    "SecurityGroup": "sg-bp11ufzqn6mmb8dtzz82",
    "Spec": "MSE_GTW_16_32_200_c",
    "Replica": 2,
    "GmtCreate": "2022-01-07T10:07:57.000+0000",
    "GmtModified": "2022-01-07T10:07:57.000+0000",
    "XtraceDetails": {
      "Sample": 10,
      "TraceOn": true
    },
    "Vswitch2": "vpc-bp1j6ivhav15ve7q54kq2",
    "InstanceId": "mse-cn-st21ri2****",
    "ChargeType": "POSTPAY",
    "EndDate": "2021-08-01 00:00:00",
    "StatusDesc": "Restarting\n",
    "LogConfigDetails": {
      "LogEnabled": true,
      "ProjectName": "k8s-log-c173117256e934a96b7fefdf2ef8a8057",
      "LogStoreName": "mse_access_log"
    },
    "MseTag": "{\"TagKey\":\"TagValue\"}",
    "ResourceGroupId": "rg-acfm34x43l*****",
    "TotalReplica": 3,
    "Elastic": true,
    "ElasticReplica": 1,
    "ElasticType": "CronHPA",
    "ElasticPolicy": {
      "MaxReplica": 5,
      "ElasticType": "CronHPA",
      "TimePolicyList": [
        {
          "DesiredReplica": 2,
          "StartTime": "16:00",
          "EndTime": "18:00"
        }
      ]
    }
  }
}

    エラーコード

    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

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

    変更履歴

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