文档中心 > DescribeNat
DescribeNat

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

请求方法:GET

接口描述: 调用DescribeNat接口获取Nat列表。


请求参数

Param

名称

类型

是否必选

描述

Action

String

要执行的操作,取值:DescribeNat。

RegionId

String

地域ID。

Page

Integer

当前页,默认为1。

Size

Integer

页数大小,默认10。

InstanceId

String

Nat的ID。

InstanceName

String

Nat的名称。

Status

String

Nat的状态。

EipId

String

EIP的ID。

VpcIds

String

VPC的ID。


返回参数

名称

类型

描述

RequestId

String

请求ID。

Code

String

操作结果编码。

Msg

String

操作结果描述。

Res

Object

请求结果。

+Page

Integer

当前页。

+Size

Integer

页数大小。

+Total

Long

总条数。

+Data

Object[]

响应数据。

++RegionId

String

区域ID。

++AzoneId

String

可用域ID。

++InstanceId

String

NAT的ID。

++InstanceName

String

NAT的名称。

++UserId

String

用户ID。

++Status

String

状态。

++VpcId

String

VPC的ID。

++VpcName

String

VPC的名称。

++CreatTime

String

创建时间。

++UpdateTime

String

修改时间。

++InstanceCode

String

规格码。

++Description

String

描述信息。

++InstanceOperationInfo

Object


++InstanceOperationType

Object


++EipList

String[]

绑定的EIP列表。


示例

请求示例

GET https://api.unicloud.com/networks/nat?Action=DescribeNat
&RegionId=cn-beijing
&Page=1
&Size=10
&InstanceId=nat-j6ub1cq7uwvl
&InstanceName=sdasads
&Status=RUNNING
&EipId=eip-33pehq1w5f9ob
&VpcIds=vpc-0uavwb2hgp4ob
&<公共请求参数>

返回示例

JSON 格式

{
   "Code": "Network.Success",
   "Msg": "操作成功",
   "RequestId": "7791624d-1314-423d-b058-18841d7b5860",
   "Res": {
       "page": 1,
       "size": 10,
       "total": 1,
       "data": [{
           "instanceId": "nat-j6ub1cq7uwvl",
           "instanceName": "sdasads",
           "regionId": "cn-beijing",
           "azoneId": "cn-beijing-a",
           "userId": "8d877350-504d-414f-9e24-c4b1305cb5e7",
           "status": "RUNNING",
           "vpcId": "vpc-0uavwb2hgp4ob",
           "vpcName": "lytest2",
           "createTime": "2020-09-09T17:37:21.300+0800",
           "updateTime": "2020-09-09T17:37:21.300+0800",
           "description": "sad",
           "instanceCode": "nat.normal",
           "instanceOperationInfo": {
               "operationStatus": 2,
               "rentCount": 50,
               "instanceName": "sdas",
               "orderId": 1303628546115539038,
               "rentUnit": "day",
               "regionName": "华北2-北京2",
               "chargeType": 0,
               "productGroupId": null,
               "payType": "DAY_TRIAL",
               "instanceReleaseTime": null,
               "userParentId": null,
               "turnFormalTime": null,
               "releaseType": null,
               "azId": "",
               "id": "nat-j6ub1cq7uwvl",
               "instanceLabel": 0,
               "instanceRestartTime": null,
               "productType": "instance",
               "isOld": 0,
               "isPay": 0,
               "instanceEndTime": 1603987200000,
               "instanceParentId": null,
               "formalPayTime": null,
               "updateTime": 1599697651000,
               "userName": "moove-test16",
               "instanceStartTime": 1599644242000,
               "renewType": 1,
               "dueTime": "2020-10-30",
               "closeType": null,
               "userId": "8d877350-504d-414f-9e24-c4b1305cb5e7",
               "instanceDescription": "sad",
               "instanceCloseTime": null,
               "isPayClose": false,
               "productCode": "NAT",
               "createTime": 1599644242000,
               "regionId": "cn-beijing",
               "az": null,
               "trialDescription": null
          },
           "instanceOperationType": {
               "specificationId": "1250335792471998464",
               "nat": null,
               "specificationClassCode": "natgw.standard",
               "componentCode": "NetworkAddressTranslation",
               "createTime": 1586938257698,
               "nat_eip_count": "5",
               "updateTime": 1589014863952,
               "_id": {
                   "timestamp": 1586938257,
                   "machineIdentifier": 10339834,
                   "processIdentifier": 8,
                   "counter": 6134247,
                   "time": 1586938257000,
                   "date": 1586938257000,
                   "timeSecond": 1586938257
              },
               "describe": "普通型NAT网关",
               "specificationCode": "nat.normal",
               "specificationName": "普通型"
          },
           "eipList": ["eip-33pehq1w5f9ob"]
      }]
  }
}