Creating a Custom Line
Function
This API is used to create a custom line.
Calling Method
For details, see Calling APIs.
URI
POST /v2.1/customlines
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 |
Yes |
String |
Custom line name. The value contains 1 to 80 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. The name of each resolution line must be unique in an account. |
ip_segments |
Yes |
Array of strings |
IP address range. Use hyphens (-) to separate IP addresses. The smaller IP address is placed before the larger IP address. IP address ranges cannot overlap. If there is only one IP address, set this parameter to IP1-IP1. Only IPv4 addresses are supported. You can specify a maximum of 50 different IP address ranges. |
description |
No |
String |
Custom line description. The value can contain a maximum of 255 characters and is left blank by default. |
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 description |
Example Requests
Creating 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
POST https://{endpoint}/v2.1/customlines { "name" : "customline", "ip_segments" : [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ], "description" : "123" }
Example Responses
Status code: 202
Response to the request for creating a custom line.
{ "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_CREATE", "created_at" : "2019-04-10T12:03:17.827", "updated_at" : null, "description" : "123" }
SDK Sample Code
The SDK sample code is as follows.
Creating 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 |
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 CreateCustomLineSolution { 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(); CreateCustomLineRequest request = new CreateCustomLineRequest(); CreateCustomLines body = new CreateCustomLines(); 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("123"); body.withIpSegments(listbodyIpSegments); body.withName("customline"); request.withBody(body); try { CreateCustomLineResponse response = client.createCustomLine(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 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 |
# 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 = CreateCustomLineRequest() listIpSegmentsbody = [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ] request.body = CreateCustomLines( description="123", ip_segments=listIpSegmentsbody, name="customline" ) response = client.create_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) |
Creating 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 |
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.CreateCustomLineRequest{} var listIpSegmentsbody = []string{ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3", } descriptionCreateCustomLines:= "123" request.Body = &model.CreateCustomLines{ Description: &descriptionCreateCustomLines, IpSegments: listIpSegmentsbody, Name: "customline", } response, err := client.CreateCustomLine(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 creating 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