Querying Line Groups
Function
This API is used to query the line groups. This API is not available in some regions. To use this API, submit a service ticket.
Calling Method
For details, see Calling APIs.
URI
GET /v2.1/linegroups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
line_id |
No |
String |
Line group ID. Fuzzy search will work. |
name |
No |
String |
Line group name. Fuzzy search will work. |
limit |
No |
Integer |
The number of records returned on each page during pagination query. The value ranges from 0 to 500. Commonly used values are 10, 20, and 50, and the default value is 500. |
offset |
No |
Integer |
The offset of pagination query. It specifies the number of rows or records to skip from the beginning of the result set before retrieving the desired data. Range: 0 to 2147483647 Default value: 0 If marker is not left blank, the query starts from the resource specified by marker and the offset does not take effect. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining a User Token. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
linegroups |
Array of CreateLineGroupsResp objects |
List object. |
metadata |
metadata object |
Definition Number of resources that meet the filter condition Range N/A |
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. The value can be PENDING_CREATE, ACTIVE, PENDING_DELETE, PENDING_UPDATE, ERROR, FREEZE, or DISABLE. |
description |
String |
Line group description. |
line_id |
String |
Line group ID |
created_at |
String |
The creation time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS |
updated_at |
String |
The update time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS |
Parameter |
Type |
Description |
---|---|---|
total_count |
Integer |
Definition Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. 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
None
Example Responses
Status code: 200
Response to the request for querying the line groups
{
"linegroups" : [ {
"name" : "linegroup",
"lines" : [ "ST", "LA" ],
"status" : "ACTIVE",
"description" : "123",
"line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf",
"created_at" : "2019-07-29T08:41:38.096",
"updated_at" : "2019-07-29T08:41:38.610"
}, {
"name" : "20190729034848812group",
"lines" : [ "Liantong", "Dianxin_Guangdong" ],
"status" : "ACTIVE",
"description" : "auto create",
"line_id" : "lgroup_4011afa26c33050b016c3cbeaf650f84",
"created_at" : "2019-07-29T08:00:25.443",
"updated_at" : "2019-07-29T08:00:26.040"
} ],
"metadata" : {
"total_count" : 2
}
}
SDK Sample Code
The SDK sample code is as follows.
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 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.*;
public class ListLineGroupsSolution {
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();
ListLineGroupsRequest request = new ListLineGroupsRequest();
try {
ListLineGroupsResponse response = client.listLineGroups(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());
}
}
}
|
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 |
# 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 = ListLineGroupsRequest()
response = client.list_line_groups(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
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 |
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.ListLineGroupsRequest{}
response, err := client.ListLineGroups(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.
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 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.*;
public class ListLineGroupsSolution {
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();
ListLineGroupsRequest request = new ListLineGroupsRequest();
try {
ListLineGroupsResponse response = client.listLineGroups(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());
}
}
}
|
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 |
# 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 = ListLineGroupsRequest()
response = client.list_line_groups(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
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 |
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.ListLineGroupsRequest{}
response, err := client.ListLineGroups(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 |
---|---|
200 |
Response to the request for querying the line groups |
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