GetGateway - 查询网关详情_API 网关(API Gateway)-阿里云帮助中心

获取网关的所属VPC，所属交换机, 网关入口等基本信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apig:GetGateway	get	*Gateway `acs:apig:{#regionId}:{#accountId}:gateway/{#GatewayId}`	无	无

请求语法

GET /v1/gateways/{gatewayId} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
gatewayId	string	否	云原生 API 网关 ID。	gw-cpv4sqdl*****

返回参数

名称	类型	描述	示例值
	object	响应数据。
requestId	string	请求 ID。	0F138FFC-6E2B-56C1-9BAB-A67462E339D1
code	string	响应状态码。	Ok
message	string	响应消息。	success
data	object	响应数据。
gatewayId	string	网关 ID。	gw-cq2vundlhtg***
name	string	网关名称。	itemcenter-gateway
chargeType	string	付费类型 POSTPAY 后付费（按量付费） PREPAY 预付费（包年包月）	POSTPAY
status	string	网关状态: Running: 运行中。 Creating: 创建中。 CreateFailed: 创建失败。 Upgrading: 升级中。 UpgradeFailed: 升级失败。 Restarting: 重启中。 RestartFailed: 重启失败。 Deleting: 释放中。 DeleteFailed: 释放失败。	Running
spec	string	网关规格: apigw.small.x1: 小规格。	apigw.small.x1
replicas	string	网关实例节点数。	2
createTimestamp	long	创建时间戳。单位：毫秒。	1719386834548
updateTimestamp	long	更新时间戳。单位：毫秒。	1719386834548
expireTimestamp	long	包年包月到期时间戳。单位: 毫秒。	1719386834548
createFrom	string	网关创建来源: Console: 控制台。	Console
version	string	网关版本。	2.0.2
targetVersion	string	网关的目标版本。当和 version 不一致时, 可以进行版本升级。	2.0.2
environments	array<object>	网关关联的环境列表。
environment	object	环境信息。
environmentId	string	环境 ID。	env-cp9uhudlht***
name	string	环境名称。	default-gw-cp9ugg5***
alias	string	环境别名	默认环境
securityGroup	object	网关的安全组。
securityGroupId	string	安全组 ID。	sg-bp16tafq9***
name	string	安全组名称。	APIG-sg-gw-cq7ke5ll***
vSwitch	object	网关关联的虚拟交换机。
name	string	虚拟交换机名称。	杭州VPC虚拟交换机
vSwitchId	string	虚拟交换机 ID。	vsw-bp1c7ggkj***
vpc	object	网关关联的专有网络。
name	string	VPC 网关名称。	杭州VPC
vpcId	string	VPC 网络 ID。	vpc-bp1llj52lvj6xc***
zones	array<object>	网关关联的可用区列表。
zone	object	可用区信息。
zoneId	string	可用区 ID。	cn-hangzhou-e
name	string	可用区名称。	杭州可用区E
vSwitch	object	虚拟交换机。
vSwitchId	string	虚拟交换机 ID。	vsw-bp1c7ggkj***
name	string	虚拟交换机名称。	杭州VPC虚拟交换机
loadBalancers	array<object>	网关的入口地址列表。
loadBalancer	object	入口地址信息。
loadBalancerId	string	负载均衡 ID。	nlb-xoh3pghru7c***
addressType	string	负载均衡地址类型: Internet: 公网。 Intranet: 私网。	Internet
status	string	负载均衡的状态: Ready: 可用。 NotCreate: 未关联实例。	Ready
type	string	负载均衡类型 NLB: 网络型负载均衡。 CLB: 传统型负载均衡。	NLB
address	string	负载均衡地址。	nlb-xoh3pghr***.cn-hangzhou.nlb.aliyuncs.com
addressIpVersion	string	协议版本: ipv4: ipv4 类型。 ipv6: ipv6 类型。	ipv4
mode	string	网关的负载均衡提供模式: Managed: 云原生 API 网关管理的。	Managed
gatewayDefault	boolean	是否是网关默认的入口地址。	true
ports	array<object>	监听的端口列表。
port	object	端口信息。
protocol	string	协议: TCP UDP	TCP
port	integer	端口号。	443
resourceGroupId	string	资源组 ID	rg-acfm2ij6pwxsvua
tags	array<object>	资源标签。
tag	object	资源标签。
key	string	资源标签 key 值。	owner
value	string	资源标签 value 值。	zhangsan

示例

正常返回示例

JSON格式

{
  "requestId": "0F138FFC-6E2B-56C1-9BAB-A67462E339D1",
  "code": "Ok",
  "message": "success",
  "data": {
    "gatewayId": "gw-cq2vundlhtg***",
    "name": "itemcenter-gateway",
    "chargeType": "POSTPAY",
    "status": "Running",
    "spec": "apigw.small.x1",
    "replicas": "2",
    "createTimestamp": 1719386834548,
    "updateTimestamp": 1719386834548,
    "expireTimestamp": 1719386834548,
    "createFrom": "Console",
    "version": "2.0.2",
    "targetVersion": "2.0.2",
    "environments": [
      {
        "environmentId": "env-cp9uhudlht***",
        "name": "default-gw-cp9ugg5***",
        "alias": "默认环境"
      }
    ],
    "securityGroup": {
      "securityGroupId": "sg-bp16tafq9***",
      "name": "APIG-sg-gw-cq7ke5ll***"
    },
    "vSwitch": {
      "name": "杭州VPC虚拟交换机",
      "vSwitchId": "vsw-bp1c7ggkj***"
    },
    "vpc": {
      "name": "杭州VPC",
      "vpcId": "vpc-bp1llj52lvj6xc***"
    },
    "zones": [
      {
        "zoneId": "cn-hangzhou-e",
        "name": "杭州可用区E",
        "vSwitch": {
          "vSwitchId": "vsw-bp1c7ggkj***",
          "name": "杭州VPC虚拟交换机\n"
        }
      }
    ],
    "loadBalancers": [
      {
        "loadBalancerId": "nlb-xoh3pghru7c***",
        "addressType": "Internet",
        "status": "Ready",
        "type": "NLB",
        "address": "nlb-xoh3pghr***.cn-hangzhou.nlb.aliyuncs.com",
        "addressIpVersion": "ipv4",
        "mode": "Managed",
        "gatewayDefault": true,
        "ports": [
          {
            "protocol": "TCP",
            "port": 443
          }
        ]
      }
    ],
    "resourceGroupId": "rg-acfm2ij6pwxsvua",
    "tags": [
      {
        "key": "owner",
        "value": "zhangsan"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-11-21	OpenAPI 返回结构发生变更	查看变更详情
2024-11-20	OpenAPI 返回结构发生变更	查看变更详情