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

使用说明

若请求参数不传入DirectConnectGatewayIds，则会按照传入的其他参数查询，返回符合条件的专线网关。

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

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeDirectConnectGateways

接口名称。当前 API 的名称为 DescribeDirectConnectGateways。

Version String 必选示例值：2020-04-01

接口版本。当前 API 的版本为 2020-04-01。

DirectConnectGatewayIds.N String 可选示例值：dcg-7qthudw0ll6jmc****

专线网关的ID。

参数 - N：表示专线网关ID的序号，单次调用数量上限100个。

多个专线网关ID之间用&分隔。

DirectConnectGatewayName String 可选示例值：dcwg-name

专线网关的名称。

CenId String 可选示例值：cen-257gqcdfvx6n****

专线网关所属CEN的ID。

PageNumber Integer 可选示例值：1

列表的页码。

如需传入此参数，请传入非负整数。

不传或传入0，则均默认为1。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

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)”。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

TotalCount Integer 示例值：10

满足指定条件的专线网关总数。

PageNumber Integer 示例值：1

当前页码。

PageSize Integer 示例值：20

当前分页的行数。

DirectConnectGateways Object[] 示例值：-

专线网关的详细信息。

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 Object[] 示例值：-

关联的CEN信息。

CenId String 示例值：cen-23987fdc****

CEN的ID。

CenOwnerId String 示例值：122***023

CEN的用户ID。

CenStatus String 示例值：Attached

实例在CEN中的状态。

Attaching：加载中

Attached：已加载

Tags Object[] 示例值：-

专线网关已添加的全部标签信息。

Key String 示例值：k1

标签键。

Value String 示例值：v1

标签值。

EnableIpv6 Boolean 示例值：false

是否支持IPv6。

true：支持

false：不支持

ProjectName String 示例值：project-01

专线网关所属的项目。

BgpAsn Integer 示例值：137718

专线网关的ASN。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
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.	指定标签过滤项的索引顺序参数格式不合法。

专线连接