DescribeNatGateways - NAT Gateway - Alibaba Cloud Documentation Center

Melakukan query informasi detail tentang gateway NAT yang memenuhi kondisi tertentu di region tertentu.

Deskripsi operasi

Operasi ini mendukung query informasi detail tentang gateway NAT Internet atau gateway NAT VPC. Istilah "gateway NAT" yang digunakan dalam dokumen ini tidak membedakan antara kedua jenis tersebut.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeNatGateways

get

NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/*

NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID region gateway NAT yang akan di-query. Anda dapat memanggil operasi DescribeRegions untuk mendapatkan ID region.	cn-hangzhou
NatGatewayId	string	No	ID gateway NAT yang akan di-query.	ngw-bp1uewa15k4iy5770****
VpcId	string	No	ID VPC tempat gateway NAT berada.	vpc-bp15zckdt37pq72z****
Name	string	No	Nama gateway NAT yang akan di-query. Nama harus memiliki panjang 1 hingga 128 karakter dan tidak boleh diawali dengan `http://` atau `https://`.	test
InstanceChargeType	string	No	PrePaid: metode penagihan langganan lama. Metode penagihan langganan tidak lagi tersedia untuk pembelian baru. Metode penagihan gateway NAT yang akan di-query. Nilai yang valid: PostPaid (bayar sesuai pemakaian)..	PostPaid
Spec	string	No	Spesifikasi gateway NAT. Biarkan parameter ini kosong..	Nilai contoh untuk situs Tiongkok: Small. Nilai contoh untuk situs internasional: biarkan kosong.
NatType	string	No	Jenis gateway NAT. Nilai yang valid: Enhanced (gateway NAT yang ditingkatkan).	Enhanced
ResourceGroupId	string	No	ID grup sumber daya tempat gateway NAT berada.	rg-bp67acfmxazb4ph****
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	10
PageSize	integer	No	Jumlah entri per halaman. Nilai maksimum: 50. Nilai default: 10.	1
DryRun	boolean	No	Menentukan apakah akan melakukan uji coba (dry run). Nilai yang valid: true: melakukan uji coba tanpa melakukan query status sumber daya. Sistem memeriksa apakah pasangan AccessKey valid, apakah pengguna RAM memiliki otorisasi, dan apakah parameter yang diperlukan telah ditentukan. Jika pemeriksaan gagal, error yang sesuai akan dikembalikan. Jika pemeriksaan berhasil, kode error `DryRunOperation` akan dikembalikan. false (default): melakukan permintaan normal. Setelah pemeriksaan berhasil, kode status HTTP 2xx akan dikembalikan dan status sumber daya akan di-query.	false
Status	string	No	Status gateway NAT yang akan di-query. Nilai yang valid: Creating: Pembuatan gateway NAT adalah operasi asinkron. Sistem mengembalikan status ini sebelum pembuatan selesai. Available: Gateway NAT telah dibuat dan berada dalam status stabil. Modifying: Modifikasi gateway NAT adalah operasi asinkron. Sistem mengembalikan status ini selama proses modifikasi. Deleting: Penghapusan gateway NAT adalah operasi asinkron. Sistem mengembalikan status ini selama proses penghapusan. Converting: Konversi gateway NAT standar ke gateway NAT yang ditingkatkan adalah operasi asinkron. Sistem mengembalikan status ini selama proses konversi.	Available
NetworkType	string	No	Jenis gateway NAT yang akan di-query. Nilai yang valid: internet: gateway NAT Internet. intranet: gateway NAT VPC.	internet
Tag	array<object>	No	Daftar tag.
	object	No	Daftar tag.
Key	string	No	Kunci tag instance gateway NAT. Anda dapat menentukan hingga 20 kunci tag. Kunci tag dapat memiliki panjang hingga 128 karakter. Tidak boleh diawali dengan `aliyun` atau `acs:`, dan tidak boleh mengandung `http://` atau `https://`.	KeyTest
Value	string	No	Nilai tag instance gateway NAT. Anda dapat menentukan hingga 20 nilai tag. Nilai tag dapat memiliki panjang hingga 128 karakter. Tidak boleh diawali dengan `aliyun` atau `acs:`, dan tidak boleh mengandung `http://` atau `https://`.	valueTest
ZoneId	string	No	ID zona tempat gateway NAT di-deploy.	cn-hangzhou-b
AvailabilityMode	string	No

Elemen respons

Element	Type	Description	Example
	object	Jumlah entri per halaman.
PageSize	integer	Jumlah entri per halaman.	10
RequestId	string	ID permintaan.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumber	integer	Nomor halaman saat ini.	10
TotalCount	integer	Jumlah total entri dalam daftar gateway NAT.	1
NatGateways	object
NatGateway	array<object>	Informasi detail gateway NAT.
	array<object>	Informasi detail gateway NAT.
Status	string	Status dari NAT gateway. Nilai yang valid: Creating: NAT gateway sedang dibuat. Membuat NAT gateway adalah operasi asinkron. NAT gateway berada dalam status Creating hingga pembuatan selesai. Available: NAT gateway telah dibuat dan dalam status stabil. Modifying: NAT gateway sedang dimodifikasi. Memodifikasi NAT gateway adalah operasi asinkron. NAT gateway berada dalam status Modifying selama proses modifikasi. Deleting: NAT gateway sedang dihapus. Menghapus NAT gateway adalah operasi asinkron. NAT gateway berada dalam status Deleting selama proses penghapusan. Converting: NAT gateway standar sedang ditingkatkan menjadi NAT gateway yang ditingkatkan. Peningkatan adalah operasi asinkron. NAT gateway berada dalam status Converting selama proses peningkatan.	Creating
CreationTime	string	Waktu saat NAT gateway dibuat.	2021-06-08T12:20:20Z
VpcId	string	ID VPC tempat NAT gateway berada.	vpc-bp15zckdt37pq72z****
NatType	string	Tipe dari NAT gateway. Nilai yang valid: Enhanced, yang mengindikasikan NAT gateway yang ditingkatkan.	Enhanced
AutoPay	boolean	Mengindikasikan apakah pesanan dibayar secara otomatis. Nilai yang valid: false: Pesanan tidak dibayar secara otomatis. true: Pesanan dibayar secara otomatis.	false
Spec	string	Spesifikasi dari NAT gateway. Nilai kosong dikembalikan untuk parameter ini. Jika InternetChargeType diatur ke PayByLcu, nilai kosong dikembalikan.	Small
DeletionProtection	boolean	Mengindikasikan apakah proteksi penghapusan diaktifkan. Nilai yang valid: true: diaktifkan. false: dinonaktifkan.	true
NetworkType	string	Tipe dari NAT gateway. Nilai yang valid: internet: NAT gateway Internet. intranet: NAT gateway VPC.	internet
SecurityProtectionEnabled	boolean	Mengindikasikan apakah fitur firewall diaktifkan. Nilai yang valid: false: Fitur firewall dinonaktifkan. true: Fitur firewall diaktifkan.	false
InstanceChargeType	string	Metode penagihan dari instance NAT gateway yang akan ditanyakan. Nilai yang valid: PostPaid (bayar sesuai pemakaian).	PostPaid
RegionId	string	ID region tempat NAT gateway di-deploy.	cn-hangzhou
EcsMetricEnabled	boolean	Mengindikasikan apakah fitur pemantauan trafik gateway diaktifkan. Nilai yang valid: true: diaktifkan. false: dinonaktifkan.	true
IcmpReplyEnabled	boolean	Mengindikasikan apakah fitur ICMP non-retrieval diaktifkan. Nilai yang valid: true (default): diaktifkan. false: dinonaktifkan.	true
Description	string	Deskripsi NAT gateway.	NAT
ExpiredTime	string	Waktu kedaluwarsa NAT gateway.	2021-08-26T16:00Z
ResourceGroupId	string	ID grup sumber daya.	rg-bp67acfmxazb4ph****
NatGatewayId	string	ID NAT gateway.	ngw-bp1047e2d4z7kf2ki****
InternetChargeType	string	Metode penagihan NAT gateway. Nilai yang valid: PayBySpec: bayar berdasarkan spesifikasi. PayByLcu: bayar berdasarkan penggunaan.	PayByLcu
BusinessStatus	string	Status bisnis NAT gateway. Nilai yang valid: Normal: normal. FinancialLocked: terkunci karena tunggakan pembayaran.	Normal
Name	string	Nama instance NAT gateway.	abc
IpLists	object
IpList	array<object>	Daftar alamat IP elastis (EIP) yang terkait dengan NAT gateway Internet.
	object	Daftar informasi IP dari NAT gateway.
UsingStatus	string	Asosiasi antara EIP dan instance NAT gateway Internet. Nilai yang valid: UsedByForwardTable: EIP digunakan dalam entri DNAT. UsedBySnatTable: EIP digunakan dalam entri SNAT. UsedByForwardSnatTable: EIP digunakan dalam entri DNAT dan SNAT. Idle: EIP idle dan tidak digunakan dalam entri DNAT atau SNAT.	UsedByForwardTable
IpAddress	string	Alamat IP dari EIP yang terkait dengan NAT gateway.	116.62.XX.XX
SnatEntryEnabled	boolean	Mengindikasikan apakah alamat IP yang digunakan dalam entri DNAT juga dapat digunakan dalam entri SNAT. Nilai yang valid: true: Alamat IP dapat digunakan dalam entri SNAT. false: Alamat IP tidak dapat digunakan dalam entri SNAT.	false
AllocationId	string	ID instance dari EIP yang terkait dengan NAT gateway.	eip-m5egzuvp3dgixen6****
PrivateIpAddress	string	Alamat IP privat dari NAT gateway.	192.168.XX.XX
ForwardTableIds	object
ForwardTableId	array	ID tabel DNAT dari NAT gateway.
	string	ID tabel DNAT.	ftb-uf6gj3mhsg94qsqst****
SnatTableIds	object
SnatTableId	array	ID tabel SNAT dari NAT gateway.
	string	ID tabel SNAT.	stb-uf6dalcdu0krz423p****
FullNatTableIds	object
FullNatTableId	array	ID tabel FULLNAT.
	string	ID tabel FULLNAT.	fulltb-gw88z7hhlv43rmb26****
NatGatewayPrivateInfo	object	Informasi jaringan privat tentang NAT gateway Internet yang ditingkatkan. Catatan Jika NatType diatur ke Normal, semua parameter yang dikembalikan dalam daftar ini kosong.
VswitchId	string	ID vSwitch tempat NAT gateway berada.	vsw-bp1s2laxhdf9ayjbo****
EniInstanceId	string	ID dari elastic network interface (ENI).	eni-m5eg4ozy5st8q3q4****
MaxBandwidth	integer	Nilai bandwidth maksimum, dalam Mbit/s.	5120
MaxSessionQuota	integer	Jumlah maksimum koneksi konkuren dari NAT gateway. Unit: koneksi.	2000000
MaxSessionEstablishRate	integer	Jumlah koneksi baru per detik yang didukung oleh NAT gateway. Unit: koneksi/detik.	100000
PrivateIpAddress	string	Alamat IP privat.	192.168.XX.XX
IzNo	string	Zona tempat NAT gateway berada.	cn-hangzhou-b
EniType	string	Mode binding antara ENI dan NAT gateway. Nilai yang valid: indirect: mode non-cut-through. Nilai kosong: mode cut-through.	indirect
PrivateLinkEnabled	boolean	Mengindikasikan apakah koneksi privat didukung. Nilai yang valid: true: Koneksi privat didukung. false: Koneksi privat tidak didukung.	true
PrivateLinkMode	string	Mode konversi dari layanan koneksi privat. Nilai yang valid: FullNat: mode FULLNAT. Geneve: mode Geneve.	FullNat
EipBindMode	string	Mode binding EIP dari NAT gateway. Nilai yang valid: MULTI_BINDED: mode multi-EIP NIC visible. NAT: mode EIP normal, kompatibel dengan gateway IPv4. Catatan Ketika mode binding EIP dari NAT gateway adalah mode EIP normal, EIP menggunakan alamat IP privat dari vSwitch tempat NAT gateway berada. Pastikan terdapat alamat IP privat yang cukup di vSwitch tempat NAT gateway berada. Jika tidak ada alamat IP privat idle yang tersedia di vSwitch tempat NAT gateway berada, EIP baru tidak dapat di-bind. Ketika mode binding EIP dari NAT gateway adalah mode EIP normal, jumlah maksimum EIP yang dapat di-bind oleh NAT gateway adalah 50.	MULTI_BINDED
Tags	object
Tag	array<object>	Daftar tag.
	object	Daftar tag.
TagKey	string	Kunci tag dari instance.	KeyTest
TagValue	string	Nilai tag dari instance.	valueTest
EnableSessionLog	string	Mengindikasikan apakah fitur log sesi diaktifkan. Nilai yang valid: true: Fitur log sesi diaktifkan. false: Fitur log sesi dinonaktifkan.	true
AccessMode	object	Mode akses untuk akses balik ke NAT gateway VPC.
ModeValue	string	Mode akses. Nilai yang valid: route: mode route. tunnel: mode tunnel.	route
TunnelType	string	Tipe mode tunnel: geneve: tipe Geneve.	geneve
AvailabilityMode	string
IpPrefixList	object
IpPrefixList	array<object>	Daftar rentang alamat prefiks IP NAT.
	object
IpPrefix	string	Rentang alamat prefiks IP NAT.	192.168.0.0/28

Contoh

Respons sukses

JSONformat

{
  "PageSize": 10,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber": 10,
  "TotalCount": 1,
  "NatGateways": {
    "NatGateway": [
      {
        "Status": "Creating",
        "CreationTime": "2021-06-08T12:20:20Z",
        "VpcId": "vpc-bp15zckdt37pq72z****",
        "NatType": "Enhanced",
        "AutoPay": false,
        "Spec": "Small",
        "DeletionProtection": true,
        "NetworkType": "internet",
        "SecurityProtectionEnabled": false,
        "InstanceChargeType": "PostPaid",
        "RegionId": "cn-hangzhou",
        "EcsMetricEnabled": true,
        "IcmpReplyEnabled": true,
        "Description": "NAT",
        "ExpiredTime": "2021-08-26T16:00Z",
        "ResourceGroupId": "rg-bp67acfmxazb4ph****",
        "NatGatewayId": "ngw-bp1047e2d4z7kf2ki****",
        "InternetChargeType": "PayByLcu",
        "BusinessStatus": "Normal",
        "Name": "abc",
        "IpLists": {
          "IpList": [
            {
              "UsingStatus": "UsedByForwardTable",
              "IpAddress": "116.62.XX.XX",
              "SnatEntryEnabled": false,
              "AllocationId": "eip-m5egzuvp3dgixen6****",
              "PrivateIpAddress": "192.168.XX.XX"
            }
          ]
        },
        "ForwardTableIds": {
          "ForwardTableId": [
            "ftb-uf6gj3mhsg94qsqst****"
          ]
        },
        "SnatTableIds": {
          "SnatTableId": [
            "stb-uf6dalcdu0krz423p****"
          ]
        },
        "FullNatTableIds": {
          "FullNatTableId": [
            "fulltb-gw88z7hhlv43rmb26****"
          ]
        },
        "NatGatewayPrivateInfo": {
          "VswitchId": "vsw-bp1s2laxhdf9ayjbo****",
          "EniInstanceId": "eni-m5eg4ozy5st8q3q4****",
          "MaxBandwidth": 5120,
          "MaxSessionQuota": 2000000,
          "MaxSessionEstablishRate": 100000,
          "PrivateIpAddress": "192.168.XX.XX",
          "IzNo": "cn-hangzhou-b",
          "EniType": "indirect"
        },
        "PrivateLinkEnabled": true,
        "PrivateLinkMode": "FullNat",
        "EipBindMode": "MULTI_BINDED",
        "Tags": {
          "Tag": [
            {
              "TagKey": "KeyTest",
              "TagValue": "valueTest"
            }
          ]
        },
        "EnableSessionLog": "true",
        "AccessMode": {
          "ModeValue": "route",
          "TunnelType": "geneve"
        },
        "AvailabilityMode": "",
        "IpPrefixList": {
          "IpPrefixList": [
            {
              "IpPrefix": "192.168.0.0/28"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
500	InternalError	Pemrosesan permintaan gagal karena kesalahan, eksepsi, atau kegagalan yang tidak diketahui.	Kesalahan internal.
404	InvalidRegionId.NotFound	RegionId yang ditentukan tidak ada dalam catatan kami.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.