Creating an Endpoint Rule
Function
This API is used to create an endpoint rule.
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:create
Write
resolverRule *
-
-
-
URI
POST /v2.1/resolverrules
Request 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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | Definition Rule name. Constraints N/A Range The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). Default Value N/A |
| domain_name | Yes | String | Definition Domain name. Constraints N/A Range N/A Default Value N/A |
| endpoint_id | Yes | String | Definition ID of the endpoint to which the current rule belongs. You can obtain the value by calling the API for querying endpoints (ListEndpoints). Constraints N/A Range N/A Default Value N/A |
| ipaddresses | Yes | Array of IpInfo objects | Definition Destination IP address added to a rule. This field is an array. Each element contains an IP address. Constraints N/A |
Response Parameters
Status code: 202
| Parameter | Type | Description |
|---|---|---|
| resolver_rule | ResolverRuleParam object | Definition Endpoint rule. |
| 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 |
| rule_type | String | Definition Rule type. This field is reserved. The default value is FORWARD. Range |
| ipaddress_count | Integer | Definition Number of IP addresses in the endpoint rule. Range N/A |
| 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 |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| code | String | Definition Error code Range N/A |
| message | String | Definition Error description Range N/A |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| code | String | Definition Error code Range N/A |
| message | String | Definition Error description Range N/A |
Example Requests
Creating an endpoint rule and setting the destination IP addresses to 1.1.1.1 and 2.2.2.2
POST https://{Endpoint}/v2.1/resolverrules
{
"name" : "rule-xxx",
"domain_name" : "www.example.com",
"endpoint_id" : "8a36f60a753badb401753bade3400001",
"ipaddresses" : [ {
"ip" : "1.1.1.1"
}, {
"ip" : "2.2.2.2"
} ]
} Example Responses
Status code: 202
{
"resolver_rule" : {
"id" : "8a36f60a753badb401753bade3400002",
"name" : "rule-xxx",
"domain_name" : "www.example.com",
"endpoint_id" : "8a36f60a753badb401753bade3400001",
"status" : "ACTIVE",
"rule_type" : "FORWARD",
"ipaddress_count" : 2,
"create_time" : "2020-10-18T12:27:31.448",
"update_time" : "2020-10-18T12:27:31.448"
}
} SDK Sample Code
The SDK sample code is as follows.
Creating an endpoint rule and setting the destination IP addresses to 1.1.1.1 and 2.2.2.2
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.dns.v2.region.DnsRegion; import com.huaweicloud.sdk.dns.v2.*; import com.huaweicloud.sdk.dns.v2.model.*; import java.util.List; import java.util.ArrayList; public class CreateResolverRuleSolution { 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(); CreateResolverRuleRequest request = new CreateResolverRuleRequest(); CreateResolverRuleRequestBody body = new CreateResolverRuleRequestBody(); List<IpInfo> listbodyIpaddresses = new ArrayList<>(); listbodyIpaddresses.add( new IpInfo() .withIp("1.1.1.1") ); listbodyIpaddresses.add( new IpInfo() .withIp("2.2.2.2") ); body.withIpaddresses(listbodyIpaddresses); body.withEndpointId("8a36f60a753badb401753bade3400001"); body.withDomainName("www.example.com"); body.withName("rule-xxx"); request.withBody(body); try { CreateResolverRuleResponse response = client.createResolverRule(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()); } } } |
Creating an endpoint rule and setting the destination IP addresses to 1.1.1.1 and 2.2.2.2
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 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 = CreateResolverRuleRequest() listIpaddressesbody = [ IpInfo( ip="1.1.1.1" ), IpInfo( ip="2.2.2.2" ) ] request.body = CreateResolverRuleRequestBody( ipaddresses=listIpaddressesbody, endpoint_id="8a36f60a753badb401753bade3400001", domain_name="www.example.com", name="rule-xxx" ) response = client.create_resolver_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creating an endpoint rule and setting the destination IP addresses to 1.1.1.1 and 2.2.2.2
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 63 | 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.CreateResolverRuleRequest{} ipIpaddresses:= "1.1.1.1" ipIpaddresses1:= "2.2.2.2" var listIpaddressesbody = []model.IpInfo{ { Ip: &ipIpaddresses, }, { Ip: &ipIpaddresses1, }, } request.Body = &model.CreateResolverRuleRequestBody{ Ipaddresses: listIpaddressesbody, EndpointId: "8a36f60a753badb401753bade3400001", DomainName: "www.example.com", Name: "rule-xxx", } response, err := client.CreateResolverRule(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 |
|---|---|
| 202 | Request accepted |
| 400 | Error response |
| 500 | Error response |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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