Updated on 2026-09-28 GMT+08:00

Querying Endpoint Rules

Function

This API is used to query endpoint rules.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dns:resolverRule:list

    List

    resolverRule *

    -

    -

    -

URI

GET /v2.1/resolverrules

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

domain_name

No

String

Definition

Domain name of the endpoint rule to be queried.

Constraints

N/A

Range

N/A

Default Value

N/A

name

No

String

Definition

Name of the endpoint rule to be queried.

Constraints

N/A

Range

N/A

Default Value

N/A

endpoint_id

No

String

Definition

Endpoint ID. You can obtain the value by calling the API for querying endpoints (ListEndpoints).

Constraints

N/A

Range

N/A

Default Value

N/A

id

No

String

Definition

Endpoint rule ID. You can obtain the ID by calling the API (ListResolverRules) for querying endpoint rules of a Resolver.

Constraints

N/A

Range

N/A

Default Value

N/A

limit

No

Integer

Definition

The number of records returned on each page during pagination query.

Constraints

N/A

Range

0 to 500

Default Value

500

offset

No

Integer

Definition

The offset of pagination query. It specifies the number of rows or records to skip from the beginning of the result set before retrieving the desired data.

Constraints

This parameter is used together with limit for pagination query. If marker is also set, the query starts from the resource specified by marker and the offset parameter does not take effect.

Range

0 to 2147483647

Default Value

0

marker

No

String

Definition

The resource ID from which the next page of data should begin in pagination query. You can obtain the value from the ID of the last resource in the query result on the previous page.

  • When querying the first page, leave this parameter empty.

  • When querying the next page, set this parameter to the ID of the last resource on the previous page.

Constraints

N/A

Range

N/A

Default Value

N/A

shared_status

No

String

Definition

Sharing status of endpoint rules. This field is used to filter endpoint rules based on the resource owner.

Constraints

If this parameter is left blank or not specified, the endpoint rules created by the current account are queried.

Range

  • sharedwithme: Endpoint rules shared by other accounts with the current account are queried.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which is used for identity authentication. It must be carried in the request header to verify the user identity during API calls.

You can obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

For details about how to obtain a user token, see Obtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

resolver_rules

Array of ListResolverRuleParam objects

Definition

List of endpoint rules. This field is an array. Each element contains information such as the endpoint rule ID, name, domain name, and status.

links

pageLink object

Definition

Links to the current page and the next page. If pagination is required for querying resources, a next field is required to point to the next page.

metadata

metadata object

Definition

Metadata information about the pagination query, including the total number of resources (total_count) that meet the query conditions.

page_info

PageInfo object

Definition

Pagination information objects, including the next page marker, previous page marker, and number of records on the current page.

Table 4 ListResolverRuleParam

Parameter

Type

Description

id

String

Definition

Endpoint rule ID.

Range

N/A

name

String

Definition

Rule name.

Range

N/A

domain_name

String

Definition

Domain name.

Range

N/A

endpoint_id

String

Definition

ID of the endpoint to which the current rule belongs.

Range

N/A

status

String

Definition

Resource status.

Range

  • ACTIVE: Normal

  • PENDING_CREATE: Creating

  • PENDING_DELETE: Deleting

  • ERROR: Failed

rule_type

String

Definition

Rule type. This field is reserved. The default value is FORWARD.

Range

  • FORWARD: endpoint rules (currently, only this value is supported).

ipaddress_count

Integer

Definition

Number of IP addresses in the endpoint rule.

Range

N/A

routers

Array of Router objects

Definition

Information about the associated VPC.

create_time

String

Definition

Creation time.

The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000.

Range

N/A

update_time

String

Definition

Update time.

The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000.

Range

N/A

Table 5 Router

Parameter

Type

Description

router_id

String

Definition

ID of the associated VPC.

Range

N/A

router_region

String

Definition

Region where the associated VPC is located.

Range

N/A

status

String

Definition

Resource status.

Range

  • ACTIVE: Normal

  • PENDING_CREATE: Creating

  • PENDING_DELETE: Deleting

  • ERROR: Failed

