You need to enable JavaScript to run this app.
文档中心
专线连接

专线连接

复制全文
下载 pdf
物理专线
DescribeDirectConnectConnections - 查询物理专线列表
复制全文
下载 pdf
DescribeDirectConnectConnections - 查询物理专线列表
调用DescribeDirectConnectConnections查询符合要求的物理专线的详细信息。​
使用说明​
  • 若请求参数不传入DirectConnectConnectionIds,则会按照传入的其他参数查询,返回符合条件的物理专线。​
  • 若请求参数中的非必选参数都不传入,则会按照当前登录账户查询,返回当前账户下的所有物理专线。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeDirectConnectConnections​
接口名称。当前 API 的名称为 DescribeDirectConnectConnections。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为 2020-04-01。​
​
DirectConnectConnectionIds.N String 可选 示例值:dcc-7qthudw0ll6jmc****​
物理专线的ID。​
  • 参数 - N:表示物理专线ID的序号,单次调用数量上限100个。​
  • 多个物理专线ID之间用&分隔。​
​
DirectConnectConnectionName String 可选 示例值:test​
物理专线的名称。​
​
LineOperator String 可选 示例值:ChinaTelecom​
物理专线的运营商。​
  • ChinaTelecom:中国电信​
  • ChinaMobile:中国移动​
  • ChinaUnicom:中国联通​
  • ChinaOther:中国其他具有相应电信业务经营资质的运营商。​
​
DirectConnectAccessPointId String 可选 示例值:ap-cn-shanghai-***-A​
物理专线接入点的ID。可调用DescribeDirectConnectAccessPoints查询专线接入点的信息。​
​
PeerLocation String 可选 示例值:北京IDC​
物理专线的对端接入点。​
​
PageNumber Integer 可选 示例值:1​
列表的页码。​
  • 如需传入此参数,请传入非负整数。​
  • 不传或传入0,则均默认为1。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数。最大值为100,默认值为20。​
​
ConnectionType String 可选 示例值:DedicatedConnection​
物理专线类型。​
  • SharedConnection:共享专线​
  • DedicatedConnection:独享专线​
​
TagFilters.N.Key String 可选 示例值:key1​
云资源实例的标签键(Key)。​
  • 参数 - N:表示标签键的序号,取值范围:1~10。​
  • 多个标签键之间用&分隔。​
  • 如果传入多个TagFilters.N.Key,多个TagFilters.N.Key之间的关系为逻辑“与(AND)”,不允许重复。​
​
TagFilters.N.Values.M String 可选 示例值:value1​
云资源实例的标签值(Value)。​
  • 参数 - N:表示标签键的序号,取值范围:1~10。​
  • 参数 - M:表示标签值的序号,取值范围:1~3,即同一标签键最多支持同时查询3个标签值。​
  • 多个标签值之间用&分隔。​
  • 如果传入该参数,则必须先传入TagFilters.N.Key。​
  • 如果不传该参数仅传入TagFilters.N.Key,表示查询同一标签键下的所有标签值。​
  • 传入空字符串时,表示查询标签值为空的标签。​
  • 如果同一个TagFilters.N.Key传入多个TagFilters.N.Values.M,多个TagFilters.N.Values.M之间的关系为逻辑“或(OR)”。​
​
ProjectName String 可选 示例值:Project_1​
物理专线所属的项目。​
  • 传入该字段,表示查询指定项目下的物理专线。​
  • 不传入该字段,表示查询所有项目的物理专线。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
TotalCount Integer 示例值:10​
满足指定条件的物理专线总数。​
​
PageNumber Integer 示例值:1​
当前页码。​
​
PageSize Integer 示例值:20​
当前分页的行数。​
​
DirectConnectConnections Object[] 示例值:-​
物理专线的详细信息。​
Tags Object[] 示例值:-​
物理专线的标签信息。​
Key String 示例值:k1​
标签键。​
​
Value String 示例值:v1​
标签值。​
​
​
Status String 示例值:Available​
物理专线的状态。​
  • Creating: 创建中​
  • Deleting: 删除中​
  • Pending:配置中​
  • Available:可用​
  • Initial:申请中​
  • Allocated:施工中​
  • Rejected:申请驳回​
  • UnConfirmed:等待对方接受​
  • NoPayment:待支付​
