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

文档中心

立即注册

导航

DescribeDirectConnectGateways

最近更新时间：2024.11.07 16:26:54首次发布时间：2022.03.25 07:38:20

调用DescribeDirectConnectGateways查询符合要求的专线网关的详细信息。

调用说明

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

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDirectConnectGateways	要执行的操作，取值为DescribeDirectConnectGateways。
Version	String	是	2020-04-01	API版本信息。
DirectConnectGatewayIds.N	List of String	否	DirectConnectGatewayIds.1= dcg-7qthudw0ll6jmc**&DirectConnectGatewayIds.2=dcg-13fszmm1xdssg3n6nu4x9**	专线网关的ID。参数 - N：表示专线网关ID的序号，单次调用数量上限100个。多个专线网关ID之间用&分隔。
DirectConnectGatewayName	String	否	test	专线网关的名称。
CenId	String	否	cen-257gqcdfvx6n****	专线网关所属CEN的ID。
PageNumber	Integer	否	1	列表的页码。如需传入此参数，请传入非负整数。不传或传入0，则均默认为1。
PageSize	Integer	否	20	分页查询时每页的行数。最大值为100，默认值为20。
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)”。

返回数据

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

DirectConnectGateway

名称	类型	示例值	描述
AccountId	String	21000*****	专线网关所属账号的ID。
DirectConnectGatewayId	String	dcg-7qthudw0ll6jmc****	专线网关的ID。
DirectConnectGatewayName	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	更新专线网关的时间。
Status	String	Available	专线网关的状态。 Creating: 创建中 Deleting: 删除中 Pending：配置中 Available：可用
BusinessStatus	String	FinancialLocked	专线网关是否被锁定。 Normal: 正常。 FinancialLocked: 被锁定。
LockReason	String	Financial	专线网关被锁定的原因。 unlock：解锁。 financial：因欠费被锁定。 security：因安全被锁定。
OverdueTime	String	2021-04-29 01:37:38	资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。
DeletedTime	String	2021-04-30 01:37:38	预期资源强制回收时间。仅当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。
AssociateCens	Array of struct	-	关联的CEN信息，具体请见下表“AssociateCen”。
Tags	Array of struct	-	专线网关已添加的全部标签信息。具体请参见下表“Tag”。
EnableIpv6	Boolean	false	是否支持IPv6。 true：支持 false：不支持
ProjectName	String	project-01	专线网关所属的项目。
BgpAsn	Integer	137718	专线网关的ASN。

AssociateCen

名称	类型	示例值	描述
CenId	String	cen-23987fdc****	CEN的ID。
CenOwnerId	String	122***023	CEN的用户ID。
CenStatus	String	Attached	实例在CEN中的状态。 Attaching：加载中 Attached：已加载

名称

类型

示例值

描述

CenId

String

cen-23987fdc****

CEN的ID。

CenOwnerId

String

122***023

CEN的用户ID。

CenStatus

String

Attached

实例在CEN中的状态。

Attaching：加载中
Attached：已加载

Tag

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

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211222112033010224****",
        "Action": "DescribeDirectConnectGateways",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20211222112033010224****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "DirectConnectGateways": [
            {
                "AccountId":"210000****",
                "DirectConnectGatewayId": "dcg-2fe3zsmkshs59g****",
                "DirectConnectGatewayName": "test",
                "Description": "test",
                "AssociateCens":[ 
                   { 
                    "CenId": "cen-23af298****", 
                    "CenOwnerId": "1223****", 
                    "CenStatus": "Attached"
                   } 
                ],
                "CreationTime": "2021-12-22T11:13:21+08:00",
                "UpdateTime": "2021-12-22T11:13:21+08:00",
                "Status": "Available",
                "EnableIpv6":"false",
                "BusinessStatus":"Normal",
								"LockReason":"unlock",
								"OverdueTime":"",
								"DeletedTime":"",
								"ProjectName":"project-01",
                "BgpAsn":137718,
								"Tags":[ 
								   { 
								   "Key":"k1", 
								   "Value":"v1" 
								   }, 
								   { 
								   "Key":"k2", 
								   "Value":"" 
								   } 
								]
            }
        ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	LimitExceeded.DirectConnectGatewayId	You've reached the limit on the number of direct connect gateway 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.	指定标签过滤项的索引顺序参数格式不合法。