接口功能介绍
查询SNAT规则
接口约束
已创建私网NAT实例
接口是否审批
否
URI
GET /v4/privatenat/list-snats
Content-Type
application/json
路径参数
无
Query参数
| Query参数 | 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域id | 81f7728662dd11ec810800155d307d5b | |
| natGatewayID | 是 | String | 要查询的私网NAT的ID。 | ngw-bp1uewa15k4iy5770 | |
| snatID | 否 | String | SNAT规则的ID |
请求头header参数
无
请求体body参数
无
响应参数
| 响应参数 | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | ||
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | ||
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | ||
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS | ||
| returnObj | Array of Objects | 返回结果 | returnObj |
| 表 returnObj | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| snatID | String | SNAT规则的ID | natgwsr-xxxxxx | ||
| srcCIDR | String | 源地址段 | 192.168.1.0/24 | ||
| srcVpcName | String | 源vpc名称 | vpc-name | ||
| srcSubnetID | String | 源Subnet的ID | subnet-xxxxx | ||
| srcSubnetName | String | 源Subnet名称 | subnet-name | ||
| addresses | Array of Strings | 中转IP地址 | ["192.168.1.1"] | ||
| description | String | 描述 | 这是一个描述 | ||
| state | String | SNAT状态: running代表运行中, freeze代表已冻结, expired代表已到期 | running |
枚举参数
无
请求头header示例
无
请求url示例
GET /v4/privatenat/list-snats?regionID=81f7728662dd11ec810800155d307d5b&natGatewayID=natgw-bp1uewa15k4
请求体body示例
无
响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description":"",
"returnObj":[
{
"snatID":"sgr-xxxx",
"srcCIDR":"192.168.1.0/24",
"srcVpcName":"vpc-name",
"srcSubnetID":"subnet-xxxxx",
"srcSubnetName":"subnet-name",
"addresses":[
"192.168.1.2",
"192.168.3.55"
],
"description":"This is a description",
"state":"running",
"createdAt":"2022-10-02T02:29:43Z"
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
请参考 错误码说明。
