查询解析器转发规则列表
功能介绍
查询解析器转发规则列表。
调用方法
请参见如何调用API。
URI
GET /v2.1/resolverrules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_name |
否 |
String |
待查询的转发规则的域名。 |
name |
否 |
String |
待查询的转发规则的名称。 |
endpoint_id |
否 |
String |
终端节点ID。 |
id |
否 |
String |
转发规则ID。 |
limit |
否 |
Integer |
参数解释: 分页查询时配置每页返回的资源个数。 约束限制: 不涉及。 取值范围: 0~500。 默认取值: 500 |
offset |
否 |
Integer |
参数解释: 分页查询起始偏移量,表示从偏移量的下一个资源开始查询。 约束限制: 当设置marker不为空时,以marker为分页起始标识,offset不生效。 取值范围: 0~2147483647。 默认取值: 0 |
marker |
否 |
String |
参数解释: 分页查询的起始资源ID。
约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 获取用户Token请参见获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
resolver_rules |
Array of ListResolverRuleParam objects |
解析器转发规则列表。 |
links |
pageLink object |
参数解释: 指向当前页或者其他页的链接。当查询需要分页时,需要包含一个next链接指向下一页。 取值范围: 不涉及。 |
metadata |
metadata object |
参数解释: 返回满足过滤条件的资源总数。 取值范围: 不涉及。 |
page_info |
PageInfo object |
参数解释: 分页信息。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
转发规则的ID。 |
name |
String |
规则名称。 |
domain_name |
String |
域名。 |
endpoint_id |
String |
当前规则所属的终端节点ID。 |
status |
String |
资源状态。 取值范围:PENDING_CREATE, ACTIVE, PENDING_DELETE, ERROR。 |
rule_type |
String |
规则类型。 预留字段,当前默认为FORWARD。 |
ipaddress_count |
Integer |
当前规则下的IP地址数量。 |
routers |
Array of Router objects |
关联的VPC信息。 |
create_time |
String |
创建时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 |
update_time |
String |
更新时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 |
参数 |
参数类型 |
描述 |
---|---|---|
router_id |
String |
关联VPC的ID。 |
router_region |
String |
关联VPC所在的region。 |
status |
String |
资源状态。 |
参数 |
参数类型 |
描述 |
---|---|---|
next_marker |
String |
参数解释: 下一页的页面标识。 取值范围: 不涉及。 |
previous_marker |
String |
参数解释: 上一页的页面标识。 取值范围: 不涉及。 |
current_count |
Integer |
参数解释: 页面数量。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
message |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
message |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
无
响应示例
状态码:200
查询解析器转发规则列表响应。
{ "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" } ], "metadata" : { "total_count" : 33 } }
SDK代码示例
SDK代码示例如下。
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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dns.NewDnsClient( dns.DnsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListResolverRulesRequest{} response, err := client.ListResolverRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询解析器转发规则列表响应。 |
400 |
接口错误响应。 |
500 |
接口错误响应。 |
错误码
请参见错误码。