You need to enable JavaScript to run this app.
导航
专线连接
  • 文档首页
    • /
  • 专线连接

DescribeDirectConnectConnections

最近更新时间：2024.04.18 19:01:50

首次发布时间：2022.03.25 07:38:20

我的收藏

调用DescribeDirectConnectConnections查询符合要求的物理专线的详细信息。

调用说明

  • 若请求参数不传入DirectConnectConnectionIds，则会按照传入的其他参数查询，返回符合条件的物理专线。
  • 若请求参数中的非必选参数都不传入，则会按照当前登录账户查询，返回当前账户下的所有物理专线。

调试

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

请求参数

名称类型是否必选示例值描述
ActionString是DescribeDirectConnectConnections要执行的操作，取值：DescribeDirectConnectConnections。
VersionString是2020-04-01API版本信息。

DirectConnectConnectionIds.N

List of String

否

DirectConnectConnectionIds.1= dcc-7qthudw0ll6jmc****& DirectConnectConnectionIds.2=dcc-13fszmm1xdssg3n6nu4x9****

物理专线的ID。

  • 参数 - N：表示物理专线ID的序号，单次调用数量上限100个。
  • 多个物理专线ID之间用&分隔。
DirectConnectConnectionNameString否test物理专线的名称。

LineOperator

String

否

ChinaTelecom

物理专线的运营商。

  • ChinaTelecom：中国电信
  • ChinaMobile：中国移动
  • ChinaUnicom：中国联通
  • ChinaOther：中国其他具有相应电信业务经营资质的运营商。
DirectConnectAccessPointIdString否ap-cn-shanghai-***-A物理专线接入点的ID。可调用DescribeDirectConnectAccessPoints查询专线接入点的信息。
PeerLocationString否北京IDC物理专线的对端接入点。

PageNumber

Integer

否

1

列表的页码。

  • 如需传入此参数，请传入非负整数。
  • 不传或传入0，则均默认为1。
PageSizeInteger否20分页查询时每页的行数。最大值为100，默认值为20。

ConnectionType

String

否

DedicatedConnection

物理专线类型。

  • SharedConnection：共享专线
  • DedicatedConnection：独享专线

TagFilters.N.Key

String

否

TagFilters.1.Key=key1&TagFilters.2.Key=key2&TagFilters.3.Key=key3

云资源实例的标签键（Key）。

  • 参数 - N - 参数：表示标签的序号，取值范围：1、2、3、……、9、10，且N应按照连续的从小到大的顺序。
  • 多个标签键之间用&分隔。
  • 如果传入多个TagFilters.N.Key，多个TagFilters.N.Key之间的关系为逻辑“与（AND）”。

TagFilters.N.Values.N

String

否

TagFilters.1.Values.1=value1&TagFilters.2.Values.2=value2&TagFilters.3.Values.3=value3

云资源实例的标签值（Value）。

  • 参数 - N - 参数- N ：第一个N表示标签值对应标签键的序号，应与标签键TagFilters.N.Key的序号保持一致，取值范围：1、2、3、……、9、10，且N应按照连续的从小到大的顺序。第二个N表示标签值的序号，取值范围：1、2、3。
  • 可不传入Value，表示查询时对Value不作限制。
  • 如果传入的Value是空字符串，表示查询 Value 为空的标签。
  • 如果同一个TagFilters.N.Key传入多个TagFilters.N.Values.N，多个TagFilters.N.Values.N之间的关系为逻辑“或(OR)”。

ProjectName

String

否

Project_1

物理专线所属的项目。

  • 传入该字段，表示查询指定项目下的物理专线。

  • 不传入该字段，表示查询所有项目的物理专线。

返回数据

名称类型示例值描述
RequestIdString20211222112033010224****请求ID。
TotalCountInteger10满足指定条件的物理专线总数。
PageNumberInteger1当前页码。
PageSizeInteger20当前分页的行数。
DirectConnectConnectionsArray of struct-物理专线的详细信息。具体请参见下表“ DirectConnectConnection ”。

DirectConnectConnection

名称类型
示例值
描述

ConnectionType

String

DedicatedConnection

物理专线的类型。

  • DedicatedConnection：独享专线
  • SharedConnection：共享专线
AccountIdString21000*****物理专线所属账号的ID。

DirectConnectConnectionId

String

dcc-7qthudw0ll6jmc****

物理专线的ID。

  • 若物理专线类型为独享专线，则返回值为独享专线的ID。
  • 若物理专线类型为共享专线，则返回值为共享专线的ID。
DirectConnectConnectionNameStringtest物理专线的名称。
DescriptionStringThis is a sample description物理专线的描述。
CreationTimeString2021-04-09T08:36:47+08:00创建物理专线的时间。
UpdateTimeString2021-04-10T09:18:28+08:00更新物理专线的时间。

PortType

String

1000Base

