备案 控制台 登录 注册
文档中心 > DescribeSnats
DescribeSnats

最近更新时间：2021-12-29

请求方法：GET

接口描述：使用DescribeSnats接口查询SNAT列表。


请求参数

Param

名称

类型

是否必选

描述

Action

String

是

要执行的操作。取值：   DescribeSnats。

RegionId

String

是

地域ID。

Page

Integer

否

当前页码，默认为1。

Size

Integer

否

每页数据条数，默认为10。

Paging

Boolean

否

是否分页，默认为分页（true）。

UserId

String

否

用户的ID。

NatId

String

否

NAT的ID。

Status

String[]

否

状态。


返回参数

名称

类型

描述

RequestId

String

请求ID。

Code

String

操作结果编码。

Msg

String

操作结果描述。

Res

Object

请求结果。

P

Integer

当前页码。

+Size

Integer

每页数据条数。

+Total

Long

总条数。

+Data

Object[]

响应结果。

++snatId

String

SNAT的ID。

++natId

String

NAT的ID。

++vpcId

String

VPC的ID。

++userId

String

用户的ID。

++eipId

String

EIP的ID。

++eipAddr

String

EIP的地址。

++status

String

状态。

++subnets

Object[]

子网信息。

+++subnetId

String

子网的ID。

+++cidr

String

子网的网段。


示例

请求示例

GET https://api.unicloud.com/networks/nat?Action=DescribeSnats

&RegionId=HB1-BJMY

&Page=1

&Size=10

&Paging=true

&UserId=8d877350-504d-414f-9e24-c4b1305cb5e7

&NatId=nat-j6ub1cq7uwvl

&Status=RUNNING

&<公共请求参数>

返回示例

JSON 格式

{

    "Code": "Network.Success",

    "Msg": "操作成功",

    "RequestId": "ef33dc8f-e269-4b11-b897-d62a37c89a03",

    "Res": {

        "page": 1,

        "size": 10,

        "total": 1,

        "data": [{

            "snatId": "snat-j8lg1udmxiaq",

            "natId": "nat-j6ub1cq7uwvl",

            "vpcId": "vpc-0uavwb2hgp4ob",

            "userId": "8d877350-504d-414f-9e24-c4b1305cb5e7",

            "eipId": "eip-33pehq1w5f9ob",

            "eipAddr": "101.65.1.213",

            "status": "RUNNING",

            "subnets": [{

                "subnetId": "59efb70c1a48422181c24533e53207e6",

                "cidr": "172.16.2.0/24"

            }]

        }]

}

}