Table 7 metadata

Parameter

Type

Description

total_count

Integer

Definition

Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

Range

N/A

Table 8 PageInfo

Parameter

Type

Description

next_marker

String

Definition

Marker of the next page

Range

N/A

previous_marker

String

Definition

Marker of the previous page

Range

N/A

current_count

Integer

Definition

Number of resources returned on the current page.

Range

N/A

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

  • Querying the endpoint rules created by the current account, with 10 rules returned on each page

    GET https://{Endpoint}/v2.1/resolverrules?limit=10
  • Querying the endpoint rules shared by other accounts with the current account, with 10 rules returned on each page

    GET https://{Endpoint}/v2.1/resolverrules?limit=10&shared_status=sharedwithme

Example Responses

Status code: 200

  • Example response for querying the endpoint rules created by the current account.

    {
      "resolver_rules" : [ {
        "id" : "8a36f60a753badb401753bade3400002",
        "name" : "rule-xxx",
        "domain_name" : "www.example.com",
        "endpoint_id" : "8a36f60a753badb401753bade3400001",
        "status" : "ACTIVE",
        "rule_type" : "FORWARD",
        "ipaddress_count" : 0,
        "routers" : [ {
          "router_id" : "ff7bd47f-3f12-4f24-a078-e6064abaa670",
          "router_region" : "NetworkService",
          "status" : "ACTIVE"
        }, {
          "router_id" : "ff7bd47f-3f12-4f24-a078-e6064abaa671",
          "router_region" : "NetworkService",
          "status" : "ACTIVE"
        } ],
        "create_time" : "2020-10-18T12:27:31.448",
        "update_time" : "2020-10-18T12:27:31.448"
      } ],
      "links" : {
        "self" : "https://{Endpoint}/v2.1/resolverrules?limit=10&offset=0",
        "next" : "https://{Endpoint}/v2.1/resolverrules?limit=10&offset=10"
      },
      "metadata" : {
        "total_count" : 33
      }
    }
  • Example response for querying the endpoint rules shared by other accounts with the current account.

    {
      "resolver_rules" : [ {
        "id" : "8a36f60a753badb401753bade3400002",
        "name" : "rule-xxx",
        "domain_name" : "www.example.com",
        "endpoint_id" : "8a36f60a753badb401753bade3400001",
        "status" : "ACTIVE",
        "rule_type" : "FORWARD",
        "ipaddress_count" : 0,
        "routers" : [ {
          "router_id" : "ff7bd47f-3f12-4f24-a078-e6064abaa670",
          "router_region" : "NetworkService",
          "status" : "ACTIVE"
        }, {
          "router_id" : "ff7bd47f-3f12-4f24-a078-e6064abaa671",
          "router_region" : "NetworkService",
          "status" : "ACTIVE"
        } ],
        "create_time" : "2020-10-18T12:27:31.448",
        "update_time" : "2020-10-18T12:27:31.448"
      } ],
      "links" : {
        "self" : "https://{Endpoint}/v2.1/resolverrules",
        "next" : "https://{Endpoint}/v2.1/resolverrules?marker=8a36f60a753badb401753bade3400002"
      },
      "page_info" : {
        "next_marker" : "8a36f60a753badb401753bade3400002",
        "previous_marker" : null,
        "current_count" : 1
      }
    }

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
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.dns.v2.region.DnsRegion;
import com.huaweicloud.sdk.dns.v2.*;
import com.huaweicloud.sdk.dns.v2.model.*;


public class ListResolverRulesSolution {

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

        DnsClient client = DnsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DnsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListResolverRulesRequest request = new ListResolverRulesRequest();
        try {
            ListResolverRulesResponse response = client.listResolverRules(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdns.v2.region.dns_region import DnsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdns.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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = ListResolverRulesRequest()
        response = client.list_resolver_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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dns.DnsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dns.NewDnsClient(hcClient)

    request := &model.ListResolverRulesRequest{}
	response, err := client.ListResolverRules(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

Successful request

400

Error response

500

Error response

Error Codes

See Error Codes.