NAT网关
NAT网关
文档指南
请输入
- 文档首页
NAT网关API参考SNAT规则DescribeSnatEntries - 查询SNAT规则
复制全文
下载 pdfDescribeSnatEntries - 查询SNAT规则
文档反馈
问问助手调用 DescribeSnatEntries 接口，查询满足指定条件的SNAT规则。
使用说明
传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的SNAT规则，若没有符合条件的SNAT规则，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有SNAT规则。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeSnatEntries
要执行的操作，取值：DescribeSnatEntries。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
EipId string 可选 示例值：eip-2a3d4c5a837****
SNAT规则使用的公网IP的ID，多个公网IP的ID之间用英文逗号分隔。
- 传入单个公网IP的ID，返回该公网IP关联的所有SNAT规则。
- 传入多个公网IP的ID，只要SNAT规则关联了其中某个或某几个公网IP，都会返回。
PageSize integer 可选 示例值：20
分页查询时每页的行数，取值：1 ~ 100，默认值为20。
PageNumber integer 可选 示例值：1
列表的页码，默认值为1。
SourceCidr string 可选 示例值：192.XX.XX.0/24
SNAT规则对应的网段。
SnatEntryName string 可选 示例值：snat-01
SNAT规则的名称。
NatIpId string 可选 示例值：vpcnatip-gw8y7q3cpk3fggs8****
SNAT规则使用的中转IP的ID。
NatGatewayId string 可选 示例值：ngw-2fedgzyvtzaio59gp675l****
NAT网关的ID。
SnatEntryIds.N string[] 可选 示例值：snat-2fedi22b12iv459gp68****
SNAT规则的ID。
- 参数 - N：表示SNAT规则ID的序号，单次调用数量上限20个ID。
- 多个ID之间请使用&分隔。
返回参数
PageNumber integer 示例值：1
当前分页的页码。
RequestId string 示例值：2021062415303301022514515207C4****
请求ID。
PageSize integer 示例值：20
当前分页的行数。
TotalCount integer 示例值：33
符合条件的SNAT规则总数。
SnatEntries object[] 示例值：-
SNAT的详细信息。
NatGatewayId string 示例值：ngw-2feq5xhimd88w59gp687****
SNAT规则所属NAT网关的ID。
SnatEntryId string 示例值：snat-2fedhzdlyknb459gp676o****
SNAT规则的ID。
SnatEntryName string 示例值：snat-02
SNAT规则的名称。
SubnetId string 示例值：subnet-2fe1vklp295a859gp6766****
SNAT规则关联子网的ID。
SourceCidr string 示例值：192.XX.XX.0/24
SNAT规则对应的网段。
EipId string 示例值：eip-2feaac9wtccn459gp67qe****
SNAT规则使用的公网IP的ID。
- 返回单个公网IP的ID。
- 返回多个公网IP的ID。
EipAddress string 示例值：180.XX.XX.69
SNAT规则使用的公网IP的IP地址。
- 返回单个公网IP的IP地址。
- 返回多个公网IP的IP地址。
Status string 示例值：Available
SNAT规则的状态。
- Available：可用。
- Creating：创建中。
- Deleting：删除中。
NatIpId string 示例值：vpcnatip-gw8y7q3cpk3fggs8****
私网NAT网关的中转IP的ID。
请求示例
GET /?Action=DescribeSnatEntries&Version=2020-04-01&SnatEntryIds.1=snat-2fedi22b12iv459gp68****&NatGatewayId=ngw-2fedgzyvtzaio59gp675l**** HTTP/1.1
Host: natgateway.cn-beijing.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":"192.XX.XX.0/24",
"EipId": "eip-ac321ea98****,eip-ac321ea98****",
"EipAddress": "180.XX.XX.69,180.XX.XX.68",
"Status": "Available",
"NatIpId": ""
},
{
"NatGatewayId": "ngw-2feq5xhimd88w59gp687****"
"SnatEntryId": "snat-2fedhzdlyknb459gp676o****",
"SnatEntryName": "snat-02",
"SubnetId": "subnet-2fe1vklp295a859gp6766****",
"SourceCidr":" ",
"EipId": "eip-2feaac9wtccn459gp67qe****",
"EipAddress": "180.XX.XX.69",
"Status": "Available",
"NatIpId": "vpcnatip-gw8y7q3cpk3fggs8****"
}
]
}
}
错误码
最近更新时间：2025.11.30 15:42:25
这个页面对您有帮助吗？
有用
有用
无用
无用