DescribeSnatEntries--NAT网关-火山引擎

文档中心

立即注册

导航

DescribeSnatEntries

最近更新时间：2024.07.09 08:36:55首次发布时间：2021.12.28 08:28:52

调用 DescribeSnatEntries 接口，查询满足指定条件的SNAT规则。

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的SNAT规则，若没有符合条件的SNAT规则，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有SNAT规则。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSnatEntries	要执行的操作，取值：DescribeSnatEntries。
Version	String	是	2020-04-01	API的版本信息，当前版本为：2020-04-01。
NatGatewayId	String	否	ngw-dukg5oxruw****	NAT网关的ID。
SnatEntryIds.N	String	否	SnatEntryIds.1=snat-3a4b**&SnatEntryIds.2=snat-5b4d7f**	SNAT规则的ID。参数 - N：表示SNAT规则ID的序号，单次调用数量上限20个ID。多个ID之间请使用&分隔。
SnatEntryName	String	否	test-snat	SNAT规则的名称。
SubnetId	String	否	subnet-9f33a3bdc24****	SNAT规则关联子网的ID。您可以调用 DescribeSubnets 接口，查询子网的ID。
SourceCidr	String	否	192.XX.XX.0/24	SNAT规则对应的网段。
EipId	String	否	eip-2a3d4c5a837**,eip-2a3d4c5a838**	SNAT规则使用的公网IP的ID，多个公网IP的ID之间用英文逗号分隔。您可以调用 DescribeEipAddresses 接口，查询公网IP的ID。传入单个公网IP的ID，返回该公网IP关联的所有SNAT规则。传入多个公网IP的ID，只要SNAT规则关联了其中某个或某几个公网IP，都会返回。
NatIpId	String	否	vpcnatip-gw8y7q3cpk3fggs8****	SNAT规则使用的中转IP的ID。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数，取值：1 ~ 100，默认值为20。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
PageNumber	Integer	1	当前分页的页码。
PageSize	Integer	20	当前分页的行数。
TotalCount	Integer	33	符合条件的SNAT规则总数。
SnatEntries	Array of struct	-	SNAT的详细信息。具体请参见下表“ SnatEntries结构 ”。

SnatEntries结构

参数名称	类型	示例值	描述
NatGatewayId	String	ngw-12efghxs78ac3d****	SNAT规则所属NAT网关的ID。
SnatEntryId	String	snat-3a4b5cd9****	SNAT规则的ID。
SnatEntryName	String	testsnat	SNAT规则的名称。
SubnetId	String	subnet-32ac4df89q****	SNAT规则关联子网的ID。
SourceCidr	String	192.XX.XX.0/24	SNAT规则对应的网段。
EipId	String	eip-ac321ea98**,eip-ac321ea98**	SNAT规则使用的公网IP的ID。
EipAddress	String	180.XX.XX.69,180.XX.XX.68	SNAT规则使用的公网IP的IP地址。返回单个公网IP的IP地址。返回多个公网IP的IP地址。
NatIpId	String	vpcnatip-gw8y7q3cpk3fggs8****	SNAT规则使用的中转IP的ID。
Status	String	Available	SNAT规则的状态。 Available：可用。 Creating：创建中。 Deleting：删除中。

请求示例

GET /?Action=DescribeSnatEntries&Version=2020-04-01&SnatEntryIds.1=snat-2fedi22b12iv459gp68****&SnatEntryIds.2=snat-2fedhzdlyknb459gp676o****&NatGatewayId=ngw-2fedgzyvtzaio59gp675l**** HTTP/1.1
Host: open.volcengineapi.com
Service: natgateway
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeSnatEntries",
        "Version": "2020-04-01",
        "Service": "natgateway",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 20,
        "SnatEntries": [
            {
               "NatGatewayId": "ngw-2feq5xhimd88w59gp686****",
                "SnatEntryId": "snat-2fedi22b12iv459gp68****",
                "SnatEntryName": "snat-01",
                "SubnetId": "subnet-2fe1vf6cq44cg59gp687k****",
                "SourceCidr":" ",
                "EipId": "eip-ac321ea98****,eip-ac321ea98****",
                "EipAddress": "180.XX.XX.69,180.XX.XX.68",
                "NatIpId": "vpcnatip-gw8y7q3cpk3fggs8****",
                "Status": "Available"

            },
            {
                "NatGatewayId": "ngw-2feq5xhimd88w59gp687****"
                "SnatEntryId": "snat-2fedhzdlyknb459gp676o****",
                "SnatEntryName": "snat-02",
                "SubnetId": "subnet-2fe1vklp295a859gp6766****",
                "SourceCidr":" ",
                "EipId": "eip-2feaac9wtccn459gp67qe****",
                "EipAddress": "180.XX.XX.69",
                "NatIpId": "vpcnatip-gw8y7q3cpk3f1234****",
                "Status": "Available"
            }
        ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.SnatEntryId	You've reached the limit on the number of snat entry IDs that you can describe.	已达到可查询的SNAT规则ID数量上限。