​
VlanId Integer 示例值:1212​
共享专线的VLAN ID。若物理专线类型为独享专线,则此参数返回“0”。​
​
PortSpec String 示例值:1G​
专线端口规格。​
​
PortType String 示例值:1000Base​
物理专线的端口类型。​
  • 1000Base:表示1G光口。​
  • 10GBase:表示10G光口。​
  • 40GBase:表示40G光口。​
  • 100GBase:表示100G光口。​
说明​
40GBase、100GBase默认不开放,如有需要,请联系客户经理。​
​
AccountId String 示例值:21000*****​
物理专线所属账号的ID。​
​
Bandwidth Integer 示例值:1000​
物理专线的带宽,单位:Mbps。​
​
LineNumber String 示例值:N9332***​
上云链路服务的楼内线编号。​
​
UpdateTime String 示例值:2021-04-09T08:36:47+08:00​
更新物理专线的时间。​
​
BillingType Integer 示例值:1​
专线计费类型,当前仅支持“1”包年包月计费。​
​
DeletedTime String 示例值:2023-12-02 23:59:59​
预期资源强制回收时间。​
​
Description String 示例值:DCCDescription​
物理专线的描述。​
​
ExpiredTime String 示例值:2023-12-03 12:00:00​
专线的到期时间。​
​
ProjectName String 示例值:default​
物理专线所在的项目。​
​
CreationTime String 示例值:2021-04-09T08:36:47+08:00​
创建物理专线的时间。​
​
CustomerName String 示例值:韩*梅​
专线联系人姓名。​
​
LineOperator String 示例值:ChinaTelecom​
物理专线的运营商​
  • ChinaTelecom:中国电信​
  • ChinaMobile:中国移动​
  • ChinaUnicom:中国联通​
  • ChinaOther:中国其他具有相应电信业务经营资质的运营商。​
​
PeerLocation String 示例值:北京IDC​
物理专线的对端接入点。​
​
BusinessStatus String 示例值:Normal​
专线的计费状态。​
  • Normal: 正常。​
  • FinancialLocked: 被锁定。​
​
ConnectionType String 示例值:DedicatedConnection​
物理专线的类型。​
  • DedicatedConnection:独享专线​
  • SharedConnection:共享专线​
​
ExpectBandwidth Integer 示例值:500​
期望物理专线的带宽,单位:Mbps。​
​
IsCloudLinkService Boolean 示例值:false​
是否为上云链路服务。​
  • true:是。​
  • false:否。​
​
ParentConnectionId String 示例值:dcc-3rlkegezm2rcw10exd3rxdyhc​
共享专线所属物理专线的ID。若物理专线类型为独享专线,则此参数返回空。​
​
CustomerContactEmail String 示例值:exampletest@163.com​
专线联系人联系邮箱。​
​
CustomerContactPhone String 示例值:185****2333​
专线联系人联系电话。​
​
DirectConnectConnectionId String 示例值:dcc-7qthudw0ll6jmc****​
物理专线的ID。​
  • 若物理专线类型为独享专线,则返回值为独享专线的ID。​
  • 若物理专线类型为共享专线,则返回值为共享专线的ID。​
