DescribeNatGatewayAttributes--NAT网关-火山引擎

文档中心

立即注册

导航

DescribeNatGatewayAttributes

最近更新时间：2024.09.29 11:40:32首次发布时间：2021.12.28 08:28:52

调用 DescribeNatGatewayAttributes 接口，查看NAT网关详情。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeNatGatewayAttributes	要执行的操作，取值：DescribeNatGatewayAttributes。
Version	String	是	2020-04-01	API的版本信息，当前版本为：2020-04-01。
Version	String	是	2020-04-01	API的版本信息，当前版本为：2020-04-01。
NatGatewayId	String	是	ngw-vv3t043k05sm****	NAT网关的ID。您可以调用 DescribeNatGateways 接口，查询NAT网关的ID。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
NetworkType	String	internet	NAT网关类型。 internet：公网NAT网关。 intranet：私网NAT网关。
NatGatewayId	String	ngw-3tex2x1cwd4c6c0v****	NAT网关的ID。
NatGatewayName	String	a-simple-nat	NAT网关的名称。
Description	String	A simple nat test	NAT网关的描述信息。
Spec	String	Medium	NAT网关的规格。 Small：小型。 Medium：中型。 Large：大型。
BillingType	Integer	2	NAT网关计费方式。 1：包年包月。 2：按量计费-按规格计费。 3：按量计费-按使用量计费。
EipAddresses	Array of struct	-	NAT网关绑定公网IP的信息。具体请参见下表“ EipAddresses结构 ”。
VpcId	String	vpc-7dk2hs5smt0bu****	NAT网关所属私有网络的ID。
SubnetId	String	subnet-mj6v3t43k05s****	NAT网所属子网的ID。
ZoneId	string	cn-beijing-a	NAT网关所属主可用区的ID。
NetworkInterfaceId	String	eni-2dffi32452fcv2****	NAT网关占用的网卡ID。
ProjectName	String	Project_1	NAT网关所属项目的名称。
Tags	Array of struct	-	NAT网关的标签信息。具体请参见下表“Tags结构”。
Status	String	Available	NAT网关的状态。 Available：可用。 Creating：创建中。 Pending：操作中。 Deleting：删除中。
BusinessStatus	String	Normal	NAT网关是否被锁定。空值：正常未被锁定。 Normal：正常未被锁定。 FinancialLocked：因欠费被锁定。
LockReason	String	financial	NAT被锁定的原因。 financial：因欠费被锁定。 security：因安全原因被锁定。
CreationTime	String	2021-11-30T16:59:27+08:00	NAT网关的创建时间。
UpdatedAt	String	2021-12-06T18:26:27+08:00	NAT网关的最后操作时间。
ExpiredTime	String	2021-05-07 23:59:59	包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
OverdueTime	String	2021-12-06 18:26:27	资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。
DeletedTime	String	2021-12-21 18:26:27	预期资源强制回收时间。包年包月NAT网关，此参数有返回值。按量计费NAT网关，仅欠费冻结时，此参数有返回值。

EipAddresses结构

参数名称	类型	示例值	描述
AllocationId	String	eip-rs59q8hqtaf****	公网IP的ID。
EipAddress	String	121.XX.XX.52	公网IP的地址。
UsingStatus	String	Idle	公网IP的使用状态。 Idle：未使用。 UsedBySnat：被SNAT规则使用。 UsedByDnat：被DNAT规则使用。 UsedByNat：被SNAT/DNAT规则同时使用

参数名称

类型

示例值

描述

AllocationId

String

eip-rs59q8hqtaf****

公网IP的ID。

EipAddress

String

121.XX.XX.52

公网IP的地址。

UsingStatus

String

Idle

公网IP的使用状态。

Idle：未使用。
UsedBySnat：被SNAT规则使用。
UsedByDnat：被DNAT规则使用。
UsedByNat：被SNAT/DNAT规则同时使用

Tags结构

参数名称	类型	示例值	描述
Key	String	k1	标签键。
Value	String	v1	标签值。

请求示例

GET /?Action=DescribeNatGatewayAttributes&Version=2020-04-01&NatGatewayId=ngw-2fesmko5zhdz459gp67sc**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: natgateway
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeNatGatewayAttributes",
        "Version": "2020-04-01",
        "Service": "natgateway",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "NetworkType": "internet",
        "NatGatewayId": "ngw-2feq5xhimd88w59gp686****",
        "NatGatewayName": "nat-01",        
        "Description": "This is a nat",        
        "Spec": "Small",        
        "BillingType": 2,       
        "EipAddresses": [
            {
                "AllocationId": "eip-2fejrf9qxlla859gp6850****",
                "EipAddress": "180.XX.XX.79",
                "UsingStatus": "UsedBySnat"
            }
        ],        
        "VpcId": "vpc-2feacqu7h3klc59gp67u3****",
        "SubnetId": "subnet-2feacrhvug8ao59gp671b****",
        "ZoneId": "cn-beijing-a",
        "NetworkInterfaceId": "eni-2fesmkw23xlvk59gp67g9****",  
        "SnatEntryIds":[
            "snat-3fvhk47kf56****",
            "snat-3fvhk47kf78****"
         ],  
        "DnatEntryIds":[
            "dnat-342abc3bc3****",
            "dnat-342abc3bd4****"
        ],      
        "ProjectName": "Project_1",
        "Tags":[
            {
                 "Key":"k1",
                 "Value":"v1"
            },
            {
                 "Key":"k2",
                 "Value":""
             }
         ] 
        "Status": "Available",
        "BusinessStatus": "FinancialLocked",
        "LockReason": "financial",
        "CreationTime": "2021-11-30T16:59:27+08:00",
        "UpdatedAt": "2021-12-06T18:26:27+08:00",
        "ExpiredTime":"",
        "OverdueTime": "2021-12-06 18:26:27",
        "DeletedTime": "2021-12-21 18:26:27"
      
    }
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
404	InvalidNatGateway.NotFound	The specified NAT gateway does not exist.	指定的NAT网关不存在。