ListIpv4Gateways - - Alibaba Cloud ドキュメントセンター

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	ListIpv4Gateways	The operation that you want to perform. Set the value to ListIpv4Gateways.
RegionId	String	Yes	ap-southeast-6	The ID of the region where the IPv4 gateways to be queried are deployed. You can call the DescribeRegions operation to query the most recent region list.
MaxResults	Integer	No	10	The number of entries to return per page. Valid values: 1 to 100. Default value: 10.
NextToken	String	No	FFmyTO70tTpLG6I3FmYAXGKPd****	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.
VpcId	String	No	vpc-5tsrxlw7dv074gci4****	The ID of the virtual private cloud (VPC) with which the IPv4 gateway is associated.
Ipv4GatewayId	String	No	ipv4gw-5tsnc6s4ogsedtp3k****	The ID of the IPv4 gateway.
Ipv4GatewayName	String	No	name	The name of the IPv4 gateway. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.
ResourceGroupId	String	No	rg-bp67acfmxazb4ph****	The ID of the resource group to which the IPv4 gateway belongs.
Tags.N.Key	String	No	FinanceDept	The key of tag N to add to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string. The tag key can be at most 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.
Tags.N.Value	String	No	FinanceJoshua	The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag value cannot contain `http://` or `https://`.

Response parameters

Parameter	Type	Example	Description
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	A pagination token. It can be used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If the value returned of NextToken is not empty, the value indicates the token that is used for the next query.
RequestId	String	2D265800-E306-529C-8418-84B0A1D201DB	The request ID.
TotalCount	String	1	The number of entries returned.
Ipv4GatewayModels	Array of Ipv4GatewayModels		The list of IPv4 gateways.
VpcId	String	vpc-5tsrxlw7dv074gci4****	The ID of the VPC with which the IPv4 gateway is associated.
Status	String	Created	The status of the IPv4 gateway. Valid values: Creating Created Modifying Deleting Deleted
Ipv4GatewayId	String	ipv4gw-5tsnc6s4ogsedtp3k****	The ID of the IPv4 gateway.
Ipv4GatewayDescription	String	test	The description of the IPv4 gateway.
Enabled	Boolean	true	Indicates whether the IPv4 gateway is activated. Valid values: true false
GmtCreate	String	2021-12-02T07:07:35Z	The time when the IPv4 gateway was created.
Ipv4GatewayRouteTableId	String	vtb-5ts0ohchwkp3dydt2****	The ID of the route table associated with the IPv4 gateway.
Ipv4GatewayName	String	name	The name of the IPv4 gateway.
ResourceGroupId	String	rg-bp67acfmxazb4ph****	The ID of the resource group to which the IPv4 gateway belongs.
Tags	Array of Tag		The list of tags.
Key	String	FinanceDept	The key of tag N.
Value	String	FinanceJoshua	The value of tag N.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListIpv4Gateways
&RegionId=ap-southeast-6
&MaxResults=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&VpcId=vpc-5tsrxlw7dv074gci4****
&Ipv4GatewayId=ipv4gw-5tsnc6s4ogsedtp3k****
&Ipv4GatewayName=name
&ResourceGroupId=rg-bp67acfmxazb4ph****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/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"
    } ]
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.