Queries the attributes of an IPv4 gateway.

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
RegionId String Yes ap-southeast-6

The region ID of the IPv4 gateway.

You can call the DescribeRegions operation to query the most recent region list.

Ipv4GatewayId String Yes ipv4gw-5tsnc6s4ogsedtp3k****

The ID of the IPv4 gateway.

Action String Yes GetIpv4GatewayAttribute

The operation that you want to perform. Set the value to GetIpv4GatewayAttribute.

Response parameters

Parameter Type Example Description
VpcId String vpc-5tsrxlw7dv074gci4****

The ID of the virtual private cloud (VPC) with which the IPv4 gateway is associated.

Status String Created

The status of the IPv4 gateway. Valid values:

  • Creating
  • Created
  • Modifying
  • Deleting
  • Deleted
  • Activating
Ipv4GatewayId String ipv4gw-5tsnc6s4ogsedtp3k****

The ID of the IPv4 gateway.

RequestId String 7F79A919-6FE9-50C4-967B-45705E1F9C38

The ID of the request.

Ipv4GatewayDescription String new

The description of the IPv4 gateway.

Enabled Boolean true

Indicates whether the IPv4 gateway is activated. Valid values:

  • true: yes
  • false: no
Ipv4GatewayRouteTableId String vtb-5ts0ohchwkp3dydt2****

The ID of the route table associated with the IPv4 gateway.

Ipv4GatewayName String name

The name of the IPv4 gateway.

CreateTime String 2022-02-24T09:02:36Z

The time when the IPv4 gateway was created.

ResourceGroupId String rg-bp67acfmxazb4ph****

The ID of the resource group to which the IPv4 gateway belongs.

Tags Array of Tag

The tag list.

Key String FinanceDept

The tag key.

Value String FinanceJoshua

The tag value.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=ap-southeast-6
&Ipv4GatewayId=ipv4gw-5tsnc6s4ogsedtp3k****
&Action=GetIpv4GatewayAttribute
&Common request parameters

Sample success responses

XML format

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

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

JSON format

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

Error codes

HttpCode Error code Error message Description
400 ResourceNotFound.Ipv4Gateway The specified resource ipv4Gateway is not found. The error message returned because the specified IPv4 gateway is not found and cannot be found .

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