DescribeDirectConnectAccessPoints--专线连接-火山引擎

文档中心

立即注册

导航

DescribeDirectConnectAccessPoints

最近更新时间：2024.04.18 19:01:52首次发布时间：2022.07.01 08:31:47

调用DescribeDirectConnectAccessPoints查询专线接入点信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDirectConnectAccessPoints	要执行的操作，取值：DescribeDirectConnectAccessPoints
Version	String	是	2020-04-01	API版本信息。
DirectConnectAccessPointIds.N	String	否	DirectConnectAccessPointIds.1=ap-cn-shanghai-*-A&DirectConnectAccessPointIds.1=ap-cn-shanghai-*-A	待查询的专线接入点ID。参数 - N：表示专线接入点ID的序号，单次调用数量上限100个。多个ID之间用&分隔。不传默认查询全部接入点的信息。
PageSize	Integer	否	20	分页查询时每页的行数。最大值：100，默认值：20。
PageNumber	Integer	否	1	分页查询的页码。如需传入此参数，请传入非负整数。不传或传入0，则均默认为1。

返回数据

名称	类型	示例值	描述
RequestId	String	2022062710352001022514214204A*****	请求ID。
PageSize	Integer	20	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	1	符合条件的专线接入点总数。
DirectConnectAccessPoints	Array of struct	-	专线接入点的详细信息，具体请参见下表“DirectConnectAccessPoint”。

DirectConnectAccessPoint

名称	类型	示例值	描述
DirectConnectAccessPointId	String	ap-cn-shanghai-***-A	专线接入点ID。
DirectConnectAccessPointName	String	LFWG	专线接入点名称。
Location	String	廊坊万国	专线接入点物理位置。
LineOperators	List of String	["ChinaTelecom","ChinaMobile","ChinaUnicom"]	专线接入点支持的运营商类型。 ChinaTelecom：中国电信 ChinaMobile：中国移动 ChinaUnicom：中国联通 ChinaOther：中国其他具有相应电信业务经营资质的运营商。
Description	String	中国移动接入点	专线接入点的描述信息。
Status	String	Available	专线接入点的状态。 Available：可用 UnAvailable：不可用

请求示例

GET /?Action=DescribeDirectConnectAccessPoints&Version=2020-04-01&PageNumber=1&PageSize=20&DirectConnectAccessPointIds=ap-cn-beijing-*** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
 "ResponseMetadata": {
     "RequestId": "2022062710352001022514214204A*****",
     "Action": "DescribeDirectConnectAccessPoints",
     "Version": "2020-04-01",
     "Service": "directconnect",
     "Region": "cn-beijing"
 },
 "Result": {
     "RequestId": "2022062710352001022514214204A*****",
     "PageNumber": 1,
     "PageSize": 20,
     "TotalCount": 1,
     "DirectConnectAccessPoints": [
     {
         "DirectConnectAccessPointId": "ap-cn-beijing-***",
         "DirectConnectAccessPointName": "北京***",
         "Location": "北京***",
         "LineOperators": [
             "ChinaTelecom",
             "ChinaMobile",
             "ChinaUnicom",
             "ChinaOther"
         ],
         "Description": "test",
         "Status": "Available"
 }
 ]
 }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.DirectConnectAccessPointId	You've reached the limit on the number of direct connect access point IDs that you can describe.	已达到可查询的专线接入点数量上限。