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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Specifies the project ID. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
specs |
Array of Spec objects |
Specifies the response body for querying gateway specifications supported by a project. |
|
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
} ]
}
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.nat.v2.region.NatRegion; import com.huaweicloud.sdk.nat.v2.*; import com.huaweicloud.sdk.nat.v2.model.*; public class ListSpecsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); NatClient client = NatClient.newBuilder() .withCredential(auth) .withRegion(NatRegion.valueOf("<YOUR REGION>")) .build(); ListSpecsRequest request = new ListSpecsRequest(); try { ListSpecsResponse response = client.listSpecs(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdknat.v2.region.nat_region import NatRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdknat.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = NatClient.new_builder() \ .with_credentials(credentials) \ .with_region(NatRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSpecsRequest() response = client.list_specs(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" nat "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := nat.NewNatClient( nat.NatClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSpecsRequest{} response, err := client.ListSpecs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The list of NAT gateway specifications supported by the project queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot