文档

GetIpv4GatewayAttribute - 查询指定的IPv4网关属性

更新时间:

调用GetIpv4GatewayAttribute接口

调试

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

授权信息

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

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

请求参数

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

要查询 IPv4 网关实例的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

ap-southeast-6
Ipv4GatewayIdstring

要查询的 IPv4 网关的实例 ID。

ipv4gw-5tsnc6s4ogsedtp3k****

返回参数

名称类型描述示例值
object

查询的 IPv4 网关实例的详细信息。

VpcIdstring

IPv4 网关实例关联的 VPC 的 ID。

vpc-5tsrxlw7dv074gci4****
Statusstring

IPv4 网关实例的状态。取值:

  • Creating:创建中。

  • Created:已创建,可用状态。

  • Modifying:修改中。

  • Deleting:删除中。

  • Deleted:已删除。

  • Activating:使能中。

Created
Ipv4GatewayIdstring

IPv4 网关的实例 ID。

ipv4gw-5tsnc6s4ogsedtp3k****
RequestIdstring

请求 ID。

7F79A919-6FE9-50C4-967B-45705E1F9C38
Ipv4GatewayDescriptionstring

IPv4 网关实例的描述信息。

new
Enabledboolean

IPv4 网关是否已经激活。取值:

  • true:已激活。

  • false:未激活。

true
Ipv4GatewayRouteTableIdstring

IPv4 网关实例关联的路由表 ID。

vtb-5ts0ohchwkp3dydt2****
Ipv4GatewayNamestring

IPv4 网关的实例名称。

name
CreateTimestring

创建时间。

2022-02-24T09:02:36Z
ResourceGroupIdstring

IPv4 网关所属的资源组 ID。

rg-bp67acfmxazb4ph****
Tagsobject []

标签列表信息。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

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错误码错误信息描述
400ResourceNotFound.Ipv4GatewayThe specified resource ipv4Gateway is not found.未找到指定的Ipv4网关,无法删除

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

变更历史

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