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

DescribeDirectConnectGateways

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

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

我的收藏

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

调用说明

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

调试

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

请求参数

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

DirectConnectGatewayIds.N

List of String

否

DirectConnectGatewayIds.1= dcg-7qthudw0ll6jmc****&DirectConnectGatewayIds.2=dcg-13fszmm1xdssg3n6nu4x9****

专线网关的ID。

  • 参数 - N：表示专线网关ID的序号，单次调用数量上限100个。
  • 多个专线网关ID之间用&分隔。
DirectConnectGatewayNameString否test专线网关的名称。
CenIdString否cen-257gqcdfvx6n****专线网关所属CEN的ID。

PageNumber

Integer

否

1

列表的页码。

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

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

返回数据

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

DirectConnectGateway

名称类型
示例值
描述
AccountIdString21000*****专线网关所属账号的ID。
DirectConnectGatewayIdStringdcg-7qthudw0ll6jmc****专线网关的ID。
DirectConnectGatewayNameStringtest专线网关的名称。
DescriptionStringThis is a sample description专线网关的描述。
CreationTimeString2021-04-09T08:36:47+08:00创建专线网关的时间。
UpdateTimeString2021-04-10T09:18:28+08:00更新专线网关的时间。

Status

String

Available

专线网关的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending：配置中
  • Available：可用

BusinessStatus

String

FinancialLocked

专线网关是否被锁定。

  • Normal: 正常。
  • FinancialLocked: 被锁定。

LockReason

String

Financial

专线网关被锁定的原因。

  • unlock：解锁。
  • financial：因欠费被锁定。
  • security：因安全被锁定。
OverdueTimeString2021-04-29 01:37:38资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。
DeletedTimeString2021-04-30 01:37:38预期资源强制回收时间。 仅当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。
AssociateCensArray of struct-关联的CEN信息，具体请见下表“AssociateCen”。
TagsArray of struct-专线网关已添加的全部标签信息。具体请参见下表“Tag”。

EnableIpv6

Boolean

false

是否支持IPv6。

  • true：支持
  • false：不支持

AssociateCen

名称
类型
示例值
描述
CenIdStringcen-23987fdc****CEN的ID。
CenOwnerIdString122***023CEN的用户ID。

CenStatus

String

Attached

实例在CEN中的状态。

  • Attaching：加载中
  • Attached：已加载

Tag

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

请求示例

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":"",
								"Tags":[ 
								   { 
								   "Key":"k1", 
								   "Value":"v1" 
								   }, 
								   { 
								   "Key":"k2", 
								   "Value":"" 
								   } 
								]
            }
        ]
    }
}

错误码

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

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