Creating a Line Group
Function
This API is used to create a line group. This API is not available in some regions. To use this API, submit a service ticket.
Calling Method
For details, see Calling APIs.
URI
POST /v2.1/linegroups
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 |
Line group name. The name cannot be the same as the custom line name or preconfigured line name. The value can contain 1 to 64 characters, including digits, letters, underscores (_), hyphens (-), and periods (.). |
description |
No |
String |
Line group description. A maximum of 255 characters are allowed. It is left blank by default. |
lines |
Yes |
Array of strings |
List of lines contained in a line group. At least two lines are required. Resolution line IDs are used here. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
name |
String |
Line group name |
lines |
Array of strings |
List of lines contained in a line group (Resolution line IDs are used here.) |
status |
String |
Resource status. Value options: PENDING_CREATE, ACTIVE, PENDING_DELETE, PENDING_UPDATE, ERROR, FREEZE, and DISABLE |
description |
String |
Line group description |
line_id |
String |
Line group ID |
created_at |
String |
Time when the line group was created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS. |
updated_at |
String |
Time when the line group was updated. Format: yyyy-MM-dd'T'HH:mm:ss.SSS. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code Minimum: 8 Maximum: 36 |
message |
String |
Description Minimum: 2 Maximum: 512 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code Minimum: 8 Maximum: 36 |
message |
String |
Description Minimum: 2 Maximum: 512 |
Example Requests
Creating a line group that contains the lines ST and LA
POST https://{endpoint}/v2.1/linegroups { "name" : "linegroup", "description" : "123", "lines" : [ "ST", "LA" ] }
Example Responses
Status code: 202
Response to the request for creating a line group
{ "name" : "linegroup", "lines" : [ "ST", "LA" ], "status" : "PENDING_CREATE", "description" : "123", "line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf", "created_at" : "2019-07-29T08:41:38.096", "updated_at" : null }
SDK Sample Code
The SDK sample code is as follows.
Creating a line group that contains the lines ST and LA
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 CreateLineGroupSolution { 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(); CreateLineGroupRequest request = new CreateLineGroupRequest(); CreateLineGroupsReq body = new CreateLineGroupsReq(); List<String> listbodyLines = new ArrayList<>(); listbodyLines.add("ST"); listbodyLines.add("LA"); body.withLines(listbodyLines); body.withDescription("123"); body.withName("linegroup"); request.withBody(body); try { CreateLineGroupResponse response = client.createLineGroup(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 line group that contains the lines ST and LA
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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DnsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DnsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateLineGroupRequest() listLinesbody = [ "ST", "LA" ] request.body = CreateLineGroupsReq( lines=listLinesbody, description="123", name="linegroup" ) response = client.create_line_group(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 line group that contains the lines ST and LA
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.CreateLineGroupRequest{} var listLinesbody = []string{ "ST", "LA", } descriptionCreateLineGroupsReq:= "123" request.Body = &model.CreateLineGroupsReq{ Lines: listLinesbody, Description: &descriptionCreateLineGroupsReq, Name: "linegroup", } response, err := client.CreateLineGroup(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 line group |
400 |
Error response |
500 |
Error response |
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