All Products
Search
Document Center

Virtual Private Cloud:GetIpv4GatewayAttribute

Last Updated:Mar 01, 2024

Queries an IPv4 gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:GetIpv4GatewayAttributeRead
  • Ipv4Gateway
    acs:vpc:{#regionId}:{#accountId}:ipv4gateway/{#Ipv4GatewayId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the IPv4 gateway.

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

ap-southeast-6
Ipv4GatewayIdstringYes

The ID of the IPv4 gateway.

ipv4gw-5tsnc6s4ogsedtp3k****

Response parameters

ParameterTypeDescriptionExample
object

The details of the IPv4 gateway.

VpcIdstring

The ID of the VPC with which the IPv4 gateway is associated.

vpc-5tsrxlw7dv074gci4****
Statusstring

The status of the IPv4 gateway. Valid values:

  • Creating
  • Created
  • Modifying
  • Deleting
  • Deleted
  • Activating
Created
Ipv4GatewayIdstring

The ID of the IPv4 gateway.

ipv4gw-5tsnc6s4ogsedtp3k****
RequestIdstring

The request ID.

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

The description of the IPv4 gateway.

new
Enabledboolean

Indicates whether the IPv4 gateway is activated. Valid values:

  • true
  • false
true
Ipv4GatewayRouteTableIdstring

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

vtb-5ts0ohchwkp3dydt2****
Ipv4GatewayNamestring

The name of the IPv4 gateway.

name
CreateTimestring

The time when the IPv4 gateway was created.

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

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

rg-bp67acfmxazb4ph****
Tagsobject []

The tag list.

Keystring

The key of tag N added to the resource.

FinanceDept
Valuestring

The value of tag N added to the resource.

FinanceJoshua

Examples

Sample success responses

JSONformat

{
  "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

HTTP status codeError codeError messageDescription
400ResourceNotFound.Ipv4GatewayThe specified resource ipv4Gateway is not found.The IPv4 gateway is not found and cannot be deleted.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history