​
ParentConnectionAccountId String 示例值:200***001012​
共享专线所属物理专线的账号ID。若物理专线类型为独享专线,则此参数返回空。​
​
DirectConnectAccessPointId String 示例值:ap-cn-shanghai-***-A​
物理专线接入点的ID。​
您可调用DescribeDirectConnectAccessPoints接口,查询专线接入点的信息。​
​
ExpectedExpireShutdownTime String 示例值:2024-10-11 12:00:00​
专线到期时间。​
​
DirectConnectConnectionName String 示例值:DCCTestName​
物理专线的名称。​
​
DirectConnectTrafficQosPolicyId String 示例值:dcq-4atoi32cl4c9t0q****​
物理专线关联的QoS策略的ID。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeDirectConnectConnections&Version=2020-04-01&DirectConnectConnectionIds.1=dcc-7qthudw0ll6jmc****&DirectConnectConnectionName=test&LineOperator=ChinaTelecom&DirectConnectAccessPointId=ap-cn-shanghai-***-A&PeerLocation=北京IDC&PageNumber=1&PageSize=20&ConnectionType=DedicatedConnection&TagFilters.1.Key=key1&TagFilters.1.Values.M=value1&ProjectName=Project_1 HTTP/1.1​
Host: directconnect.cn-beijing.volcengineapi.com​
X-Date: 20250804T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/directconnect/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeDirectConnectConnections",​
"Version": "2020-04-01",​
"Service": "directconnect",​
"Region": "cn-north-1"​
},​
"Result": {​
"DirectConnectConnections": [​
{​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"Status": "Available",​
"VlanId": 1212,​
"PortSpec": "1G",​
"PortType": "1000Base",​
"AccountId": "21000*****",​
"Bandwidth": 1000,​
"LineNumber": "N9332***",​
"UpdateTime": "2021-04-09T08:36:47+08:00",​
"BillingType": 1,​
"DeletedTime": "2023-12-02 23:59:59",​
"Description": "DCCDescription",​
"ExpiredTime": "2023-12-03 12:00:00",​
"ProjectName": "default",​
"CreationTime": "2021-04-09T08:36:47+08:00",​
"CustomerName": "韩*梅",​
"LineOperator": "ChinaTelecom",​
"PeerLocation": "北京IDC",​
"BusinessStatus": "Normal",​
"ConnectionType": "DedicatedConnection",​
"ExpectBandwidth": 500,​
"IsCloudLinkService": false,​
"ParentConnectionId": "dcc-3rlkegezm2rcw10exd3rxdyhc",​
"CustomerContactEmail": "exampletest@163.com",​
"CustomerContactPhone": "185****2333",​
"DirectConnectConnectionId": "dcc-7qthudw0ll6jmc****",​
"ParentConnectionAccountId": "200***001012",​
"DirectConnectAccessPointId": "ap-cn-shanghai-***-A",​
"ExpectedExpireShutdownTime": "2024-10-11 12:00:00",​
"DirectConnectConnectionName": "DCCTestName",​
"DirectConnectTrafficQosPolicyId": "dcq-4atoi32cl4c9t0q****"​
}​
],​
"PageNumber": 1,​
"PageSize": 20,​
"TotalCount": 10​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
LimitExceeded.DirectConnectConnectionId​
You've reached the limit on the number of direct connect connection IDs that you can describe.​
已达到可查询的物理连接ID数量上限。​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
InvalidTagFilterKey.Malformed​
The specified parameter tag filter key is invalid.​
过滤标签键不合法。​
400​
InvalidTagFilterValue.Malformed​
The specified parameter tag filter value is invalid.​
过滤标签值不合法。​
400​
LimitExceeded.TagFilterKey​
You've reached the limit on the number of tag keys that you can filter.​
已达到单次可指定过滤标签键数量的上限。​
400​
LimitExceeded.TagFilterValue​
You've reached the limit on the number of tag values that you can filter.​
已达到单次可指定过滤标签值数量的上限。​
400​
InvalidTagFilter.Disorder​
The specified index order of tag filter is malformed.​
指定标签过滤项的索引顺序参数格式不合法。​
​
​
最近更新时间:2026.07.10 15:41:38
这个页面对您有帮助吗?
有用
有用
无用
无用