物理专线的端口类型。

  • 1000Base-T：表示1G电口。
  • 10GBase-T：表示10G电口。
  • 1000Base：表示1G光口。
  • 10GBase：表示10G光口。
  • 40GBase：表示40G光口。
  • 100GBase：表示100G光口。

说明

40GBase、100GBase默认不开放，如有需要，请联系客户经理。

BandwidthInteger1000物理专线的带宽，单位：Mbps。

LineOperator

String

ChinaTelecom

物理专线的运营商。

  • ChinaTelecom：中国电信
  • ChinaMobile：中国移动
  • ChinaUnicom：中国联通
  • ChinaOther：中国其他具有相应电信业务经营资质的运营商。
DirectConnectAccessPointIdStringap-cn-shanghai-***-A物理专线接入点的ID。
PeerLocationString北京IDC物理专线的对端接入点。

Status

String

Available

物理专线的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending：配置中
  • Available：可用
  • Initial：申请中
  • Allocated：施工中
  • Rejected：申请驳回
  • UnConfirmed：等待接受
  • NoPayment：待支付
VlanIdInteger1212共享专线的VLAN ID。若物理专线类型为独享专线，则此参数返回“0”。
ParentConnectionIdStringdcc-e5z1z57glr0g2yjrzamyw****共享专线所属物理专线的ID。若物理专线类型为独享专线，则此参数返回空。
ParentConnectionAccountIdString2000956****共享专线所属物理专线的账号ID。若物理专线类型为独享专线，则此参数返回空。
CustomerNameString韩*梅专线联系人姓名。
CustomerContactPhoneString185****2333专线联系人联系电话。
CustomerContactEmailStringexampletest@163.com专线联系人联系邮箱。
TagsArray of struct-物理专线已添加的全部标签信息。具体请参见下表“Tag”。
PortSpecString1G专线端口规格。
BillingTypeInteger1专线计费类型，当前仅支持“1”包年包月计费。

BusinessStatus

String

Normal

专线的计费状态。

  • Normal: 正常。
  • FinancialLocked: 被锁定。
DeletedTimeString2023-12-02 23:59:59预期资源强制回收时间。
ExpiredTimeString2023-12-03 12:00:00专线的到期时间。
ExpectBandwidthInteger500期望物理专线的带宽，单位：Mbps。
ProjectNameStringProject_1物理专线所属的项目。

Tag

名称
类型
示例值
描述
KeyStringkey1标签键。
ValueStringvalue1标签值。

请求示例

GET /?Action=DescribeDirectConnectConnections&Version=2020-04-01&DirectConnectConnectionIds.1=dcc-7qthudw0ll6jmc****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211222112033010224****",
        "Action": "DescribeDirectConnectConnections",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20211222112033010224****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "DirectConnectConnections": [
            {
                "ConnectionType": "DedicatedConnection",
                "AccountId":"210000****",
                "DirectConnectConnectionId": "dcc-7qthudw0ll6jmc****",
                "DirectConnectConnectionName": "test",
                "Description": "test",
                "PortType":"1000Base",
                "Bandwidth":1000,
                "LineOperator":"ChinaTelecom",
                "DirectConnectAccessPointId":"ap-cn-shanghai-****-A",
                "PeerLocation":"北京IDC",
                "CreationTime":"2021-12-15T17:05:42+08:00",
                "UpdateTime":"2021-12-17T11:50:30+08:00",
                "Status":"Available",
                "VlanId": 1212,
                "CustomerName": "韩*梅",
                "CustomerContactPhone": "185****2333",
                "CustomerContactEmail": "exampletest@163.com",
                "ParentConnectionId": "dcc-e5z1z57glr0g2yjrzamy****",
                "ParentConnectionAccountId": "20******0101",
                "PortSpec": "1G",
                "BillingType": 1,
                "BusinessStatus": "Normal",
                "DeletedTime": "2023-12-02 23:59:59",
                "ExpiredTime": "2023-12-03 12:00:00",
                "ExpectBandwidth": "500",
                "ProjectName": "default",
                "Tags":[ 
										{	
										"Key":"k1",	
										"Value":"v1"	
										},	
										{	
										"Key":"k2",	
										"Value":""	
										}	
								]
            }
        ]
    }
}

错误码

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

HttpCode
错误码
错误信息
描述
400LimitExceeded.DirectConnectConnectionIdYou've reached the limit on the number of direct connect connection IDs that you can describe.已达到可查询的物理连接ID数量上限。
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400InvalidTagFilterKey.MalformedThe specified parameter tag filter key is invalid.过滤标签键不合法。
400InvalidTagFilterValue.MalformedThe specified parameter tag filter value is invalid.过滤标签值不合法。
400LimitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
400LimitExceeded.TagFilterValueYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签值数量的上限。
400InvalidTagFilter.DisorderThe specified index order of tag filter is malformed.指定标签过滤项的索引顺序参数格式不合法。