文档

ListIpv4Gateways - 查询IPv4网关实例的列表信息

更新时间:

调用ListIpv4Gateways接口查询IPv4网关实例的列表信息。

调试

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

授权信息

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

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

请求参数

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

要查询的 IPv4 网关列表信息的地域 ID。

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

ap-southeast-6
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 10

10
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
VpcIdstring

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

vpc-5tsrxlw7dv074gci4****
Ipv4GatewayIdstring

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

ipv4gw-5tsnc6s4ogsedtp3k****
Ipv4GatewayNamestring

要查询的 IPv4 网关实例的名称。

名称长度为 1~128 个字符,不能以http://https://开头。

name
ResourceGroupIdstring

IPv4 网关所属的资源组 ID。

rg-bp67acfmxazb4ph****
Tagsobject []

标签列表信息。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

请求 ID。

2D265800-E306-529C-8418-84B0A1D201DB
TotalCountstring

列表条目数。

1
Ipv4GatewayModelsobject []

IPv4 网关实例的列表信息。

VpcIdstring

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

vpc-5tsrxlw7dv074gci4****
Statusstring

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

  • Creating:创建中。
  • Created:已创建,可用状态。
  • Modifying:修改中。
  • Deleting:删除中。
  • Deleted:已删除。
Created
Ipv4GatewayIdstring

IPv4 网关的实例 ID。

ipv4gw-5tsnc6s4ogsedtp3k****
Ipv4GatewayDescriptionstring

IPv4 网关实例的描述信息。

test
Enabledboolean

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

  • true;已激活。
  • false:未激活。
true
GmtCreatestring

IPv4 网关创建时间

2021-12-02T07:07:35Z
Ipv4GatewayRouteTableIdstring

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

vtb-5ts0ohchwkp3dydt2****
Ipv4GatewayNamestring

IPv4 网关实例的名称。

name
ResourceGroupIdstring

IPv4 网关所属的资源组 ID。

rg-bp67acfmxazb4ph****
Tagsobject []

标签列表。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

FinanceJoshua

示例

正常返回示例

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "2D265800-E306-529C-8418-84B0A1D201DB",
  "TotalCount": "1",
  "Ipv4GatewayModels": [
    {
      "VpcId": "vpc-5tsrxlw7dv074gci4****",
      "Status": "Created",
      "Ipv4GatewayId": "ipv4gw-5tsnc6s4ogsedtp3k****",
      "Ipv4GatewayDescription": "test",
      "Enabled": true,
      "GmtCreate": "2021-12-02T07:07:35Z",
      "Ipv4GatewayRouteTableId": "vtb-5ts0ohchwkp3dydt2****",
      "Ipv4GatewayName": "name",
      "ResourceGroupId": "rg-bp67acfmxazb4ph****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