查询线路分组列表
功能介绍
查询线路分组列表。该接口部分区域未上线、如需使用请提交工单申请开通。
调用方法
请参见如何调用API。
URI
GET /v2.1/linegroups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
line_id |
否 |
String |
线路分组ID。 模糊匹配。 |
name |
否 |
String |
线路分组名称。 模糊匹配。 |
limit |
否 |
Integer |
每页返回的资源个数。 当查询详细信息时:取值范围:0~100取值一般为10,20,50默认为100。 当查询概要信息时:取值范围:0~3000默认为3000。 |
offset |
否 |
Integer |
分页查询起始偏移量,表示从偏移量的下一个资源开始查询。 取值范围:0~2147483647 默认值为0。 当前设置marker不为空时,以marker为分页起始标识。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
linegroups |
Array of CreateLineGroupsResp objects |
列表对象。 |
metadata |
metadata object |
返回满足过滤条件的资源总数。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
线路分组名称。 |
lines |
Array of strings |
线路分组包含的线路列表。 解析线路ID。 |
status |
String |
资源状态。 取值范围:PENDING_CREATE,ACTIVE,PENDING_DELETE,PENDING_UPDATE,ERROR,FREEZE,DISABLE。 |
description |
String |
线路分组的描述信息 |
line_id |
String |
线路分组的id。 |
created_at |
String |
创建时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 |
updated_at |
String |
更新时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 最小长度:8 最大长度:36 |
message |
String |
错误描述 最小长度:2 最大长度:512 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 最小长度:8 最大长度:36 |
message |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
无
响应示例
状态码: 200
查询线路分组列表响应。
{ "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代码示例
SDK代码示例如下。
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 |
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(); request.withLineId("<line_id>"); request.withName("<name>"); request.withLimit(<limit>); request.withOffset(<offset>); 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 31 32 33 34 |
# 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() request.line_id = "<line_id>" request.name = "<name>" request.limit = <limit> request.offset = <offset> 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 36 37 38 39 40 41 42 43 |
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{} lineIdRequest:= "<line_id>" request.LineId = &lineIdRequest nameRequest:= "<name>" request.Name = &nameRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListLineGroups(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询线路分组列表响应。 |
400 |
接口错误响应。 |
500 |
接口错误响应。 |
错误码
请参见错误码。