Updating the DNS Server List
Function
This API is used to update the DNS server list.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/dns/servers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
fw_instance_id |
No |
String |
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
enterprise_project_id |
No |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dns_server |
No |
Array of dns_server objects |
DNS server |
health_check_domain_name |
No |
String |
Health check domain name |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
Array of strings |
Domain name server list |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Description Minimum: 2 Maximum: 512 |
Example Requests
Update the settings of the DNS resolver whose project ID is 2349ba469daf4b7daf268bb0261d18b0. Set server 8.8.8.8 to the default server and put it in use. Set server IP address 192.168.0.2 to a user-defined server and do not put it in use.
https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers { "dns_server" : [ { "server_ip" : "8.8.8.8", "is_customized" : 0, "is_applied" : 1 }, { "server_ip" : "192.168.0.2", "is_customized" : 1, "is_applied" : 0 } ] }
Example Responses
Status code: 200
Response to the request for updating the DNS server list
{ "data" : [ "100.95.150.83", "114.114.114.114", "223.5.5.5", "223.6.6.6", "119.29.29.29", "8.8.8.8", "100.79.1.250", "100.79.1.240" ] }
Status code: 400
Bad Request
{ "error_code" : "CFW.01000001", "error_msg" : "Duplicate DNS server IP address" }
SDK Sample Code
The SDK sample code is as follows.
Java
Update the settings of the DNS resolver whose project ID is 2349ba469daf4b7daf268bb0261d18b0. Set server 8.8.8.8 to the default server and put it in use. Set server IP address 192.168.0.2 to a user-defined server and do not put it in use.
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 64 65 |
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.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; import java.util.List; import java.util.ArrayList; public class UpdateDnsServersSolution { 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); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); UpdateDnsServersRequest request = new UpdateDnsServersRequest(); request.withFwInstanceId("<fw_instance_id>"); request.withEnterpriseProjectId("<enterprise_project_id>"); UpdateDnsServersRequestBody body = new UpdateDnsServersRequestBody(); List<UpdateDnsServersRequestBodyDnsServer> listbodyDnsServer = new ArrayList<>(); listbodyDnsServer.add( new UpdateDnsServersRequestBodyDnsServer() .withServerIp("8.8.8.8") .withIsCustomized(0) .withIsApplied(1) ); listbodyDnsServer.add( new UpdateDnsServersRequestBodyDnsServer() .withServerIp("192.168.0.2") .withIsCustomized(1) .withIsApplied(0) ); body.withDnsServer(listbodyDnsServer); request.withBody(body); try { UpdateDnsServersResponse response = client.updateDnsServers(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()); } } } |
Python
Update the settings of the DNS resolver whose project ID is 2349ba469daf4b7daf268bb0261d18b0. Set server 8.8.8.8 to the default server and put it in use. Set server IP address 192.168.0.2 to a user-defined server and do not put it in use.
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 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 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 = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateDnsServersRequest() request.fw_instance_id = "<fw_instance_id>" request.enterprise_project_id = "<enterprise_project_id>" listDnsServerbody = [ UpdateDnsServersRequestBodyDnsServer( server_ip="8.8.8.8", is_customized=0, is_applied=1 ), UpdateDnsServersRequestBodyDnsServer( server_ip="192.168.0.2", is_customized=1, is_applied=0 ) ] request.body = UpdateDnsServersRequestBody( dns_server=listDnsServerbody ) response = client.update_dns_servers(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
Update the settings of the DNS resolver whose project ID is 2349ba469daf4b7daf268bb0261d18b0. Set server 8.8.8.8 to the default server and put it in use. Set server IP address 192.168.0.2 to a user-defined server and do not put it in use.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/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 := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateDnsServersRequest{} fwInstanceIdRequest:= "<fw_instance_id>" request.FwInstanceId = &fwInstanceIdRequest enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest serverIpDnsServer:= "8.8.8.8" isCustomizedDnsServer:= int32(0) isAppliedDnsServer:= int32(1) serverIpDnsServer1:= "192.168.0.2" isCustomizedDnsServer1:= int32(1) isAppliedDnsServer1:= int32(0) var listDnsServerbody = []model.UpdateDnsServersRequestBodyDnsServer{ { ServerIp: &serverIpDnsServer, IsCustomized: &isCustomizedDnsServer, IsApplied: &isAppliedDnsServer, }, { ServerIp: &serverIpDnsServer1, IsCustomized: &isCustomizedDnsServer1, IsApplied: &isAppliedDnsServer1, }, } request.Body = &model.UpdateDnsServersRequestBody{ DnsServer: &listDnsServerbody, } response, err := client.UpdateDnsServers(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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 |
Response to the request for updating the DNS server list |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
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