接口功能介绍
查询 NAT 网关详情
接口约束
需要先创建 NAT 网关
URI
GET /v4/vpc/get-nat-gateway-attribute
请求参数
Query 参数
| 参数名 | 必选 | 类型 | 示例值 | 说明 |
|---|---|---|---|---|
| regionID | 是 | String | xx73f321ea-62ff-11ec-a8bc-005056898fe0 | 区域id |
| natGatewayID | 是 | String | ngw-bp1uewa15k4iy5770* | 要查询的NAT网关的ID。 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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 | Object | object | 返回结果 |
表 returnObj
| 参数名 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| name | String | Default-Security-Group | NAT网关实例名称。 |
| status | Integer | 2 | NAT 网关状态: 0 表示创建中，2 表示运行中，3 表示冻结 |
| state | String | running | NAT网关运行状态: running 表示运行中, creating 表示创建中, expired 表示已过期, freeze 表示已冻结 |
| zoneID | String | cn-beijing-1 | NAT网关所在的可用区ID。 |
| vpcID | String | vpc-bp1xxxt37pq72 | 要查询的NAT网关所属VPC的ID。 |
| projectID | String | default | 项目类型：default-企业项目 |
| vpcName | String | vpc-abc | NAT所属的专有网络名字。 |
| vpcCidr | String | 192.168.0.0/16 | 当前网关所属的vpc cidr。 |
| creationTime | String | 2022-06-28T12:19:43Z | NAT网关的创建时间。 |
| expiredTime | String | dasfsdf | NAT网关实例的过期时间。 |
| natGatewayID | String | ngw-bp1047e2d4z | NAT网关的ID。 |
| description | String | NAT | NAT网关实例的描述。。 |
| snatTable | object | - | SNAT列表信息。 |
| dnatTable | object | - | DNAT列表的信息。 |
表 dnatTable
| 参数名 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| creationTime | String | 2022-08-31T07:08:00.892Z | 创建时间。 |
| description | String | 4fc90292-5ab4-59bb-xxxx-8b9410df41f5 | 描述信息， |
| id | String | cn-beijing-1 | 当前dnat所属的nat网关id。 |
| dNatID | String | dnat-daljdfnm | dnatid值。 |
| ipExpireTime | String | 2022-08-31T07:08:00.892Z | ip到期时间。 |
| externalID | String | default | 弹性公网id |
| externalPort | String | default | 弹性公网端口 |
| externalIp | String | default | 弹性公网ip |
| internalPort | String | default | 当前所属的ip地址 |
| internalIp | String | 弹性公网IP | 安全组所属的专有网络。 |
| protocol | String | tcp | TCP:转发TCP协议的报文 UDP：转发UDP协议的报文。 |
| state | String | ACTIVE | 运行状态。 |
| virtualMachineName | String | ecm-9bdf | 虚拟机名称。 |
| virtualMachineID | String | 62dab755-1f54-b961-307e-4a0c84274a09 | 虚拟机id。 |
表 snatTable
| 参数名 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| id | String | stb-SnatTableI | 主键。 |
| sNatID | String | stb-SnatTableI | SNAT列表的ID。 |
| description | String | sdafsdf | 描述信息。 |
| status | String | ACTIVE | 状态: ACTIVE 表示运行中，Creating 表示创建中，Freezing 表示冻结 |
| vpcID | String | vpc-kxr0nuza1c | 要查询的NAT网关所属VPC的ID。 |
| vpcName | String | vpc-kxr0nuza1c | 要查询的NAT网关所属VPC的名称。 |
| vpcCidr | String | 192.168.0.0/16 | 要查询的NAT网关所属VPC的cidr。 |
| subnetCidr | String | 192.168.0.0/16 | 要查询的NAT网关所属VPC子网的cidr。 |
| subnetType | Integer | 1 | 子网类型：1-有vpcID的子网，0-自定义。 |
| creationTime | String | 2022-09-25T02:59:05.38Z | 创建时间。 |
| ipAddress | Object of Array | - | eip地址信息 |
表 ipAddress
| 参数名 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| ID | String | d71ff83e-18b1-5830-a6c9-ea7467132920 | 主键。 |
| ipAddress | String | 100.124.13.171 | eip所属的ip地址。 |
请求示例
GET /v4/vpc/get-nat-gateway-attribute?regionID=xxx&natGatewayID=xxxx
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": {
"ID": "f777a655-3c3b-4dde-821c-3a67dfe9f91b",
"name": "natgw-update444",
"description": "",
"status": 2,
"natGatewayID": "natgw-aoi5nfrks4",
"zoneID": "az1",
"state": "running",
"vpcID": "vpc-ucuf00lez0",
"vpcCidr": "vpc-ucuf00lez0",
"vpcName": "vpc-ysf",
"expireTime": "2022-10-27T01:35:04Z",
"creationTime": "2022-09-27T01:35:04Z",
"projectID": "0",
"snatTable": [
{
"id": "f4b5ba70-c15a-4e55-b987-117faa647e8a",
"sNatID": "ngwsr-fc3cx2aonb",
"description": "",
"status": "ACTIVE",
"vpcID": "vpc-ucuf00lez0",
"vpcName": "vpc-ysf",
"vpcCidr": "192.168.0.0/16",
"subnetCidr": "192.168.0.0/24",
"subnetName": "subnet-ysf",
"subnetType": 0,
"creationTime": "2022-09-27T07:49:05.931Z",
"ipAddress": [
{
"ID": "eip-rbcpzl9kw1",
"ipAddress": "100.124.1.147"
}
]
}
],
"dnatTable": []
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
