文档

DescribeGateway - 查看私有网关详情

更新时间:

查看私有网关详情。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eas:DescribeGatewayRead
  • Gateway
    acs:eas:{#regionId}:{#accountId}:gateway/{#GatewayId}

请求语法

GET /api/v2/gateways/{ClusterId}/{GatewayId}

请求参数

名称类型必填描述示例值
ClusterIdstring

私有网关所在地域。

cn-wulanchabu
GatewayIdstring

私有网关 ID。如何获取私有网关 ID,请参见 ListResources 接口返回结果中的 private_gateway_id 字段。

gw-1uhcqmsc7x22******

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

40325405-579C-4D82****
Regionstring

私有网关所在地域。

cn-wulanchabu
GatewayIdstring

私有网关 ID。

gw-1uhcqmsc7x22******
CreateTimestring

私有网关创建时间。使用 UTC 时间。

2020-05-19T14:19:42Z
UpdateTimestring

私有网关更新时间。使用 UTC 时间。

2021-02-24T11:52:17Z
IntranetEnabledboolean

内网访问是否开启。

true
IntranetDomainstring

内网访问域名。

gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com
InternetEnabledboolean

公网访问是否开启。

true
InternetDomainstring

公网访问域名。

gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com
InstanceTypestring

私有网关使用的机型。

ecs.r7.4xlarge
ParentUidstring

创建私有网关账号的主账号 UID。

11234*******
CallerUidstring

创建私有网关账号的 UID。

20123*******
Statusstring

私有网关状态。

PrivateGatewayRunning
IntranetLinkedVpcListobject []

内网访问端点列表。

VpcIdstring

专有网络的 ID。

vpc-bp1g11zvka6zr3i******
VSwitchIdstring

虚拟交换机 ID。

vsw-bp1txzxsdck43pp******
Ipstring

Ip 地址。

192.168.10.11
Statusstring

状态。可能值:

  • Creating:创建中。
  • Running:运行中。
Running
SecurityGroupIdstring

安全组 ID。

sg-2ze4pgstgszvgq******
InternetAclPolicyListobject []

公网访问控制策略列表。

Entrystring

允许访问的 IP 段。

192.168.1.1/32
Statusstring

状态。

枚举值:
  • Creating创建中
  • Running运行中
Running
Commentstring

说明。

test
GatewayNamestring

私有网关别名。

mygateway1
ExternalClusterIdstring

自运维集群 ID。

c935eadf284c14c2da57a2a13ad6******

示例

正常返回示例

JSON格式

{
  "RequestId": "40325405-579C-4D82****",
  "Region": "cn-wulanchabu",
  "GatewayId": "gw-1uhcqmsc7x22******",
  "CreateTime": "2020-05-19T14:19:42Z",
  "UpdateTime": "2021-02-24T11:52:17Z",
  "IntranetEnabled": true,
  "IntranetDomain": "gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com",
  "InternetEnabled": true,
  "InternetDomain": "gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com",
  "InstanceType": "ecs.r7.4xlarge\n",
  "ParentUid": "11234*******",
  "CallerUid": "20123*******",
  "Status": "PrivateGatewayRunning",
  "IntranetLinkedVpcList": [
    {
      "VpcId": "vpc-bp1g11zvka6zr3i******",
      "VSwitchId": "vsw-bp1txzxsdck43pp******",
      "Ip": "192.168.10.11",
      "Status": "Running",
      "SecurityGroupId": "sg-2ze4pgstgszvgq******"
    }
  ],
  "InternetAclPolicyList": [
    {
      "Entry": "192.168.1.1/32",
      "Status": "Running",
      "Comment": "test"
    }
  ],
  "GatewayName": "mygateway1",
  "ExternalClusterId": "c935eadf284c14c2da57a2a13ad6******"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