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

文档中心

导航

DescribeSharedDirectConnectConnections

最近更新时间：2024.09.20 11:49:14首次发布时间：2023.04.17 16:24:57

调用DescribeSharedDirectConnectConnections按条件查询共享专线的详细信息。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSharedDirectConnectConnections	要执行的操作，取值： DescribeSharedDirectConnectConnections。
Version	String	是	2020-04-01	API版本信息。
SharedDirectConnectConnectionIds.N	String	否	SharedDirectConnectConnectionIds.1=dcc-e5z1z19edn282yjrzag4**& SharedDirectConnectConnectionIds.2=dcc-riuenr84eogk2qcprou5**	共享专线的ID。参数 - N：表示共享专线ID的序号，单次调用数量上限100个。多个共享专线ID之间用&分隔。
SharedDirectConnectConnectionName	String	否	DCCTestName	共享专线的名称。
UserAccountId	String	否	21*****3104	接受共享专线的账号的ID。
ParentConnectionId	String	否	dcc-e5z1z57glr0g2yjrzamy****	共享专线所属物理专线的ID。
Status	String	否	UnConfirmed	共享专线的状态。 Creating：创建中 Pending：配置中 Deleting：删除中 Available：可用 UnConfirmed：未被接受 Reclaimed：已释放 NoPayment：待支付
VlanId	Integer	否	1212	共享专线的VLAN ID。
PageSize	Interger	否	10	分页查询时每页的行数。最大值为100，默认值为20。
PageNumber	Interger	否	1	列表的页码。如需传入此参数，请传入非负整数。不传或传入0，则均默认为1。

返回数据

名称	类型	示例值	描述
RequestId	String	0ED8D006-F706-4D23-88ED-E11ED28D****	请求ID。
PageSize	Integer	10	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	23	满足指定条件的共享专线的总数。
SharedDirectConnectConnections	Array of struct	-	共享专线的详细信息。具体请参见下表“SharedDirectConnectConnection”。

SharedDirectConnectConnection

名称	类型	示例值	描述
SharedDirectConnectConnectionId	String	dcc-e5z1z57glr0g2yjrzamy****	共享专线的ID。
SharedDirectConnectConnectionName	String	DCCTestName	共享专线的名称。
Description	String	DCCTestDescription	共享专线的描述。
AccountId	String	2000956****	创建共享专线的账号的ID。
UserAccountId	String	2000101****	接受共享专线的账号的ID。
ParentConnectionId	String	dcc-e5z1z57glr0g2yjrzamyw****	共享专线所属物理专线的ID。
CreationTime	String	2021-04-09T08:36:47+08:00	创建共享专线的时间。
UpdateTime	String	2021-04-09T08:36:47+08:00	更新共享专线的时间。
Status	String	Available	共享专线的状态。 Reclaimed：已释放 NoPayment：待支付 Available：可用 UnConfirmed：待接受
Bandwidth	Integer	500	共享专线的带宽，单位：Mbps。
LineOperator	String	ChinaTelecom	物理专线的运营商 ChinaTelecom：中国电信 ChinaMobile：中国移动 ChinaUnicom：中国联通 ChinaOther：中国其他具有相应电信业务经营资质的运营商。
PortType	String	1000Base	共享专线的端口类型。 1000Base-T：表示1G电口。 10GBase-T：表示10G电口。 1000Base：表示1G光口。 10GBase：表示10G光口。 40GBase：表示40G光口。 100GBase：表示100G光口。
DirectConenctAccessPointId	String	ap-cn-shanghai-***-A	物理专线接入点的ID。
VlanId	Integer	1212	共享专线的VLAN ID。
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。

请求示例

GET /？Action=DescribeSharedDirectConnectConnections&Version=2020-04-01&SharedDirectConnectConnectionIds.1=dcc-e5z1z19edn282yjrzag4****&SharedDirectConnectConnectionIds.2=dcc-riuenr84eogk2qcprou5****&UserAccountId=21*****3104&ParentConnectionId=dcc-e5z1z57glr0g2yjrzamy****&Status=UnConfirmed&VlanId=1212&PageSize=10&PageNumber=1 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220419155310010225243081****",
        "Action": "DescribeSharedDirectConnectConnections",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20220419155310010225243081****",
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 23,
        "SharedDirectConnectConnections": [
            {
                "SharedDirectConnectConnectionId": "dcc-e5z1z57glr0g2yjrzamy****",
                "SharedDirectConnectConnectionName": "DCCTestName",
                "Description": "DCCTestDescription",
                "AccountId": "2000956****",
                "UserAccountId": "2000101****",
                "CreationTime": "2022-04-19T15:52:17+08:00",
                "UpdateTime": "2022-04-19T15:53:10+08:00",
                "Status": "Available",
                "Bandwidth": 500,
                "LineOperator": "ChinaTelecom",
                "PortType": "1000Base",
                "DirectConenctAccessPointId": "ap-cn-shanghai-***-A",
                "VlanId": 1212,
                "PortSpec": "1G",
                "BillingType": 1,
                "BusinessStatus": "Normal",
                "DeletedTime": "2023-12-02 23:59:59",
                "ExpiredTime": "2023-12-03 12:00:00",
                "ExpectBandwidth": "500",
                "ParentConnectionId": "dcc-e5z1z57glr0g2yjrzamyw****"
            }
        ]
    }
}

错误码

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

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