All Products
Search

This Product

    NAT Gateway:CreateSnatEntry

    Document Center

    NAT Gateway:CreateSnatEntry

    Last Updated:Jun 12, 2026

    Menambahkan entri SNAT ke tabel SNAT dengan memanggil operasi CreateSnatEntry.

    Deskripsi operasi

    Anda dapat memanggil operasi ini untuk menambahkan entri SNAT ke gerbang NAT Internet yang ditingkatkan dan gerbang NAT VPC. Gerbang NAT dalam topik ini merujuk pada kedua jenis gerbang NAT kecuali dinyatakan lain.

    Saat Anda memanggil operasi ini untuk menambahkan entri SNAT, perhatikan hal-hal berikut:

    • CreateSnatEntry adalah operasi asinkron. Setelah Anda mengirim permintaan, sistem akan mengembalikan ID entri SNAT. Namun, entri SNAT belum dibuat pada saat ini. Sistem akan melanjutkan tugas pembuatan di latar belakang. Anda dapat memanggil operasi DescribeSnatTableEntries untuk mengkueri status entri SNAT:

      • Jika entri SNAT berada dalam status Pending, entri SNAT sedang dibuat. Anda hanya dapat mengkueri entri SNAT tetapi tidak dapat melakukan operasi lain.

      • Jika entri SNAT berada dalam status Available, entri SNAT telah dibuat.

    • vSwitch dan Instance ECS yang ditentukan dalam entri SNAT harus berada dalam VPC tempat gerbang NAT berada.

    • Setiap vSwitch dan Instance ECS hanya dapat menjadi bagian dari satu entri SNAT.

    • Jika alamat IP virtual ketersediaan tinggi (HAVIP) ada di vSwitch, Anda tidak dapat menambahkan entri SNAT untuk vSwitch 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

    Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID wilayah tempat gerbang NAT diterapkan.

    Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.

    Valid values:

    • ap-northeast-2-pop :

      ap-northeast-2-pop.

    cn-hangzhou
    SnatTableId

    string

    Yes

    ID tabel SNAT.

    stb-bp190wu8io1vgev****
    SourceVSwitchId

    string

    No

    ID vSwitch.

    • Saat Anda menambahkan entri SNAT ke gerbang NAT Internet, parameter ini menentukan bahwa Instance ECS di vSwitch dapat mengakses Internet menggunakan aturan SNAT. Jika Anda menentukan beberapa EIP untuk mengonfigurasi kolam alamat IP SNAT, koneksi layanan akan didistribusikan ke EIP menggunakan algoritma hash. Karena trafik setiap koneksi berbeda, trafik mungkin tidak terdistribusi secara merata ke EIP. Kami menyarankan Anda menambahkan setiap EIP ke paket bandwidth EIP yang sama untuk mencegah gangguan layanan yang disebabkan oleh EIP mencapai batas bandwidth.

    • Saat Anda menambahkan entri SNAT ke gerbang NAT VPC, parameter ini menentukan bahwa Instance ECS di vSwitch dapat mengakses jaringan eksternal menggunakan aturan SNAT.

    Catatan

    Anda harus menentukan salah satu dari SourceCIDR dan SourceVSwtichId, tetapi tidak dapat menentukan keduanya.

    vsw-bp1nhx2s9ui5o****
    SourceCIDR

    string

    No

    Tentukan blok CIDR dari VPC, vSwitch, atau Instance ECS. Anda juga dapat menentukan blok CIDR kustom.

    Entri SNAT memiliki granularitas berikut:

    • Granularitas VPC: blok CIDR dari VPC tempat gerbang NAT berada. Semua Instance ECS di VPC dapat mengakses Internet atau jaringan eksternal menggunakan aturan SNAT.

    • Granularitas vSwitch: blok CIDR dari vSwitch yang ditentukan (misalnya 192.168.1.0/24). Semua Instance ECS di vSwitch dapat mengakses Internet atau jaringan eksternal menggunakan aturan SNAT.

    • Granularitas Instance ECS: alamat IP dari Instance ECS yang ditentukan (misalnya 192.168.1.1/32). Instance ECS dapat mengakses Internet atau jaringan eksternal menggunakan aturan SNAT.

    • Blok CIDR kustom. Semua Instance ECS dalam blok CIDR dapat mengakses Internet atau jaringan eksternal menggunakan layanan SNAT.

    Catatan

    Anda harus menentukan salah satu dari SourceCIDR dan SourceVSwtichId, tetapi tidak dapat menentukan keduanya.

    10.1.1.0/24
    SnatIp

    string

    No

    Saat Anda menambahkan entri SNAT ke gerbang NAT Internet:

    • Parameter SnatIp wajib diisi.

    • Parameter ini menentukan EIP dalam entri SNAT. Pisahkan beberapa EIP dengan koma (,).

    • Jika hanya satu alamat IP publik yang ditentukan untuk SnatIp, Instance ECS menggunakan alamat IP publik yang ditentukan untuk mengakses Internet.

    • Jika beberapa alamat IP publik ditentukan untuk SnatIp, Instance ECS akan memilih alamat IP publik secara acak dari SnatIp untuk mengakses Internet.

    Catatan

    Jika Anda menentukan beberapa EIP untuk mengonfigurasi kolam alamat IP SNAT, koneksi layanan akan didistribusikan ke EIP menggunakan algoritma hash. Karena trafik setiap koneksi berbeda, trafik mungkin tidak terdistribusi secara merata ke EIP. Kami menyarankan Anda menambahkan setiap EIP ke paket bandwidth EIP yang sama untuk mencegah gangguan layanan yang disebabkan oleh EIP mencapai batas bandwidth.

    Saat Anda menambahkan entri SNAT ke gerbang NAT VPC:

    • Parameter ini menentukan alamat IP NAT dalam entri SNAT. Pisahkan beberapa alamat IP NAT dengan koma (,).

    • Anda harus menentukan salah satu dari SnatIp dan NetworkInterfaceId, tetapi tidak dapat menentukan keduanya.

    47.98.XX.XX
    SnatEntryName

    string

    No

    Nama entri SNAT.

    Nama harus memiliki panjang 2 hingga 128 karakter, dan harus diawali dengan huruf atau karakter Tionghoa. Nama tidak dapat diawali dengan http:// atau https://.

    SnatEntry-1
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan.

    Anda dapat menggunakan klien untuk menghasilkan nilai ini, tetapi Anda harus memastikan bahwa nilai tersebut unik di antara permintaan yang berbeda. Nilai ClientToken hanya dapat berisi karakter ASCII.

    Catatan

    Jika Anda tidak menentukan parameter ini, sistem akan secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId mungkin berbeda untuk setiap permintaan API.

    02fb3da4-130e-11e9-8e44****
    EipAffinity

    integer

    No

    Apakah akan mengaktifkan afinitas IP. Nilai valid:

    • 0 (default): Menonaktifkan afinitas IP.

    • 1: Mengaktifkan afinitas IP.

    Catatan

    Setelah afinitas IP diaktifkan, jika entri SNAT dikaitkan dengan beberapa EIP atau IP NAT, klien yang sama akan menggunakan EIP atau IP NAT yang sama untuk mengakses alamat IP tujuan yang sama. Jika tidak, klien akan memilih EIP atau IP NAT secara acak dari EIP atau IP NAT yang dikaitkan untuk mengakses tujuan.

    1
    NetworkInterfaceId

    string

    No

    ID antarmuka jaringan elastis (ENI).

    Catatan

    Alamat IPv4 ENI digunakan sebagai alamat SNAT.

    eni-gw8g131ef2dnbu3k****
    DryRun

    boolean

    No

    Apakah akan melakukan Pemeriksaan Awal pada permintaan ini saja. Nilai valid:

    • true: Melakukan Pemeriksaan Awal pada permintaan tetapi tidak membuat entri SNAT. Sistem memeriksa apakah Pasangan Kunci Akses valid, apakah Pengguna RAM memiliki izin, dan apakah parameter yang diperlukan telah ditentukan. Jika permintaan gagal dalam pemeriksaan, kode kesalahan yang sesuai akan dikembalikan. Jika permintaan lulus pemeriksaan, kode kesalahan DryRunOperation akan dikembalikan.

    • false (default): Mengirim permintaan normal. Setelah permintaan lulus pemeriksaan, kode status HTTP 2xx akan dikembalikan dan entri SNAT dibuat.

    false

    Elemen respons

    Element

    Type

    Description

    Example

    object

    ID entri SNAT.

    SnatEntryId

    string

    ID entri SNAT.

    snat-kmd6nv8fy****
    RequestId

    string

    ID permintaan.

    2315DEB7-5E92-423A-91F7-4C1EC9AD****

    Contoh

    Respons sukses

    JSONformat

    {
  "SnatEntryId": "snat-kmd6nv8fy****",
  "RequestId": "2315DEB7-5E92-423A-91F7-4C1EC9AD****"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 UnsupportedFeature.PrivateLinkEnabled The feature of PrivateLinkEnabled is not supported.
    400 InvalidSourceCIDR.Malformed SourceCIDR is illegal.
    400 NOT_ALLOW_USE_SOURCECIDR_OUTSIDEVPC The User not in sourcecidr_unlimited_outsidevpc white list. Cannot use SourceCidr outside VpcCidr.
    400 NOT_ALLOW_USE_SOURCECIDR_AUTODEFINE The User not in sourcecidr_unlimited_insidevpc white list. Cannot use SourceCidr auto defined.
    400 NOT_ALLOW_USE_SOURCECIDR_CONTAINSZERO The User not in sourcecidr_unlimited_outsidevpc_containszero white list. Cannot use SourceCidr outside VpcCidr.
    400 Forbidden.IpHasBeenUsedInDnat The snat ip can't be used. Because it has been used in dnat
    400 Forbidden.SourceVSwitchId.IncludeHaVip There is some HaVips under specified VSwitch
    400 InvalidSnatIp.Malformed The specified SnatIp is not a valid IP address.
    400 SNAT_IP_POOL_COUNT_TOO_MANY The Snat pool ip too many.
    400 Forbidden.SnatEntryCountLimited SNAT entry in the specified SNAT table reach its limit.
    400 NOT_ALLOW_USE_SOURCECIDR The User not in nat_scope_unlimited white list. Cannot use SourceCidr param.
    400 INVALID_PARAMETER The parameter invalid.
    400 Forbidden.SourceVSwitchId.Duplicated The specified SourceCIDRis duplicated.
    400 Forbidden.IpUsedInForwardTable The specified SnatIp already used in forward table
    400 Forbindden The specified Instance already bind eip
    400 EIP_NOT_SUPPORT_SNAT_POOL The Eip cannot support snat pool
    400 EIP_NOT_IN_GATEWAY The Eip not in nat gateway
    400 OperationUnsupported.CidrConflict The specified CIDR block conflicts with an existing SNAT entry.
    400 InvalidNatGatewayId.NotFound The NatGateway instance not exist.
    400 InvalidParameter.Name.Malformed The specified Name is not valid.
    400 InvalidParameter.SnatIp Ip semgment must be subnet cidr.
    400 QuotaExceeded.SnatIp Public ip number exceeds quota.
    400 OperationUnsupported.EipInBinding Create snat entry with eip in associating status is unsupported.
    400 OperationFailed.VSwitchNotInVpc The specified vswitch and natgateway are not in the same vpc.
    400 QuotaExceeded.SnatEntry SNAT entry in the specified SNAT table reach it?s limit.
    400 IncorrectStatus.NATGW NATGW status is invalid.
    400 IncorrectStatus.VSwitch The specified vSwitch status is invalid.
    400 MissingParam.SnatIp The input parameter SnatIp that is mandatory for processing this request is not supplied.
    400 MissingParam.NetworkInterfaceId The input parameter NetworkInterfaceId that is mandatory for processing this request is not supplied.
    400 ParamExclusive.SnatIpAndNetworkInterfaceId SnatIp and NetworkInterfaceId is mutually exclusive when create a snat entry for nat.
    400 IllegalParam.NetworkInterfaceId The param of NetworkInterfaceId is illegal.
    400 OperationUnsupported.EipNatBWPCheck The EIP is not associated with a NAT service plan.
    400 OperationUnsupported.EipNatGWCheck The operation failed because the EIP is not bound to this NAT Gateway.
    400 OperationFailed.SnatIpPoolCbwpRules The operation failed because the SNAT rule IPs are added to multi bandwidth packages.
    400 IncorrectStatus.SnatEntry The SNAT rule status is invalid. Please try again later.
    400 IncorrectStatus.NatIp NatIp status is invalid, please try again later.
    400 OperationUnsupported.EipNatIpCheck The operation failed because the EIP is not bound to this NAT gateway.
    400 OperationFailed.SnatIpPoolBwpRules The operation failed because the IP in Snat entryl was added to multiple NAT bandwidth packets.
    400 OperationFailed.SnatIpsCheck The operation fails because some IPs address in the SNAT entry are not added to common bandwidth packet.
    500 DefaultValidate.Error validte fail.
    500 OperationFailed.CrateSnatEntryTimeOut Operation failed because create snatEntry timeout.
    404 InvalidRegionId.NotFound The specified RegionId does not exist in our records.
    404 InvalidSnatTableId.NotFound Specified SNAT table does not exist.
    404 InvalidVSwitchId.NotFound The specified virtual switch does not exists.
    404 InvalidSnatIp.NotFound Specified SnatIp does not found on the NAT Gateway
    404 ResourceNotFound.NatGateway The NatGateway instance not exist.
    404 ResourceNotFound.NatIp The NatIp instance not exist.
    404 ResourceNotFound.VSwitch The specified resource of %s is not found.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.