调用GetIpv4GatewayAttribute查询指定的IPv4网关属性_专有网络VPC(VPC)-阿里云帮助中心

调用GetIpv4GatewayAttribute接口

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:GetIpv4GatewayAttribute	get	Ipv4Gateway acs:vpc:{#regionId}:{#accountId}:ipv4gateway/{#Ipv4GatewayId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	要查询 IPv4 网关实例的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	ap-southeast-6
Ipv4GatewayId	string	是	要查询的 IPv4 网关的实例 ID。	ipv4gw-5tsnc6s4ogsedtp3k****

返回参数

名称	类型	描述	示例值
	object	查询的 IPv4 网关实例的详细信息。
VpcId	string	IPv4 网关实例关联的 VPC 的 ID。	vpc-5tsrxlw7dv074gci4****
Status	string	IPv4 网关实例的状态。取值： Creating：创建中。 Created：已创建，可用状态。 Modifying：修改中。 Deleting：删除中。 Deleted：已删除。 Activating：使能中。	Created
Ipv4GatewayId	string	IPv4 网关的实例 ID。	ipv4gw-5tsnc6s4ogsedtp3k****
RequestId	string	请求 ID。	7F79A919-6FE9-50C4-967B-45705E1F9C38
Ipv4GatewayDescription	string	IPv4 网关实例的描述信息。	new
Enabled	boolean	IPv4 网关是否已经激活。取值： true：已激活。 false：未激活。	true
Ipv4GatewayRouteTableId	string	IPv4 网关实例关联的路由表 ID。	vtb-5ts0ohchwkp3dydt2****
Ipv4GatewayName	string	IPv4 网关的实例名称。	name
CreateTime	string	创建时间。	2022-02-24T09:02:36Z
ResourceGroupId	string	IPv4 网关所属的资源组 ID。	rg-bp67acfmxazb4ph****
Tags	array<object>	标签列表信息。
Tag	object	标签列表信息。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceJoshua

示例

正常返回示例

JSON格式

{
  "VpcId": "vpc-5tsrxlw7dv074gci4****",
  "Status": "Created",
  "Ipv4GatewayId": "ipv4gw-5tsnc6s4ogsedtp3k****",
  "RequestId": "7F79A919-6FE9-50C4-967B-45705E1F9C38",
  "Ipv4GatewayDescription": "new",
  "Enabled": true,
  "Ipv4GatewayRouteTableId": "vtb-5ts0ohchwkp3dydt2****",
  "Ipv4GatewayName": "name",
  "CreateTime": "2022-02-24T09:02:36Z",
  "ResourceGroupId": "rg-bp67acfmxazb4ph****",
  "Tags": [
    {
      "Key": "FinanceDept",
      "Value": "FinanceJoshua"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	ResourceNotFound.Ipv4Gateway	The specified resource ipv4Gateway is not found.	未找到指定的Ipv4网关，无法删除

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史