Updating a Custom Line
Function
This API is used to update a custom line.
Calling Method
For details, see Calling APIs.
URI
PUT /v2.1/customlines/{line_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
line_id |
Yes |
String |
Resolution line ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Custom line name |
ip_segments |
No |
Array of strings |
IP address range. The start IP address is separated from the end IP address with a hyphen (-). The IP address ranges cannot overlap. If the start and end IP addresses are the same, there is only one IP address in the range. Set the value to IP1-IP1. Currently, only IPv4 addresses are supported. |
description |
No |
String |
Custom line description. A maximum of 255 characters are allowed. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
line_id |
String |
Resolution line ID |
name |
String |
Custom line name |
ip_segments |
Array of strings |
IP address range |
created_at |
String |
Time when the custom line was created |
updated_at |
String |
Time when the custom line was updated |
status |
String |
Resource status |
description |
String |
Custom line |
Example Requests
Modifying the name and description of a custom line and setting the IP address range to 1.1.1.1-1.1.1.1 and 1.1.1.2-1.1.1.3
PUT https://{endpoint}/v2.1/customlines/{line_id} { "name" : "customline", "ip_segments" : [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ], "description" : "1234" }
Example Responses
Status code: 202
{ "line_id" : "custom_2ce45ef669fc87870169fcbada7a0007", "name" : "customline", "ip_segments" : [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ], "status" : "PENDING_UPDATE", "created_at" : "2019-04-10T12:03:17.827", "updated_at" : "2019-04-10T12:03:17.827", "description" : "1234" }
SDK Sample Code
The SDK sample code is as follows.
Modifying the name and description of a custom line and setting the IP address range to 1.1.1.1-1.1.1.1 and 1.1.1.2-1.1.1.3
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 |
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 UpdateCustomLineSolution { 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(); UpdateCustomLineRequest request = new UpdateCustomLineRequest(); request.withLineId("{line_id}"); UpdateCustomsLineReq body = new UpdateCustomsLineReq(); List<String> listbodyIpSegments = new ArrayList<>(); listbodyIpSegments.add("1.1.1.1-1.1.1.1"); listbodyIpSegments.add("1.1.1.2-1.1.1.3"); body.withDescription("1234"); body.withIpSegments(listbodyIpSegments); body.withName("customline"); request.withBody(body); try { UpdateCustomLineResponse response = client.updateCustomLine(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()); } } } |
Modifying the name and description of a custom line and setting the IP address range to 1.1.1.1-1.1.1.1 and 1.1.1.2-1.1.1.3
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 |
# 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 = UpdateCustomLineRequest() request.line_id = "{line_id}" listIpSegmentsbody = [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ] request.body = UpdateCustomsLineReq( description="1234", ip_segments=listIpSegmentsbody, name="customline" ) response = client.update_custom_line(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Modifying the name and description of a custom line and setting the IP address range to 1.1.1.1-1.1.1.1 and 1.1.1.2-1.1.1.3
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dns.NewDnsClient( dns.DnsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateCustomLineRequest{} request.LineId = "{line_id}" var listIpSegmentsbody = []string{ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3", } descriptionUpdateCustomsLineReq:= "1234" nameUpdateCustomsLineReq:= "customline" request.Body = &model.UpdateCustomsLineReq{ Description: &descriptionUpdateCustomsLineReq, IpSegments: &listIpSegmentsbody, Name: &nameUpdateCustomsLineReq, } response, err := client.UpdateCustomLine(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 |
Response to the request for updating a custom line |
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