Help Center/ NAT Gateway/ API Reference/ APIs for Private NAT Gateways/ Private NAT Gateways/ Querying the List of NAT Gateway Specifications Supported by a Project
Updated on 2025-09-12 GMT+08:00

Querying the List of NAT Gateway Specifications Supported by a Project

Function

This API is used to query the list of NAT gateway specifications supported by a project.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/private-nat/specs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

specs

Array of Spec objects

Specifies the response body for querying gateway specifications supported by a project.

Table 3 Spec

Parameter

Type

Description

name

String

Specifies the specification name.

code

String

Specifies the specification code.

cbc_code

String

Specifies the specification code on Cloud Business Center (CBC).

rule_max

Integer

Specifies the maximum number of rules.

sess_max

Integer

Specifies the maximum number of connections.

bps_max

Integer

Specifies the maximum bandwidth in bit/s.

pps_max

Integer

Specifies the maximum PPS.

qps_max

Integer

Specifies the maximum QPS.

Example Requests

GET https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/specs

Example Responses

Status code: 200

The list of NAT gateway specifications supported by the project queried.

{
  "specs" : [ {
    "name" : "Small",
    "code" : "1",
    "cbc_code" : "privatenat_small",
    "rule_max" : 20,
    "sess_max" : 2000,
    "bps_max" : 233,
    "pps_max" : 20000,
    "qps_max" : 6000
  }, {
    "name" : "Medium",
    "code" : "2",
    "cbc_code" : "privatenat_medium",
    "rule_max" : 50,
    "sess_max" : 5000,
    "bps_max" : 584,
    "pps_max" : 50000,
    "qps_max" : 9000
  }, {
    "name" : "Large",
    "code" : "3",
    "cbc_code" : "privatenat_large",
    "rule_max" : 200,
    "sess_max" : 20000,
    "bps_max" : 2336,
    "pps_max" : 200000,
    "qps_max" : 10000
  }, {
    "name" : "Extra-large",
    "code" : "4",
    "cbc_code" : "privatenat_xlarge",
    "rule_max" : 500,
    "sess_max" : 50000,
    "bps_max" : 5840,
    "pps_max" : 500000,
    "qps_max" : 10000
  }, {
    "name" : "Extra-xlarge",
    "code" : "5",
    "cbc_code" : "privatenat_xxlarge",
    "rule_max" : 5000,
    "sess_max" : 500000,
    "bps_max" : 58400,
    "pps_max" : 5000000,
    "qps_max" : 100000
  } ]
}

Status Codes

Status Code

Description

200

The list of NAT gateway specifications supported by the project queried.

Error Codes

See Error Codes.