Updated on 2024-03-07 GMT+08:00

Querying DNAT Rules

Function

This API is used to query DNAT rules.

Constraints

You can type a question mark (?) and an ampersand (&) at the end of the URI to define different search criteria. All optional parameters can be filtered. For details, see the example request.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/dnat_rules

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Minimum: 1

Maximum: 36

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

admin_state_up

No

Boolean

Specifies whether the DNAT rule is frozen. The value can be: true: The DNAT rule is unfrozen. false: The DNAT rule is frozen.

external_service_port

No

Integer

Specifies the port used by the floating IP address to provide services for external systems. Supported range: 0 to 65535

Minimum: 0

Maximum: 65535

Minimum: 1

Maximum: 5

floating_ip_address

No

String

Specifies the EIP address.

Minimum: 7

Maximum: 15

status

No

Array

Specifies the DNAT rule status. The value can be: ACTIVE: The DNAT rule is available. PENDING_CREATE: The DNAT rule is being created. PENDING_UPDATE: The DNAT rule is being updated. PENDING_DELETE: The DNAT rule is being deleted. EIP_FREEZED: The EIP is frozen. INACTIVE: The DNAT rule is unavailable.

Array Length: 1 - 10

Enumeration values:

  • ACTIVE

  • PENDING_CREATE

  • PENDING_UPDATE

  • PENDING_DELETE

  • EIP_FREEZED

  • INACTIVE

floating_ip_id

No

String

Specifies the EIP ID.

Minimum: 36

Maximum: 36

internal_service_port

No

Integer

Specifies the port used by ECSs or BMSs to provide services for external systems. Supported range: 0 to 65535

Minimum: 0

Maximum: 65535

Minimum: 1

Maximum: 5

limit

No

Integer

Specifies the number of records displayed on each page. Value range: 0 to 2000 Default value: 2000

Minimum: 1

Maximum: 2000

Default: 2000

id

No

String

Specifies the DNAT rule ID.

Minimum: 1

Maximum: 36

description

No

String

Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

Minimum: 0

Maximum: 255

created_at

No

String

Specifies when the DNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format.

Minimum: 1

Maximum: 36

nat_gateway_id

No

Array

Specifies the public NAT gateway ID.

Array Length: 1 - 10

port_id

No

String

Specifies the port ID of an ECS or BMS. This parameter applies to VPC scenarios. Configure either port_id or private_ip.

Minimum: 36

Maximum: 36

private_ip

No

String

Specifies the private IP address of a user. This parameter applies to Direct Connect and Cloud Connect scenarios. Configure either private_ip or port_id.

Minimum: 7

Maximum: 15

protocol

No

Array

Specifies the protocol. TCP, UDP, and ANY are supported. The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.

Array Length: 1 - 10

marker

No

String

Specifies the ID of the resource from which a pagination query starts, indicating that the query starts from the next record of the specified resource.

  • If parameters marker and limit are not specified, all resource records (2,000 by default) on the first page will be returned.

  • If marker is not specified and limit is set to 10, the first to tenth resource records will be returned.

  • If marker is set to the resource ID of the tenth record and limit is set to 10, the 11th to 20th resource records will be returned.

  • If marker is set to the resource ID of the tenth record and limit is not specified, the eleventh and subsequent resource records (2,000 by default) will be returned.

Minimum: 36

Maximum: 36

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token.

Minimum: 1

Maximum: 10240

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

dnat_rules

Array of NatGatewayDnatRuleResponseBody objects

Specifies the response body for querying DNAT rules.

Array Length: 0 - 2000

Table 5 NatGatewayDnatRuleResponseBody

Parameter

Type

Description

id

String

Specifies the DNAT rule ID.

Minimum: 36

Maximum: 36

tenant_id

String

Specifies the project ID.

Minimum: 1

Maximum: 36

description

String

Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

Minimum: 0

Maximum: 255

port_id

String

Specifies the port ID of an ECS or BMS. This parameter applies to VPC scenarios. Configure either port_id or private_ip.

Minimum: 36

Maximum: 36

private_ip

String

Specifies the private IP address of a user. This parameter applies to Direct Connect and Cloud Connect scenarios. Configure either private_ip or port_id.

Minimum: 7

Maximum: 15

internal_service_port

Integer

Specifies the port used by ECSs or BMSs to provide services for external systems. Supported range: 0 to 65535

Minimum: 0

Maximum: 65535

Minimum: 1

Maximum: 5

nat_gateway_id

String

Specifies the public NAT gateway ID.

Minimum: 1

Maximum: 36

floating_ip_id

String

Specifies the EIP ID.

Minimum: 1

Maximum: 36

floating_ip_address

String

Specifies the EIP address.

Minimum: 7

Maximum: 15

external_service_port

Integer

Specifies the port used by the floating IP address to provide services for external systems. Supported range: 0 to 65535

status

String

Specifies the DNAT rule status. The value can be: ACTIVE: The DNAT rule is available. PENDING_CREATE: The DNAT rule is being created. PENDING_UPDATE: The DNAT rule is being updated. PENDING_DELETE: The DNAT rule is being deleted. EIP_FREEZED: The EIP is frozen. INACTIVE: The DNAT rule is unavailable.

Enumeration values:

  • ACTIVE

  • PENDING_CREATE

  • PENDING_UPDATE

  • PENDING_DELETE

  • EIP_FREEZED

  • INACTIVE

admin_state_up

Boolean

Specifies whether the DNAT rule is frozen. The value can be:

  • true: The DNAT rule is unfrozen.

  • false: The DNAT rule is frozen.

