全部產品
Search

搜尋本產品

    Microservices Engine：GetGateway - 查詢網關資訊

    文件中心

    Microservices Engine：GetGateway - 查詢網關資訊

    更新時間：Dec 16, 2025

    擷取網關的所屬VPC，所屬交換器等基本資料。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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

    請求是否成功的描述資訊

    請求處理成功
    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

    地區。

    cn-hangzhou
    PrimaryUser

    string

    建立主使用者 User ID。

    1231254
    Status

    integer

    擷取Data Integration同步任務的結果狀態。取值如下：

    • 0: 建立中

    • 1: 建立失敗

    • 2: 運行中

    • 3: 變更中

    • 4: 縮容中

    • 6: 擴容中

    • 8: 刪除中

    • 10: 重啟中

    • 11: 重建中

    • 12: 升級中

    • 13: 升級失敗

    0
    Vpc

    string

    VPC 網路識別碼。

    vpc-bp1328cm01m6uel42b5zb
    Vswitch

    string

    交換器。

    vsw-bp18zeqxx6mpuq843z4n5
    SecurityGroup

    string

    安全性群組。

    sg-bp11ufzqn6mmb8dtzz82
    Spec

    string

    網關規格。

    MSE_GTW_16_32_200_c
    Replica

    integer

    網關副本數。

    1
    GmtCreate

    string

    網關裝置的建立時間，GMT 格式，是使用者所在地的當地時間。

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

    string

    最後一次更新執行個體的時間。

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

    object

    XTrace 詳情。

    Sample

    integer

    XTrace 採樣率。

    10
    TraceOn

    boolean

    是否開啟 XTrace 採樣。

    true
    Vswitch2

    string

    交換器 2。

    vpc-bp1j6ivhav15ve7q54kq2
    InstanceId

    string

    執行個體 ID。

    mse-cn-st21ri2****
    ChargeType

    string

    付費模式，包括訂用帳戶和隨用隨付。

    POSTPAY
    EndDate

    string

    網關結束時間。

    2021-08-01 00:00:00
    StatusDesc

    string

    狀態原因。

    正在重啟中。
    LogConfigDetails

    object

    日誌配置。

    LogEnabled

    boolean

    是否開啟日誌投遞

    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

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6",
  "HttpStatusCode": 200,
  "Message": "請求處理成功",
  "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": 1,
    "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": "正在重啟中。",
    "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 status code

    錯誤碼

    錯誤資訊

    描述
    400 IllegalRequest Invalid request:%s 非法請求： %s
    400 InvalidParameter Parameter error:%s 請求參數錯誤：%s
    500 InternalError Console error. Try again later:%s 控制台錯誤.稍後重試：%s
    403 NoPermission You are not authorized to perform this operation:%s 沒有許可權使用此介面：%s
    404 NotFound Not found:%s 資源不存在：%s

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。