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

文档中心

立即注册

导航

DescribeDirectConnectConnections

最近更新时间：2024.11.15 10:04:32首次发布时间：2022.03.25 07:38:20

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

调用说明

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

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDirectConnectConnections	要执行的操作，取值：DescribeDirectConnectConnections。
Version	String	是	2020-04-01	API版本信息。
DirectConnectConnectionIds.N	List of String	否	DirectConnectConnectionIds.1= dcc-7qthudw0ll6jmc**& DirectConnectConnectionIds.2=dcc-13fszmm1xdssg3n6nu4x9**	物理专线的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	否	TagFilters.1.Key=key1&TagFilters.2.Key=key2&TagFilters.3.Key=key3	云资源实例的标签键（Key）。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用`&`分隔。如果传入多个`TagFilters.N.Key`，多个`TagFilters.N.Key`之间的关系为逻辑“与（AND）”，不允许重复。
TagFilters.N.Values.M	String	否	TagFilters.1.Values.1=value1&TagFilters.2.Values.2=value2&TagFilters.3.Values.3=value3	云资源实例的标签值（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	物理专线所属的项目。传入该字段，表示查询指定项目下的物理专线。不传入该字段，表示查询所有项目的物理专线。

返回数据

名称	类型	示例值	描述
RequestId	String	20211222112033010224****	请求ID。
TotalCount	Integer	10	满足指定条件的物理专线总数。
PageNumber	Integer	1	当前页码。
PageSize	Integer	20	当前分页的行数。
DirectConnectConnections	Array of struct	-	物理专线的详细信息。具体请参见下表“ DirectConnectConnection ”。

DirectConnectConnection

名称	类型	示例值	描述
ConnectionType	String	DedicatedConnection	物理专线的类型。 DedicatedConnection：独享专线 SharedConnection：共享专线
AccountId	String	21000*****	物理专线所属账号的ID。
DirectConnectConnectionId	String	dcc-7qthudw0ll6jmc****	物理专线的ID。若物理专线类型为独享专线，则返回值为独享专线的ID。若物理专线类型为共享专线，则返回值为共享专线的ID。
DirectConnectConnectionName	String	test	物理专线的名称。
Description	String	This is a sample description	物理专线的描述。
CreationTime	String	2021-04-09T08:36:47+08:00	创建物理专线的时间。
UpdateTime	String	2021-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默认不开放，如有需要，请联系客户经理。
Bandwidth	Integer	1000	物理专线的带宽，单位：Mbps。
LineOperator	String	ChinaTelecom	物理专线的运营商。 ChinaTelecom：中国电信 ChinaMobile：中国移动 ChinaUnicom：中国联通 ChinaOther：中国其他具有相应电信业务经营资质的运营商。
DirectConnectAccessPointId	String	ap-cn-shanghai-***-A	物理专线接入点的ID。
PeerLocation	String	北京IDC	物理专线的对端接入点。
Status	String	Available	物理专线的状态。 Creating: 创建中 Deleting: 删除中 Pending：配置中 Available：可用 Initial：申请中 Allocated：施工中 Rejected：申请驳回 UnConfirmed：等待接受 NoPayment：待支付
VlanId	Integer	1212	共享专线的VLAN ID。若物理专线类型为独享专线，则此参数返回“0”。
ParentConnectionId	String	dcc-e5z1z57glr0g2yjrzamyw****	共享专线所属物理专线的ID。若物理专线类型为独享专线，则此参数返回空。
ParentConnectionAccountId	String	2000956****	共享专线所属物理专线的账号ID。若物理专线类型为独享专线，则此参数返回空。
CustomerName	String	韩*梅	专线联系人姓名。
CustomerContactPhone	String	185****2333	专线联系人联系电话。
CustomerContactEmail	String	exampletest@163.com	专线联系人联系邮箱。
Tags	Array of struct	-	物理专线已添加的全部标签信息。具体请参见下表“Tag”。
PortSpec	String	1G	专线端口规格。
BillingType	Integer	1	专线计费类型，当前仅支持“1”包年包月计费。
BusinessStatus	String	Normal	专线的计费状态。 Normal: 正常。 FinancialLocked: 被锁定。
DeletedTime	String	2023-12-02 23:59:59	预期资源强制回收时间。
ExpiredTime	String	2023-12-03 12:00:00	专线的到期时间。
ExpectBandwidth	Integer	500	期望物理专线的带宽，单位：Mbps。
ProjectName	String	Project_1	物理专线所属的项目。
DirectConnectTrafficQosPolicyId	String	dcq-4atoi32cl4c9t0q****	物理专线关联的QoS策略的ID。
ExpectedExpireShutdownTime	String	2024-10-11 12:00:00	专线到期时间。

Tag

名称	类型	示例值	描述
Key	String	key1	标签键。
Value	String	value1	标签值。

请求示例

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",
                "DirectConnectTrafficQosPolicyId":"dcq-4atoi32cl4c9t0q****",
                "ExpectedExpireShutdownTime":"2024-10-11 12:00:00",
                "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	错误码	错误信息	描述
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.	指定标签过滤项的索引顺序参数格式不合法。