internal_service_port_range

String

Specifies the port range used by ECSs or BMSs to provide services for external systems. The number of ports must be the same as that of external _service_port_range. Supported range: 1 to 65535 Specify two port numbers connected by a single hyphen (-) and no blank spaces in the x-y format, where x is lower than y.

external_service_port_range

String

Specifies the port range used by the floating IP address to provide services for external systems. The number of ports must be the same as that of internal _service_port_range. Supported range: 1 to 65535 Specify two port numbers connected by a single hyphen (-) and no blank spaces in the x-y format, where x is lower than y.

protocol

String

Specifies the protocol. TCP, UDP, and ANY are supported. The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.

Minimum: 1

Maximum: 3

Enumeration values:

  • tcp

  • udp

  • any

created_at

String

Specifies when the DNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format.

Minimum: 1

Maximum: 36

global_eip_id

String

Specifies the global EIP ID.

Minimum: 36

Maximum: 36

global_eip_address

String

Specifies the global EIP address.

Minimum: 7

Maximum: 15

Example Requests

GET https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526d/dnat_rules?limit=2

Example Responses

Status code: 200

DNAT rules queried.

{
  "dnat_rules" : [ {
    "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1",
    "status" : "ACTIVE",
    "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541",
    "admin_state_up" : true,
    "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193",
    "private_ip" : "",
    "internal_service_port" : 993,
    "protocol" : "tcp",
    "tenant_id" : "d199ba7e0ba64899b2e81518104b1526d",
    "created_at" : "2017-11-15 15:44:42.595173",
    "id" : "79195d50-0271-41f1-bded-4c089b2502ff",
    "floating_ip_address" : "5.21.11.226",
    "external_service_port" : 242,
    "description" : "my dnat rule 01"
  }, {
    "floating_ip_id" : "cf99c679-9f41-4dac-8513-9c9228e713e1",
    "status" : "ACTIVE",
    "nat_gateway_id" : "dda3a125-2406-456c-a11f-598e10578541",
    "admin_state_up" : true,
    "port_id" : "",
    "private_ip" : "192.168.1.100",
    "internal_service_port" : 0,
    "protocol" : "any",
    "tenant_id" : "d199ba7e0ba64899b2e81518104b1526d",
    "created_at" : "2017-11-16 15:44:42.595173",
    "id" : "89195d50-0271-41f1-bded-4c089b2502ff",
    "floating_ip_address" : "5.21.11.227",
    "external_service_port" : 0,
    "description" : "my dnat rule 01"
  } ]
}

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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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.*;

import java.util.List;
import java.util.ArrayList;

public class ListNatGatewayDnatRulesSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        NatClient client = NatClient.newBuilder()
                .withCredential(auth)
                .withRegion(NatRegion.valueOf("<YOUR REGION>"))
                .build();
        ListNatGatewayDnatRulesRequest request = new ListNatGatewayDnatRulesRequest();
        request.withAdminStateUp(<admin_state_up>);
        request.withExternalServicePort(<external_service_port>);
        request.withFloatingIpAddress("<floating_ip_address>");
        request.withStatus();
        request.withFloatingIpId("<floating_ip_id>");
        request.withInternalServicePort(<internal_service_port>);
        request.withLimit(<limit>);
        request.withId("<id>");
        request.withDescription("<description>");
        request.withCreatedAt("<created_at>");
        request.withNatGatewayId();
        request.withPortId("<port_id>");
        request.withPrivateIp("<private_ip>");
        request.withProtocol();
        request.withMarker("<marker>");
        try {
            ListNatGatewayDnatRulesResponse response = client.listNatGatewayDnatRules(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
32
33
34
35
36
37
38
39
40
41
42
43
44
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = NatClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(NatRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListNatGatewayDnatRulesRequest()
        request.admin_state_up = <AdminStateUp>
        request.external_service_port = <external_service_port>
        request.floating_ip_address = "<floating_ip_address>"
        request.status = 
        request.floating_ip_id = "<floating_ip_id>"
        request.internal_service_port = <internal_service_port>
        request.limit = <limit>
        request.id = "<id>"
        request.description = "<description>"
        request.created_at = "<created_at>"
        request.nat_gateway_id = 
        request.port_id = "<port_id>"
        request.private_ip = "<private_ip>"
        request.protocol = 
        request.marker = "<marker>"
        response = client.list_nat_gateway_dnat_rules(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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := nat.NewNatClient(
        nat.NatClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListNatGatewayDnatRulesRequest{}
	adminStateUpRequest:= <admin_state_up>
	request.AdminStateUp = &adminStateUpRequest
	externalServicePortRequest:= int32(<external_service_port>)
	request.ExternalServicePort = &externalServicePortRequest
	floatingIpAddressRequest:= "<floating_ip_address>"
	request.FloatingIpAddress = &floatingIpAddressRequest
	floatingIpIdRequest:= "<floating_ip_id>"
	request.FloatingIpId = &floatingIpIdRequest
	internalServicePortRequest:= int32(<internal_service_port>)
	request.InternalServicePort = &internalServicePortRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	descriptionRequest:= "<description>"
	request.Description = &descriptionRequest
	createdAtRequest:= "<created_at>"
	request.CreatedAt = &createdAtRequest
	portIdRequest:= "<port_id>"
	request.PortId = &portIdRequest
	privateIpRequest:= "<private_ip>"
	request.PrivateIp = &privateIpRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ListNatGatewayDnatRules(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

DNAT rules queried.

Error Codes

See Error Codes.